google-cloud-gdc_hardware_management-v1alpha 0.1.0

data/proto_docs/google/protobuf/timestamp.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # A Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+    # restricting to that range, we ensure that we can convert to and from [RFC
+    # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Timestamp from POSIX `time()`.
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(time(NULL));
+    #     timestamp.set_nanos(0);
+    #
+    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+    #
+    #     struct timeval tv;
+    #     gettimeofday(&tv, NULL);
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(tv.tv_sec);
+    #     timestamp.set_nanos(tv.tv_usec * 1000);
+    #
+    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+    #
+    #     FILETIME ft;
+    #     GetSystemTimeAsFileTime(&ft);
+    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+    #
+    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+    #
+    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+    #
+    #     long millis = System.currentTimeMillis();
+    #
+    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
+    #
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    # Example 6: Compute Timestamp from current time in Python.
+    #
+    #     timestamp = Timestamp()
+    #     timestamp.GetCurrentTime()
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Timestamp type is encoded as a string in the
+    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
+    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
+    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
+    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+    # is required. A proto3 JSON serializer should always use UTC (as indicated by
+    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
+    # able to accept both UTC and other timezones (as indicated by an offset).
+    #
+    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+    # 01:30 UTC on January 15, 2017.
+    #
+    # In JavaScript, one can convert a Date object to this format using the
+    # standard
+    # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+    # method. In Python, a standard `datetime.datetime` object can be converted
+    # to this format using
+    # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+    # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+    # the Joda Time's [`ISODateTimeFormat.dateTime()`](
+    # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
+    # ) to obtain a formatter capable of generating timestamps in this format.
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Represents seconds of UTC time since Unix epoch
+    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+    #     9999-12-31T23:59:59Z inclusive.
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Non-negative fractions of a second at nanosecond resolution. Negative
+    #     second values with fractions must still have non-negative nanos values
+    #     that count forward in time. Must be from 0 to 999,999,999
+    #     inclusive.
+    class Timestamp
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/rpc/status.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Rpc
+    # The `Status` type defines a logical error model that is suitable for
+    # different programming environments, including REST APIs and RPC APIs. It is
+    # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+    # three pieces of data: error code, error message, and error details.
+    #
+    # You can find out more about this error model and how to work with it in the
+    # [API Design Guide](https://cloud.google.com/apis/design/errors).
+    # @!attribute [rw] code
+    #   @return [::Integer]
+    #     The status code, which should be an enum value of
+    #     [google.rpc.Code][google.rpc.Code].
+    # @!attribute [rw] message
+    #   @return [::String]
+    #     A developer-facing error message, which should be in English. Any
+    #     user-facing error message should be localized and sent in the
+    #     {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
+    #     by the client.
+    # @!attribute [rw] details
+    #   @return [::Array<::Google::Protobuf::Any>]
+    #     A list of messages that carry the error details.  There is a common set of
+    #     message types for APIs to use.
+    class Status
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/type/date.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents a whole or partial calendar date, such as a birthday. The time of
+    # day and time zone are either specified elsewhere or are insignificant. The
+    # date is relative to the Gregorian Calendar. This can represent one of the
+    # following:
+    #
+    # * A full date, with non-zero year, month, and day values
+    # * A month and day value, with a zero year, such as an anniversary
+    # * A year on its own, with zero month and day values
+    # * A year and month value, with a zero day, such as a credit card expiration
+    # date
+    #
+    # Related types are {::Google::Type::TimeOfDay google.type.TimeOfDay} and
+    # `google.protobuf.Timestamp`.
+    # @!attribute [rw] year
+    #   @return [::Integer]
+    #     Year of the date. Must be from 1 to 9999, or 0 to specify a date without
+    #     a year.
+    # @!attribute [rw] month
+    #   @return [::Integer]
+    #     Month of a year. Must be from 1 to 12, or 0 to specify a year without a
+    #     month and day.
+    # @!attribute [rw] day
+    #   @return [::Integer]
+    #     Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
+    #     to specify a year by itself or a year and month where the day isn't
+    #     significant.
+    class Date
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/type/datetime.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents civil time (or occasionally physical time).
+    #
+    # This type can represent a civil time in one of a few possible ways:
+    #
+    #  * When utc_offset is set and time_zone is unset: a civil time on a calendar
+    #    day with a particular offset from UTC.
+    #  * When time_zone is set and utc_offset is unset: a civil time on a calendar
+    #    day in a particular time zone.
+    #  * When neither time_zone nor utc_offset is set: a civil time on a calendar
+    #    day in local time.
+    #
+    # The date is relative to the Proleptic Gregorian Calendar.
+    #
+    # If year is 0, the DateTime is considered not to have a specific year. month
+    # and day must have valid, non-zero values.
+    #
+    # This type may also be used to represent a physical time if all the date and
+    # time fields are set and either case of the `time_offset` oneof is set.
+    # Consider using `Timestamp` message for physical time instead. If your use
+    # case also would like to store the user's timezone, that can be done in
+    # another field.
+    #
+    # This type is more flexible than some applications may want. Make sure to
+    # document and validate your application's limitations.
+    # @!attribute [rw] year
+    #   @return [::Integer]
+    #     Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
+    #     datetime without a year.
+    # @!attribute [rw] month
+    #   @return [::Integer]
+    #     Required. Month of year. Must be from 1 to 12.
+    # @!attribute [rw] day
+    #   @return [::Integer]
+    #     Required. Day of month. Must be from 1 to 31 and valid for the year and
+    #     month.
+    # @!attribute [rw] hours
+    #   @return [::Integer]
+    #     Required. Hours of day in 24 hour format. Should be from 0 to 23. An API
+    #     may choose to allow the value "24:00:00" for scenarios like business
+    #     closing time.
+    # @!attribute [rw] minutes
+    #   @return [::Integer]
+    #     Required. Minutes of hour of day. Must be from 0 to 59.
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Required. Seconds of minutes of the time. Must normally be from 0 to 59. An
+    #     API may allow the value 60 if it allows leap-seconds.
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Required. Fractions of seconds in nanoseconds. Must be from 0 to
+    #     999,999,999.
+    # @!attribute [rw] utc_offset
+    #   @return [::Google::Protobuf::Duration]
+    #     UTC offset. Must be whole seconds, between -18 hours and +18 hours.
+    #     For example, a UTC offset of -4:00 would be represented as
+    #     { seconds: -14400 }.
+    # @!attribute [rw] time_zone
+    #   @return [::Google::Type::TimeZone]
+    #     Time zone.
+    class DateTime
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Represents a time zone from the
+    # [IANA Time Zone Database](https://www.iana.org/time-zones).
+    # @!attribute [rw] id
+    #   @return [::String]
+    #     IANA Time Zone Database time zone, e.g. "America/New_York".
+    # @!attribute [rw] version
+    #   @return [::String]
+    #     Optional. IANA Time Zone Database version number, e.g. "2019a".
+    class TimeZone
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/type/dayofweek.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents a day of the week.
+    module DayOfWeek
+      # The day of the week is unspecified.
+      DAY_OF_WEEK_UNSPECIFIED = 0
+
+      # Monday
+      MONDAY = 1
+
+      # Tuesday
+      TUESDAY = 2
+
+      # Wednesday
+      WEDNESDAY = 3
+
+      # Thursday
+      THURSDAY = 4
+
+      # Friday
+      FRIDAY = 5
+
+      # Saturday
+      SATURDAY = 6
+
+      # Sunday
+      SUNDAY = 7
+    end
+  end
+end

data/proto_docs/google/type/postal_address.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents a postal address, e.g. for postal delivery or payments addresses.
+    # Given a postal address, a postal service can deliver items to a premise, P.O.
+    # Box or similar.
+    # It is not intended to model geographical locations (roads, towns,
+    # mountains).
+    #
+    # In typical usage an address would be created via user input or from importing
+    # existing data, depending on the type of process.
+    #
+    # Advice on address input / editing:
+    #  - Use an i18n-ready address widget such as
+    #    https://github.com/google/libaddressinput)
+    # - Users should not be presented with UI elements for input or editing of
+    #   fields outside countries where that field is used.
+    #
+    # For more guidance on how to use this schema, please see:
+    # https://support.google.com/business/answer/6397478
+    # @!attribute [rw] revision
+    #   @return [::Integer]
+    #     The schema revision of the `PostalAddress`. This must be set to 0, which is
+    #     the latest revision.
+    #
+    #     All new revisions **must** be backward compatible with old revisions.
+    # @!attribute [rw] region_code
+    #   @return [::String]
+    #     Required. CLDR region code of the country/region of the address. This
+    #     is never inferred and it is up to the user to ensure the value is
+    #     correct. See http://cldr.unicode.org/ and
+    #     http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
+    #     for details. Example: "CH" for Switzerland.
+    # @!attribute [rw] language_code
+    #   @return [::String]
+    #     Optional. BCP-47 language code of the contents of this address (if
+    #     known). This is often the UI language of the input form or is expected
+    #     to match one of the languages used in the address' country/region, or their
+    #     transliterated equivalents.
+    #     This can affect formatting in certain countries, but is not critical
+    #     to the correctness of the data and will never affect any validation or
+    #     other non-formatting related operations.
+    #
+    #     If this value is not known, it should be omitted (rather than specifying a
+    #     possibly incorrect default).
+    #
+    #     Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    # @!attribute [rw] postal_code
+    #   @return [::String]
+    #     Optional. Postal code of the address. Not all countries use or require
+    #     postal codes to be present, but where they are used, they may trigger
+    #     additional validation with other parts of the address (e.g. state/zip
+    #     validation in the U.S.A.).
+    # @!attribute [rw] sorting_code
+    #   @return [::String]
+    #     Optional. Additional, country-specific, sorting code. This is not used
+    #     in most regions. Where it is used, the value is either a string like
+    #     "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
+    #     alone, representing the "sector code" (Jamaica), "delivery area indicator"
+    #     (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+    # @!attribute [rw] administrative_area
+    #   @return [::String]
+    #     Optional. Highest administrative subdivision which is used for postal
+    #     addresses of a country or region.
+    #     For example, this can be a state, a province, an oblast, or a prefecture.
+    #     Specifically, for Spain this is the province and not the autonomous
+    #     community (e.g. "Barcelona" and not "Catalonia").
+    #     Many countries don't use an administrative area in postal addresses. E.g.
+    #     in Switzerland this should be left unpopulated.
+    # @!attribute [rw] locality
+    #   @return [::String]
+    #     Optional. Generally refers to the city/town portion of the address.
+    #     Examples: US city, IT comune, UK post town.
+    #     In regions of the world where localities are not well defined or do not fit
+    #     into this structure well, leave locality empty and use address_lines.
+    # @!attribute [rw] sublocality
+    #   @return [::String]
+    #     Optional. Sublocality of the address.
+    #     For example, this can be neighborhoods, boroughs, districts.
+    # @!attribute [rw] address_lines
+    #   @return [::Array<::String>]
+    #     Unstructured address lines describing the lower levels of an address.
+    #
+    #     Because values in address_lines do not have type information and may
+    #     sometimes contain multiple values in a single field (e.g.
+    #     "Austin, TX"), it is important that the line order is clear. The order of
+    #     address lines should be "envelope order" for the country/region of the
+    #     address. In places where this can vary (e.g. Japan), address_language is
+    #     used to make it explicit (e.g. "ja" for large-to-small ordering and
+    #     "ja-Latn" or "en" for small-to-large). This way, the most specific line of
+    #     an address can be selected based on the language.
+    #
+    #     The minimum permitted structural representation of an address consists
+    #     of a region_code with all remaining information placed in the
+    #     address_lines. It would be possible to format such an address very
+    #     approximately without geocoding, but no semantic reasoning could be
+    #     made about any of the address components until it was at least
+    #     partially resolved.
+    #
+    #     Creating an address only containing a region_code and address_lines, and
+    #     then geocoding is the recommended way to handle completely unstructured
+    #     addresses (as opposed to guessing which parts of the address should be
+    #     localities or administrative areas).
+    # @!attribute [rw] recipients
+    #   @return [::Array<::String>]
+    #     Optional. The recipient at the address.
+    #     This field may, under certain circumstances, contain multiline information.
+    #     For example, it might contain "care of" information.
+    # @!attribute [rw] organization
+    #   @return [::String]
+    #     Optional. The name of the organization at the address.
+    class PostalAddress
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/type/timeofday.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents a time of day. The date and time zone are either not significant
+    # or are specified elsewhere. An API may choose to allow leap seconds. Related
+    # types are {::Google::Type::Date google.type.Date} and
+    # `google.protobuf.Timestamp`.
+    # @!attribute [rw] hours
+    #   @return [::Integer]
+    #     Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+    #     to allow the value "24:00:00" for scenarios like business closing time.
+    # @!attribute [rw] minutes
+    #   @return [::Integer]
+    #     Minutes of hour of day. Must be from 0 to 59.
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+    #     allow the value 60 if it allows leap-seconds.
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+    class TimeOfDay
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end