google-cloud-document_ai-v1beta3 0.47.0 → 0.48.1

data/lib/google/cloud/documentai/v1beta3/processor_pb.rb

@@ -13,32 +13,8 @@ require 'google/protobuf/timestamp_pb'
 
 descriptor_data = "\n/google/cloud/documentai/v1beta3/processor.proto\x12\x1fgoogle.cloud.documentai.v1beta3\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x35google/cloud/documentai/v1beta3/document_schema.proto\x1a\x30google/cloud/documentai/v1beta3/evaluation.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xd8\x0f\n\x10ProcessorVersion\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x14\n\x0c\x64isplay_name\x18\x02 \x01(\t\x12M\n\x0f\x64ocument_schema\x18\x0c \x01(\x0b\x32/.google.cloud.documentai.v1beta3.DocumentSchemaB\x03\xe0\x41\x03\x12K\n\x05state\x18\x06 \x01(\x0e\x32\x37.google.cloud.documentai.v1beta3.ProcessorVersion.StateB\x03\xe0\x41\x03\x12\x34\n\x0b\x63reate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12T\n\x11latest_evaluation\x18\x08 \x01(\x0b\x32\x34.google.cloud.documentai.v1beta3.EvaluationReferenceB\x03\xe0\x41\x03\x12\x19\n\x0ckms_key_name\x18\t \x01(\tB\x03\xe0\x41\x03\x12!\n\x14kms_key_version_name\x18\n \x01(\tB\x03\xe0\x41\x03\x12\x1b\n\x0egoogle_managed\x18\x0b \x01(\x08\x42\x03\xe0\x41\x03\x12`\n\x10\x64\x65precation_info\x18\r \x01(\x0b\x32\x41.google.cloud.documentai.v1beta3.ProcessorVersion.DeprecationInfoB\x03\xe0\x41\x03\x12T\n\nmodel_type\x18\x0f \x01(\x0e\x32;.google.cloud.documentai.v1beta3.ProcessorVersion.ModelTypeB\x03\xe0\x41\x03\x12\x1a\n\rsatisfies_pzs\x18\x10 \x01(\x08\x42\x03\xe0\x41\x03\x12\x1a\n\rsatisfies_pzi\x18\x11 \x01(\x08\x42\x03\xe0\x41\x03\x12`\n\x11gen_ai_model_info\x18\x12 \x01(\x0b\x32@.google.cloud.documentai.v1beta3.ProcessorVersion.GenAiModelInfoB\x03\xe0\x41\x03\x1a\x9f\x01\n\x0f\x44\x65precationInfo\x12\x34\n\x10\x64\x65precation_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12V\n\x1dreplacement_processor_version\x18\x02 \x01(\tB/\xfa\x41,\n*documentai.googleapis.com/ProcessorVersion\x1a\x99\x05\n\x0eGenAiModelInfo\x12\x81\x01\n\x1c\x66oundation_gen_ai_model_info\x18\x01 \x01(\x0b\x32Y.google.cloud.documentai.v1beta3.ProcessorVersion.GenAiModelInfo.FoundationGenAiModelInfoH\x00\x12y\n\x18\x63ustom_gen_ai_model_info\x18\x02 \x01(\x0b\x32U.google.cloud.documentai.v1beta3.ProcessorVersion.GenAiModelInfo.CustomGenAiModelInfoH\x00\x1a[\n\x18\x46oundationGenAiModelInfo\x12\x1a\n\x12\x66inetuning_allowed\x18\x01 \x01(\x08\x12#\n\x1bmin_train_labeled_documents\x18\x02 \x01(\x05\x1a\x9c\x02\n\x14\x43ustomGenAiModelInfo\x12\x80\x01\n\x11\x63ustom_model_type\x18\x01 \x01(\x0e\x32\x65.google.cloud.documentai.v1beta3.ProcessorVersion.GenAiModelInfo.CustomGenAiModelInfo.CustomModelType\x12!\n\x19\x62\x61se_processor_version_id\x18\x02 \x01(\t\"^\n\x0f\x43ustomModelType\x12!\n\x1d\x43USTOM_MODEL_TYPE_UNSPECIFIED\x10\x00\x12\x18\n\x14VERSIONED_FOUNDATION\x10\x01\x12\x0e\n\nFINE_TUNED\x10\x02\x42\x0c\n\nmodel_info\"\x93\x01\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44\x45PLOYED\x10\x01\x12\r\n\tDEPLOYING\x10\x02\x12\x0e\n\nUNDEPLOYED\x10\x03\x12\x0f\n\x0bUNDEPLOYING\x10\x04\x12\x0c\n\x08\x43REATING\x10\x05\x12\x0c\n\x08\x44\x45LETING\x10\x06\x12\n\n\x06\x46\x41ILED\x10\x07\x12\r\n\tIMPORTING\x10\x08\"Y\n\tModelType\x12\x1a\n\x16MODEL_TYPE_UNSPECIFIED\x10\x00\x12\x19\n\x15MODEL_TYPE_GENERATIVE\x10\x01\x12\x15\n\x11MODEL_TYPE_CUSTOM\x10\x02:\x96\x01\xea\x41\x92\x01\n*documentai.googleapis.com/ProcessorVersion\x12\x64projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}\"r\n\x15ProcessorVersionAlias\x12\r\n\x05\x61lias\x18\x01 \x01(\t\x12J\n\x11processor_version\x18\x02 \x01(\tB/\xfa\x41,\n*documentai.googleapis.com/ProcessorVersion\"\xcf\x05\n\tProcessor\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xe0\x41\x05\xe0\x41\x03\x12\x0c\n\x04type\x18\x02 \x01(\t\x12\x14\n\x0c\x64isplay_name\x18\x03 \x01(\t\x12\x44\n\x05state\x18\x04 \x01(\x0e\x32\x30.google.cloud.documentai.v1beta3.Processor.StateB\x03\xe0\x41\x03\x12R\n\x19\x64\x65\x66\x61ult_processor_version\x18\t \x01(\tB/\xfa\x41,\n*documentai.googleapis.com/ProcessorVersion\x12^\n\x19processor_version_aliases\x18\n \x03(\x0b\x32\x36.google.cloud.documentai.v1beta3.ProcessorVersionAliasB\x03\xe0\x41\x03\x12 \n\x10process_endpoint\x18\x06 \x01(\tB\x06\xe0\x41\x03\xe0\x41\x05\x12\x34\n\x0b\x63reate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x14\n\x0ckms_key_name\x18\x08 \x01(\t\x12\x1a\n\rsatisfies_pzs\x18\x0c \x01(\x08\x42\x03\xe0\x41\x03\x12\x1a\n\rsatisfies_pzi\x18\r \x01(\x08\x42\x03\xe0\x41\x03\"~\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02\x12\x0c\n\x08\x45NABLING\x10\x03\x12\r\n\tDISABLING\x10\x04\x12\x0c\n\x08\x43REATING\x10\x05\x12\n\n\x06\x46\x41ILED\x10\x06\x12\x0c\n\x08\x44\x45LETING\x10\x07:h\xea\x41\x65\n#documentai.googleapis.com/Processor\x12>projects/{project}/locations/{location}/processors/{processor}B\xea\x01\n#com.google.cloud.documentai.v1beta3B\x13\x44ocumentAiProcessorP\x01ZCcloud.google.com/go/documentai/apiv1beta3/documentaipb;documentaipb\xaa\x02\x1fGoogle.Cloud.DocumentAI.V1Beta3\xca\x02\x1fGoogle\\Cloud\\DocumentAI\\V1beta3\xea\x02\"Google::Cloud::DocumentAI::V1beta3b\x06proto3"
 
-pool = Google::Protobuf::DescriptorPool.generated_pool
-
-begin
-  pool.add_serialized_file(descriptor_data)
-rescue TypeError
-  # Compatibility code: will be removed in the next major version.
-  require 'google/protobuf/descriptor_pb'
-  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
-  parsed.clear_dependency
-  serialized = parsed.class.encode(parsed)
-  file = pool.add_serialized_file(serialized)
-  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
-  imports = [
-    ["google.cloud.documentai.v1beta3.DocumentSchema", "google/cloud/documentai/v1beta3/document_schema.proto"],
-    ["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
-    ["google.cloud.documentai.v1beta3.EvaluationReference", "google/cloud/documentai/v1beta3/evaluation.proto"],
-  ]
-  imports.each do |type_name, expected_filename|
-    import_file = pool.lookup(type_name).file_descriptor
-    if import_file.name != expected_filename
-      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
-    end
-  end
-  warn "Each proto file must use a consistent fully-qualified name."
-  warn "This will become an error in the next major version."
-end
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
 
 module Google
   module Cloud

data/lib/google/cloud/documentai/v1beta3/processor_type_pb.rb

@@ -10,29 +10,8 @@ require 'google/api/resource_pb'
 
 descriptor_data = "\n4google/cloud/documentai/v1beta3/processor_type.proto\x12\x1fgoogle.cloud.documentai.v1beta3\x1a\x1dgoogle/api/launch_stage.proto\x1a\x19google/api/resource.proto\"\x98\x03\n\rProcessorType\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0c\n\x04type\x18\x02 \x01(\t\x12\x10\n\x08\x63\x61tegory\x18\x03 \x01(\t\x12X\n\x13\x61vailable_locations\x18\x04 \x03(\x0b\x32;.google.cloud.documentai.v1beta3.ProcessorType.LocationInfo\x12\x16\n\x0e\x61llow_creation\x18\x06 \x01(\x08\x12-\n\x0claunch_stage\x18\x08 \x01(\x0e\x32\x17.google.api.LaunchStage\x12\x1c\n\x14sample_document_uris\x18\t \x03(\t\x1a#\n\x0cLocationInfo\x12\x13\n\x0blocation_id\x18\x01 \x01(\t:u\xea\x41r\n\'documentai.googleapis.com/ProcessorType\x12Gprojects/{project}/locations/{location}/processorTypes/{processor_type}B\xee\x01\n#com.google.cloud.documentai.v1beta3B\x17\x44ocumentAiProcessorTypeP\x01ZCcloud.google.com/go/documentai/apiv1beta3/documentaipb;documentaipb\xaa\x02\x1fGoogle.Cloud.DocumentAI.V1Beta3\xca\x02\x1fGoogle\\Cloud\\DocumentAI\\V1beta3\xea\x02\"Google::Cloud::DocumentAI::V1beta3b\x06proto3"
 
-pool = Google::Protobuf::DescriptorPool.generated_pool
-
-begin
-  pool.add_serialized_file(descriptor_data)
-rescue TypeError
-  # Compatibility code: will be removed in the next major version.
-  require 'google/protobuf/descriptor_pb'
-  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
-  parsed.clear_dependency
-  serialized = parsed.class.encode(parsed)
-  file = pool.add_serialized_file(serialized)
-  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
-  imports = [
-  ]
-  imports.each do |type_name, expected_filename|
-    import_file = pool.lookup(type_name).file_descriptor
-    if import_file.name != expected_filename
-      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
-    end
-  end
-  warn "Each proto file must use a consistent fully-qualified name."
-  warn "This will become an error in the next major version."
-end
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
 
 module Google
   module Cloud

data/proto_docs/google/api/client.rb

@@ -141,9 +141,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 +156,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 +191,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 +333,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 +361,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 +373,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 +389,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
@@ -428,6 +458,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 +570,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/documentai/v1beta3/document_processor_service.rb

@@ -899,6 +899,13 @@ module Google
           #     Optional. The multiplier to apply to the recommended learning rate. Valid
           #     values are between 0.1 and 10. If not provided, recommended learning rate
           #     will be used.
+          # @!attribute [rw] previous_fine_tuned_processor_version_name
+          #   @return [::String]
+          #     Optional. Resource name of a previously fine tuned version id to copy the
+          #     overwritten configs from. The base_processor_version should be newer than
+          #     the base processor version used to fine tune this provided processor
+          #     version. Format:
+          #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
           class FoundationModelTuningOptions
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/wrappers.rb

@@ -22,6 +22,9 @@ module Google
     # Wrapper message for `double`.
     #
     # The JSON representation for `DoubleValue` is JSON number.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Float]
     #     The double value.
@@ -33,6 +36,9 @@ module Google
     # Wrapper message for `float`.
     #
     # The JSON representation for `FloatValue` is JSON number.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Float]
     #     The float value.
@@ -44,6 +50,9 @@ module Google
     # Wrapper message for `int64`.
     #
     # The JSON representation for `Int64Value` is JSON string.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Integer]
     #     The int64 value.
@@ -55,6 +64,9 @@ module Google
     # Wrapper message for `uint64`.
     #
     # The JSON representation for `UInt64Value` is JSON string.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Integer]
     #     The uint64 value.
@@ -66,6 +78,9 @@ module Google
     # Wrapper message for `int32`.
     #
     # The JSON representation for `Int32Value` is JSON number.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Integer]
     #     The int32 value.
@@ -77,6 +92,9 @@ module Google
     # Wrapper message for `uint32`.
     #
     # The JSON representation for `UInt32Value` is JSON number.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Integer]
     #     The uint32 value.
@@ -88,6 +106,9 @@ module Google
     # Wrapper message for `bool`.
     #
     # The JSON representation for `BoolValue` is JSON `true` and `false`.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Boolean]
     #     The bool value.
@@ -99,6 +120,9 @@ module Google
     # Wrapper message for `string`.
     #
     # The JSON representation for `StringValue` is JSON string.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::String]
     #     The string value.
@@ -110,6 +134,9 @@ module Google
     # Wrapper message for `bytes`.
     #
     # The JSON representation for `BytesValue` is JSON string.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::String]
     #     The bytes value.

data/proto_docs/google/type/color.rb

@@ -20,22 +20,22 @@
 module Google
   module Type
     # Represents a color in the RGBA color space. This representation is designed
-    # for simplicity of conversion to/from color representations in various
+    # for simplicity of conversion to and from color representations in various
     # languages over compactness. For example, the fields of this representation
     # can be trivially provided to the constructor of `java.awt.Color` in Java; it
     # can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
     # method in iOS; and, with just a little work, it can be easily formatted into
     # a CSS `rgba()` string in JavaScript.
     #
-    # This reference page doesn't carry information about the absolute color
-    # space
-    # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,
-    # DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color
+    # This reference page doesn't have information about the absolute color
+    # space that should be used to interpret the RGB value—for example, sRGB,
+    # Adobe RGB,
+    # DCI-P3, and BT.2020. By default, applications should assume the sRGB color
     # space.
     #
-    # When color equality needs to be decided, implementations, unless
-    # documented otherwise, treat two colors as equal if all their red,
-    # green, blue, and alpha values each differ by at most 1e-5.
+    # When color equality needs to be decided, implementations, unless documented
+    # otherwise, treat two colors as equal if all their red, green, blue, and alpha
+    # values each differ by at most `1e-5`.
     #
     # Example (Java):
     #

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