docs: update SelectiveGapicGeneration usage doc

google-cloud-talent-v4beta1/proto_docs/google/api/client.rb

@@ -31,6 +31,8 @@ module Api
     # @!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 @@ class Publishing
     #
     #     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 @@ class Publishing
     #
     #     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 @@ class CppSettings
     # @!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 @@ class RubySettings
     #     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 @@ class RenamedServicesEntry
     #
     #     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 @@ class RenamedServicesEntry
     #
     #     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 @@ class RenamedServicesEntry
     #
     #     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 @@ class LongRunning
 
     # 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 @@ class SelectiveGapicGeneration
       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 ClientLibraryDestination
       # 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

google-cloud-talent-v4beta1/proto_docs/google/type/latlng.rb

@@ -21,9 +21,9 @@ module Google
   module Type
     # An object that represents a latitude/longitude pair. This is expressed as a
     # pair of doubles to represent degrees latitude and degrees longitude. Unless
-    # specified otherwise, this must conform to the
-    # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
-    # standard</a>. Values must be within normalized ranges.
+    # specified otherwise, this object must conform to the
+    # <a href="https://en.wikipedia.org/wiki/World_Geodetic_System#1984_version">
+    # WGS84 standard</a>. Values must be within normalized ranges.
     # @!attribute [rw] latitude
     #   @return [::Float]
     #     The latitude in degrees. It must be in the range [-90.0, +90.0].

google-cloud-talent-v4beta1/proto_docs/google/type/postal_address.rb

@@ -19,23 +19,23 @@
 
 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).
+    # Represents a postal address, such as for postal delivery or payments
+    # addresses. With a postal address, a postal service can deliver items to a
+    # premise, P.O. box, or similar. A postal address is not intended to model
+    # geographical locations like roads, towns, or mountains.
     #
-    # In typical usage an address would be created via user input or from importing
+    # In typical usage, an address would be created by 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.
+    # Advice on address input or editing:
     #
-    # For more guidance on how to use this schema, please see:
-    # https://support.google.com/business/answer/6397478
+    #  - Use an internationalization-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, 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
@@ -46,8 +46,8 @@ module Type
     #   @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
+    #     correct. See https://cldr.unicode.org/ and
+    #     https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
     #     for details. Example: "CH" for Switzerland.
     # @!attribute [rw] language_code
     #   @return [::String]
@@ -67,55 +67,56 @@ module Type
     #   @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.).
+    #     additional validation with other parts of the address (for example,
+    #     state or zip code validation in the United States).
     # @!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).
+    #     "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just
+    #     a number alone, representing the "sector code" (Jamaica), "delivery area
+    #     indicator" (Malawi) or "post office indicator" (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.
+    #     For Spain, this is the province and not the autonomous
+    #     community (for example, "Barcelona" and not "Catalonia").
+    #     Many countries don't use an administrative area in postal addresses. For
+    #     example, in Switzerland, this should be left unpopulated.
     # @!attribute [rw] locality
     #   @return [::String]
-    #     Optional. Generally refers to the city/town portion of the address.
+    #     Optional. Generally refers to the city or 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.
+    #     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.
+    #     For example, this can be a neighborhood, borough, or district.
     # @!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.
+    #     Because values in `address_lines` do not have type information and may
+    #     sometimes contain multiple values in a single field (for example,
     #     "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.
+    #     address lines should be "envelope order" for the country or region of the
+    #     address. In places where this can vary (for example, Japan),
+    #     `address_language` is used to make it explicit (for example, "ja" for
+    #     large-to-small ordering and "ja-Latn" or "en" for small-to-large). In 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
+    #     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
+    #     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).