google-cloud-channel-v1 2.4.1 → 2.5.0

data/proto_docs/google/api/client.rb

@@ -31,6 +31,8 @@ module Google
     # @!attribute [rw] selective_gapic_generation
     #   @return [::Google::Api::SelectiveGapicGeneration]
     #     Configuration for which RPCs should be generated in the GAPIC client.
+    #
+    #     Note: This field should not be used in most cases.
     class CommonLanguageSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -141,9 +143,10 @@ module Google
     #
     #     Example of a YAML configuration::
     #
-    #      publishing:
-    #        java_settings:
-    #          library_package: com.google.cloud.pubsub.v1
+    #         publishing:
+    #           library_settings:
+    #             java_settings:
+    #               library_package: com.google.cloud.pubsub.v1
     # @!attribute [rw] service_class_names
     #   @return [::Google::Protobuf::Map{::String => ::String}]
     #     Configure the Java class name to use instead of the service's for its
@@ -155,11 +158,11 @@ module Google
     #
     #     Example of a YAML configuration::
     #
-    #      publishing:
-    #        java_settings:
-    #          service_class_names:
-    #            - google.pubsub.v1.Publisher: TopicAdmin
-    #            - google.pubsub.v1.Subscriber: SubscriptionAdmin
+    #         publishing:
+    #           java_settings:
+    #             service_class_names:
+    #               - google.pubsub.v1.Publisher: TopicAdmin
+    #               - google.pubsub.v1.Subscriber: SubscriptionAdmin
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
@@ -190,6 +193,20 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] library_package
+    #   @return [::String]
+    #     The package name to use in Php. Clobbers the php_namespace option
+    #     set in the protobuf. This should be used **only** by APIs
+    #     who have already set the language_settings.php.package_name" field
+    #     in gapic.yaml. API teams should use the protobuf php_namespace option
+    #     where possible.
+    #
+    #     Example of a YAML configuration::
+    #
+    #         publishing:
+    #           library_settings:
+    #             php_settings:
+    #               library_package: Google\Cloud\PubSub\V1
     class PhpSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -318,10 +335,12 @@ module Google
     #     service names and values are the name to be used for the service client
     #     and call options.
     #
-    #     publishing:
-    #       go_settings:
-    #         renamed_services:
-    #           Publisher: TopicAdmin
+    #     Example:
+    #
+    #         publishing:
+    #           go_settings:
+    #             renamed_services:
+    #               Publisher: TopicAdmin
     class GoSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -344,10 +363,10 @@ module Google
     #
     #     Example:
     #
-    #        publishing:
-    #          method_settings:
-    #          - selector: google.storage.control.v2.StorageControl.CreateFolder
-    #            # method settings for CreateFolder...
+    #         publishing:
+    #           method_settings:
+    #           - selector: google.storage.control.v2.StorageControl.CreateFolder
+    #             # method settings for CreateFolder...
     # @!attribute [rw] long_running
     #   @return [::Google::Api::MethodSettings::LongRunning]
     #     Describes settings to use for long-running operations when generating
@@ -356,14 +375,14 @@ module Google
     #
     #     Example of a YAML configuration::
     #
-    #        publishing:
-    #          method_settings:
-    #          - selector: google.cloud.speech.v2.Speech.BatchRecognize
-    #            long_running:
-    #              initial_poll_delay: 60s # 1 minute
-    #              poll_delay_multiplier: 1.5
-    #              max_poll_delay: 360s # 6 minutes
-    #              total_poll_timeout: 54000s # 90 minutes
+    #         publishing:
+    #           method_settings:
+    #           - selector: google.cloud.speech.v2.Speech.BatchRecognize
+    #             long_running:
+    #               initial_poll_delay: 60s # 1 minute
+    #               poll_delay_multiplier: 1.5
+    #               max_poll_delay: 360s # 6 minutes
+    #               total_poll_timeout: 54000s # 90 minutes
     # @!attribute [rw] auto_populated_fields
     #   @return [::Array<::String>]
     #     List of top-level fields of the request message, that should be
@@ -372,11 +391,24 @@ module Google
     #
     #     Example of a YAML configuration:
     #
-    #        publishing:
-    #          method_settings:
-    #          - selector: google.example.v1.ExampleService.CreateExample
-    #            auto_populated_fields:
-    #            - request_id
+    #         publishing:
+    #           method_settings:
+    #           - selector: google.example.v1.ExampleService.CreateExample
+    #             auto_populated_fields:
+    #             - request_id
+    # @!attribute [rw] batching
+    #   @return [::Google::Api::BatchingConfigProto]
+    #     Batching configuration for an API method in client libraries.
+    #
+    #     Example of a YAML configuration:
+    #
+    #         publishing:
+    #           method_settings:
+    #           - selector: google.example.v1.ExampleService.BatchCreateExample
+    #             batching:
+    #               element_count_threshold: 1000
+    #               request_byte_threshold: 100000000
+    #               delay_threshold_millis: 10
     class MethodSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -411,6 +443,8 @@ module Google
 
     # This message is used to configure the generation of a subset of the RPCs in
     # a service for client libraries.
+    #
+    # Note: This feature should not be used in most cases.
     # @!attribute [rw] methods
     #   @return [::Array<::String>]
     #     An allowlist of the fully qualified names of RPCs that should be included
@@ -428,6 +462,77 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
+    # `BatchingConfigProto` defines the batching configuration for an API method.
+    # @!attribute [rw] thresholds
+    #   @return [::Google::Api::BatchingSettingsProto]
+    #     The thresholds which trigger a batched request to be sent.
+    # @!attribute [rw] batch_descriptor
+    #   @return [::Google::Api::BatchingDescriptorProto]
+    #     The request and response fields used in batching.
+    class BatchingConfigProto
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # `BatchingSettingsProto` specifies a set of batching thresholds, each of
+    # which acts as a trigger to send a batch of messages as a request. At least
+    # one threshold must be positive nonzero.
+    # @!attribute [rw] element_count_threshold
+    #   @return [::Integer]
+    #     The number of elements of a field collected into a batch which, if
+    #     exceeded, causes the batch to be sent.
+    # @!attribute [rw] request_byte_threshold
+    #   @return [::Integer]
+    #     The aggregated size of the batched field which, if exceeded, causes the
+    #     batch to be sent. This size is computed by aggregating the sizes of the
+    #     request field to be batched, not of the entire request message.
+    # @!attribute [rw] delay_threshold
+    #   @return [::Google::Protobuf::Duration]
+    #     The duration after which a batch should be sent, starting from the addition
+    #     of the first message to that batch.
+    # @!attribute [rw] element_count_limit
+    #   @return [::Integer]
+    #     The maximum number of elements collected in a batch that could be accepted
+    #     by server.
+    # @!attribute [rw] request_byte_limit
+    #   @return [::Integer]
+    #     The maximum size of the request that could be accepted by server.
+    # @!attribute [rw] flow_control_element_limit
+    #   @return [::Integer]
+    #     The maximum number of elements allowed by flow control.
+    # @!attribute [rw] flow_control_byte_limit
+    #   @return [::Integer]
+    #     The maximum size of data allowed by flow control.
+    # @!attribute [rw] flow_control_limit_exceeded_behavior
+    #   @return [::Google::Api::FlowControlLimitExceededBehaviorProto]
+    #     The behavior to take when the flow control limit is exceeded.
+    class BatchingSettingsProto
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # `BatchingDescriptorProto` specifies the fields of the request message to be
+    # used for batching, and, optionally, the fields of the response message to be
+    # used for demultiplexing.
+    # @!attribute [rw] batched_field
+    #   @return [::String]
+    #     The repeated field in the request message to be aggregated by batching.
+    # @!attribute [rw] discriminator_fields
+    #   @return [::Array<::String>]
+    #     A list of the fields in the request message. Two requests will be batched
+    #     together only if the values of every field specified in
+    #     `request_discriminator_fields` is equal between the two requests.
+    # @!attribute [rw] subresponse_field
+    #   @return [::String]
+    #     Optional. When present, indicates the field in the response message to be
+    #     used to demultiplex the response into multiple response messages, in
+    #     correspondence with the multiple request messages originally batched
+    #     together.
+    class BatchingDescriptorProto
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # The organization for which the client libraries are being published.
     # Affects the url where generated docs are published, etc.
     module ClientLibraryOrganization
@@ -469,5 +574,20 @@ module Google
       # Publish the library to package managers like nuget.org and npmjs.com.
       PACKAGE_MANAGER = 20
     end
+
+    # The behavior to take when the flow control limit is exceeded.
+    module FlowControlLimitExceededBehaviorProto
+      # Default behavior, system-defined.
+      UNSET_BEHAVIOR = 0
+
+      # Stop operation, raise error.
+      THROW_EXCEPTION = 1
+
+      # Pause operation until limit clears.
+      BLOCK = 2
+
+      # Continue operation, disregard limit.
+      IGNORE = 3
+    end
   end
 end

data/proto_docs/google/cloud/channel/v1/customers.rb

@@ -78,13 +78,13 @@ module Google
         #     Populated only if a CRM ID exists for this customer.
         # @!attribute [rw] customer_attestation_state
         #   @return [::Google::Cloud::Channel::V1::Customer::CustomerAttestationState]
-        #     Optional. Indicate whether a customer is attesting about the correctness of
+        #     Optional. Indicate if a customer is attesting about the correctness of
         #     provided information. Only required if creating a GCP Entitlement.
         class Customer
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # The enum represents whether a customer belongs to public sector
+          # The enum represents if a customer belongs to public sector
           module CustomerAttestationState
             # Default value if not set yet
             CUSTOMER_ATTESTATION_STATE_UNSPECIFIED = 0

data/proto_docs/google/cloud/channel/v1/entitlements.rb

@@ -89,6 +89,11 @@ module Google
         #   @return [::String]
         #     Optional. The billing account resource name that is used to pay for this
         #     entitlement.
+        # @!attribute [rw] price_reference_id
+        #   @return [::String]
+        #     Optional. Price reference ID for the offer. Only for offers that require
+        #     additional price information. Used to guarantee that the pricing is
+        #     consistent between quoting the offer and placing the order.
         class Entitlement
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/channel/v1/offers.rb

@@ -188,9 +188,18 @@ module Google
         # @!attribute [rw] effective_price
         #   @return [::Google::Type::Money]
         #     Effective Price after applying the discounts.
+        # @!attribute [rw] price_period
+        #   @return [::Google::Cloud::Channel::V1::Period]
+        #     The time period with respect to which base and effective prices are
+        #     defined.
+        #     Example: 1 month, 6 months, 1 year, etc.
         # @!attribute [rw] external_price_uri
         #   @return [::String]
         #     Link to external price list, such as link to Google Voice rate card.
+        # @!attribute [rw] discount_components
+        #   @return [::Array<::Google::Cloud::Channel::V1::DiscountComponent>]
+        #     Breakdown of the discount into its components.
+        #     This will be empty if there is no discount present.
         class Price
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -253,6 +262,26 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Represents a single component of the total discount applicable on a Price.
+        # @!attribute [rw] discount_percentage
+        #   @return [::Float]
+        #     Discount percentage, represented as decimal.
+        #     For example, a 20% discount will be represented as 0.2.
+        #
+        #     Note: The following fields are mutually exclusive: `discount_percentage`, `discount_absolute`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] discount_absolute
+        #   @return [::Google::Type::Money]
+        #     Fixed value discount.
+        #
+        #     Note: The following fields are mutually exclusive: `discount_absolute`, `discount_percentage`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] discount_type
+        #   @return [::Google::Cloud::Channel::V1::DiscountType]
+        #     Type of the discount.
+        class DiscountComponent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Constraints type for Promotional offers.
         module PromotionalOrderType
           # Not used.
@@ -347,6 +376,27 @@ module Google
           # Year.
           YEAR = 3
         end
+
+        # Discount Type.
+        module DiscountType
+          # Not used.
+          DISCOUNT_TYPE_UNSPECIFIED = 0
+
+          # Regional discount.
+          REGIONAL_DISCOUNT = 1
+
+          # Promotional discount.
+          PROMOTIONAL_DISCOUNT = 2
+
+          # Sales-provided discount.
+          SALES_DISCOUNT = 3
+
+          # Reseller margin.
+          RESELLER_MARGIN = 4
+
+          # Deal code discount.
+          DEAL_CODE = 5
+        end
       end
     end
   end

data/proto_docs/google/cloud/channel/v1/repricing.rb

@@ -67,7 +67,7 @@ module Google
         # Configuration for repricing a Google bill over a period of time.
         # @!attribute [rw] entitlement_granularity
         #   @return [::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity]
-        #     Applies the repricing configuration at the entitlement level.
+        #     Required. Applies the repricing configuration at the entitlement level.
         #
         #     Note: If a
         #     {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}

data/proto_docs/google/cloud/channel/v1/service.rb

@@ -49,7 +49,8 @@ module Google
         # @!attribute [rw] owned
         #   @return [::Boolean]
         #     Returns true if the Cloud Identity account is associated with a customer
-        #     of the Channel Services partner.
+        #     of the Channel Services partner (with active subscriptions or purchase
+        #     consents).
         # @!attribute [rw] customer_name
         #   @return [::String]
         #     If owned = true, the name of the customer that owns the Cloud Identity
@@ -423,6 +424,11 @@ module Google
         # @!attribute [rw] offer
         #   @return [::Google::Cloud::Channel::V1::Offer]
         #     Offer with parameter constraints updated to allow the Transfer.
+        # @!attribute [rw] price_reference_id
+        #   @return [::String]
+        #     Optional. Price reference ID for the offer. Only for offers that require
+        #     additional price information. Used to guarantee that the pricing is
+        #     consistent between quoting the offer and placing the order.
         class TransferableOffer
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -753,7 +759,8 @@ module Google
         #   @return [::String]
         #     Optional. A token identifying a page of results beyond the first page.
         #     Obtained through
-        #     [ListSkuGroups.next_page_token][] of the previous
+        #     {::Google::Cloud::Channel::V1::ListSkuGroupsResponse#next_page_token ListSkuGroupsResponse.next_page_token}
+        #     of the previous
         #     {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_sku_groups CloudChannelService.ListSkuGroups}
         #     call.
         class ListSkuGroupsRequest
@@ -775,7 +782,8 @@ module Google
         #   @return [::String]
         #     Optional. A token identifying a page of results beyond the first page.
         #     Obtained through
-        #     [ListSkuGroupBillableSkus.next_page_token][] of the previous
+        #     {::Google::Cloud::Channel::V1::ListSkuGroupBillableSkusResponse#next_page_token ListSkuGroupBillableSkusResponse.next_page_token}
+        #     of the previous
         #     {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_sku_group_billable_skus CloudChannelService.ListSkuGroupBillableSkus}
         #     call.
         class ListSkuGroupBillableSkusRequest
@@ -790,8 +798,9 @@ module Google
         # @!attribute [rw] next_page_token
         #   @return [::String]
         #     A token to retrieve the next page of results.
-        #     Pass to [ListSkuGroups.page_token][] to obtain that
-        #     page.
+        #     Pass to
+        #     {::Google::Cloud::Channel::V1::ListSkuGroupsRequest#page_token ListSkuGroupsRequest.page_token}
+        #     to obtain that page.
         class ListSkuGroupsResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -804,8 +813,9 @@ module Google
         # @!attribute [rw] next_page_token
         #   @return [::String]
         #     A token to retrieve the next page of results.
-        #     Pass to [ListSkuGroupBillableSkus.page_token][] to obtain that
-        #     page.
+        #     Pass to
+        #     {::Google::Cloud::Channel::V1::ListSkuGroupBillableSkusRequest#page_token ListSkuGroupBillableSkusRequest.page_token}
+        #     to obtain that page.
         class ListSkuGroupBillableSkusResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -954,7 +964,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for [CloudChannelService.ChangeParametersRequest][].
+        # Request message for
+        # {::Google::Cloud::Channel::V1::CloudChannelService::Client#change_parameters CloudChannelService.ChangeParameters}.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The name of the entitlement to update.
@@ -1060,6 +1071,11 @@ module Google
         #
         #     This field is only relevant for multi-currency accounts. It should be
         #     left empty for single currency accounts.
+        # @!attribute [rw] price_reference_id
+        #   @return [::String]
+        #     Optional. Price reference ID for the offer. Only for offers that require
+        #     additional price information. Used to guarantee that the pricing is
+        #     consistent between quoting the offer and placing the order.
         class ChangeOfferRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1296,6 +1312,9 @@ module Google
         # @!attribute [rw] offers
         #   @return [::Array<::Google::Cloud::Channel::V1::Offer>]
         #     The list of Offers requested.
+        #
+        #     The pricing information for each Offer only includes the base price.
+        #     Effective prices and discounts aren't populated.
         # @!attribute [rw] next_page_token
         #   @return [::String]
         #     A token to retrieve the next page of results.
@@ -1487,6 +1506,11 @@ module Google
         # @!attribute [rw] offer
         #   @return [::Google::Cloud::Channel::V1::Offer]
         #     Offer.
+        # @!attribute [rw] price_reference_id
+        #   @return [::String]
+        #     Optional. Price reference ID for the offer. Only for offers that require
+        #     additional price information. Used to guarantee that the pricing is
+        #     consistent between quoting the offer and placing the order.
         class PurchasableOffer
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1544,11 +1568,16 @@ module Google
         # Request Message for RegisterSubscriber.
         # @!attribute [rw] account
         #   @return [::String]
-        #     Required. Resource name of the account.
+        #     Optional. Resource name of the account. Required if integrator is not
+        #     provided. Otherwise, leave this field empty/unset.
         # @!attribute [rw] service_account
         #   @return [::String]
         #     Required. Service account that provides subscriber access to the registered
         #     topic.
+        # @!attribute [rw] integrator
+        #   @return [::String]
+        #     Optional. Resource name of the integrator. Required if account is not
+        #     provided. Otherwise, leave this field empty/unset.
         class RegisterSubscriberRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1566,11 +1595,16 @@ module Google
         # Request Message for UnregisterSubscriber.
         # @!attribute [rw] account
         #   @return [::String]
-        #     Required. Resource name of the account.
+        #     Optional. Resource name of the account. Required if integrator is not
+        #     provided. Otherwise, leave this field empty/unset.
         # @!attribute [rw] service_account
         #   @return [::String]
         #     Required. Service account to unregister from subscriber access to the
         #     topic.
+        # @!attribute [rw] integrator
+        #   @return [::String]
+        #     Optional. Resource name of the integrator. Required if account is not
+        #     provided. Otherwise, leave this field empty/unset.
         class UnregisterSubscriberRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1588,7 +1622,8 @@ module Google
         # Request Message for ListSubscribers.
         # @!attribute [rw] account
         #   @return [::String]
-        #     Required. Resource name of the account.
+        #     Optional. Resource name of the account. Required if integrator is not
+        #     provided. Otherwise, leave this field empty/unset.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. The maximum number of service accounts to return. The service may
@@ -1602,6 +1637,10 @@ module Google
         #
         #     When paginating, all other parameters provided to `ListSubscribers` must
         #     match the call that provided the page token.
+        # @!attribute [rw] integrator
+        #   @return [::String]
+        #     Optional. Resource name of the integrator. Required if account is not
+        #     provided. Otherwise, leave this field empty/unset.
         class ListSubscribersRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/channel/v1/subscriber_event.rb

@@ -28,7 +28,7 @@ module Google
         #     Format: accounts/\\{account_id}/customers/\\{customer_id}
         # @!attribute [rw] event_type
         #   @return [::Google::Cloud::Channel::V1::CustomerEvent::Type]
-        #     Type of event which happened on the customer.
+        #     Type of event which happened for the customer.
         class CustomerEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -53,7 +53,7 @@ module Google
         #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
         # @!attribute [rw] event_type
         #   @return [::Google::Cloud::Channel::V1::EntitlementEvent::Type]
-        #     Type of event which happened on the entitlement.
+        #     Type of event which happened for the entitlement.
         class EntitlementEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/type/date.rb

@@ -24,14 +24,17 @@ module Google
     # 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
+    # * A full date, with non-zero year, month, and day values.
+    # * A month and day, with a zero year (for example, an anniversary).
+    # * A year on its own, with a zero month and a zero day.
+    # * A year and month, with a zero day (for example, a credit card expiration
+    #   date).
     #
-    # Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
-    # `google.protobuf.Timestamp`.
+    # Related types:
+    #
+    # * [google.type.TimeOfDay][google.type.TimeOfDay]
+    # * {::Google::Type::DateTime google.type.DateTime}
+    # * {::Google::Protobuf::Timestamp 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

data/proto_docs/google/type/datetime.rb

@@ -32,8 +32,8 @@ module Google
     #
     # 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.
+    # If year, month, or day are 0, the DateTime is considered not to have a
+    # specific year, month, or day respectively.
     #
     # 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.
@@ -49,27 +49,28 @@ module Google
     #     datetime without a year.
     # @!attribute [rw] month
     #   @return [::Integer]
-    #     Required. Month of year. Must be from 1 to 12.
+    #     Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
+    #     datetime without a month.
     # @!attribute [rw] day
     #   @return [::Integer]
-    #     Required. Day of month. Must be from 1 to 31 and valid for the year and
-    #     month.
+    #     Optional. Day of month. Must be from 1 to 31 and valid for the year and
+    #     month, or 0 if specifying a datetime without a day.
     # @!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.
+    #     Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
+    #     to 0 (midnight). 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.
+    #     Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
     # @!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.
+    #     Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
+    #     defaults to 0. 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.
+    #     Optional. Fractions of seconds in nanoseconds. Must be from 0 to
+    #     999,999,999, defaults to 0.
     # @!attribute [rw] utc_offset
     #   @return [::Google::Protobuf::Duration]
     #     UTC offset. Must be whole seconds, between -18 hours and +18 hours.
@@ -91,10 +92,10 @@ module Google
     # [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".
+    #     IANA Time Zone Database time zone. For example "America/New_York".
     # @!attribute [rw] version
     #   @return [::String]
-    #     Optional. IANA Time Zone Database version number, e.g. "2019a".
+    #     Optional. IANA Time Zone Database version number. For example "2019a".
     class TimeZone
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods