client.rb

# frozen_string_literal: true

# Copyright 2025 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 Api
    # Required information for every language.
    # @!attribute [rw] reference_docs_uri
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::String]
    #     Link to automatically generated reference documentation.  Example:
    #     https://cloud.google.com/nodejs/docs/reference/asset/latest
    # @!attribute [rw] destinations
    #   @return [::Array<::Google::Api::ClientLibraryDestination>]
    #     The destination where API teams want this client library to be published.
    # @!attribute [rw] selective_gapic_generation
    #   @return [::Google::Api::SelectiveGapicGeneration]
    #     Configuration for which RPCs should be generated in the GAPIC client.
    class CommonLanguageSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Details about how and where to publish client libraries.
    # @!attribute [rw] version
    #   @return [::String]
    #     Version of the API to apply these settings to. This is the full protobuf
    #     package for the API, ending in the version element.
    #     Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
    # @!attribute [rw] launch_stage
    #   @return [::Google::Api::LaunchStage]
    #     Launch stage of this version of the API.
    # @!attribute [rw] rest_numeric_enums
    #   @return [::Boolean]
    #     When using transport=rest, the client request will encode enums as
    #     numbers rather than strings.
    # @!attribute [rw] java_settings
    #   @return [::Google::Api::JavaSettings]
    #     Settings for legacy Java features, supported in the Service YAML.
    # @!attribute [rw] cpp_settings
    #   @return [::Google::Api::CppSettings]
    #     Settings for C++ client libraries.
    # @!attribute [rw] php_settings
    #   @return [::Google::Api::PhpSettings]
    #     Settings for PHP client libraries.
    # @!attribute [rw] python_settings
    #   @return [::Google::Api::PythonSettings]
    #     Settings for Python client libraries.
    # @!attribute [rw] node_settings
    #   @return [::Google::Api::NodeSettings]
    #     Settings for Node client libraries.
    # @!attribute [rw] dotnet_settings
    #   @return [::Google::Api::DotnetSettings]
    #     Settings for .NET client libraries.
    # @!attribute [rw] ruby_settings
    #   @return [::Google::Api::RubySettings]
    #     Settings for Ruby client libraries.
    # @!attribute [rw] go_settings
    #   @return [::Google::Api::GoSettings]
    #     Settings for Go client libraries.
    class ClientLibrarySettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # This message configures the settings for publishing [Google Cloud Client
    # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
    # generated from the service config.
    # @!attribute [rw] method_settings
    #   @return [::Array<::Google::Api::MethodSettings>]
    #     A list of API method settings, e.g. the behavior for methods that use the
    #     long-running operation pattern.
    # @!attribute [rw] new_issue_uri
    #   @return [::String]
    #     Link to a *public* URI where users can report issues.  Example:
    #     https://issuetracker.google.com/issues/new?component=190865&template=1161103
    # @!attribute [rw] documentation_uri
    #   @return [::String]
    #     Link to product home page.  Example:
    #     https://cloud.google.com/asset-inventory/docs/overview
    # @!attribute [rw] api_short_name
    #   @return [::String]
    #     Used as a tracking tag when collecting data about the APIs developer
    #     relations artifacts like docs, packages delivered to package managers,
    #     etc.  Example: "speech".
    # @!attribute [rw] github_label
    #   @return [::String]
    #     GitHub label to apply to issues and pull requests opened for this API.
    # @!attribute [rw] codeowner_github_teams
    #   @return [::Array<::String>]
    #     GitHub teams to be added to CODEOWNERS in the directory in GitHub
    #     containing source code for the client libraries for this API.
    # @!attribute [rw] doc_tag_prefix
    #   @return [::String]
    #     A prefix used in sample code when demarking regions to be included in
    #     documentation.
    # @!attribute [rw] organization
    #   @return [::Google::Api::ClientLibraryOrganization]
    #     For whom the client library is being published.
    # @!attribute [rw] library_settings
    #   @return [::Array<::Google::Api::ClientLibrarySettings>]
    #     Client library settings.  If the same version string appears multiple
    #     times in this list, then the last one wins.  Settings from earlier
    #     settings with the same version string are discarded.
    # @!attribute [rw] proto_reference_documentation_uri
    #   @return [::String]
    #     Optional link to proto reference documentation.  Example:
    #     https://cloud.google.com/pubsub/lite/docs/reference/rpc
    # @!attribute [rw] rest_reference_documentation_uri
    #   @return [::String]
    #     Optional link to REST reference documentation.  Example:
    #     https://cloud.google.com/pubsub/lite/docs/reference/rest
    class Publishing
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Settings for Java client libraries.
    # @!attribute [rw] library_package
    #   @return [::String]
    #     The package name to use in Java. Clobbers the java_package option
    #     set in the protobuf. This should be used **only** by APIs
    #     who have already set the language_settings.java.package_name" field
    #     in gapic.yaml. API teams should use the protobuf java_package option
    #     where possible.
    #
    #     Example of a YAML configuration::
    #
    #         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
    #     corresponding generated GAPIC client. Keys are fully-qualified
    #     service names as they appear in the protobuf (including the full
    #     the language_settings.java.interface_names" field in gapic.yaml. API
    #     teams should otherwise use the service name as it appears in the
    #     protobuf.
    #
    #     Example of a YAML configuration::
    #
    #         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.
    class JavaSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class ServiceClassNamesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Settings for C++ client libraries.
    # @!attribute [rw] common
    #   @return [::Google::Api::CommonLanguageSettings]
    #     Some settings.
    class CppSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Settings for Php client libraries.
    # @!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
    end

    # Settings for Python client libraries.
    # @!attribute [rw] common
    #   @return [::Google::Api::CommonLanguageSettings]
    #     Some settings.
    # @!attribute [rw] experimental_features
    #   @return [::Google::Api::PythonSettings::ExperimentalFeatures]
    #     Experimental features to be included during client library generation.
    class PythonSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Experimental features to be included during client library generation.
      # These fields will be deprecated once the feature graduates and is enabled
      # by default.
      # @!attribute [rw] rest_async_io_enabled
      #   @return [::Boolean]
      #     Enables generation of asynchronous REST clients if `rest` transport is
      #     enabled. By default, asynchronous REST clients will not be generated.
      #     This feature will be enabled by default 1 month after launching the
      #     feature in preview packages.
      # @!attribute [rw] protobuf_pythonic_types_enabled
      #   @return [::Boolean]
      #     Enables generation of protobuf code using new types that are more
      #     Pythonic which are included in `protobuf>=5.29.x`. This feature will be
      #     enabled by default 1 month after launching the feature in preview
      #     packages.
      # @!attribute [rw] unversioned_package_disabled
      #   @return [::Boolean]
      #     Disables generation of an unversioned Python package for this client
      #     library. This means that the module names will need to be versioned in
      #     import statements. For example `import google.cloud.library_v2` instead
      #     of `import google.cloud.library`.
      class ExperimentalFeatures
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Settings for Node client libraries.
    # @!attribute [rw] common
    #   @return [::Google::Api::CommonLanguageSettings]
    #     Some settings.
    class NodeSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Settings for Dotnet client libraries.
    # @!attribute [rw] common
    #   @return [::Google::Api::CommonLanguageSettings]
    #     Some settings.
    # @!attribute [rw] renamed_services
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Map from original service names to renamed versions.
    #     This is used when the default generated types
    #     would cause a naming conflict. (Neither name is
    #     fully-qualified.)
    #     Example: Subscriber to SubscriberServiceApi.
    # @!attribute [rw] renamed_resources
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Map from full resource types to the effective short name
    #     for the resource. This is used when otherwise resource
    #     named from different services would cause naming collisions.
    #     Example entry:
    #     "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
    # @!attribute [rw] ignored_resources
    #   @return [::Array<::String>]
    #     List of full resource types to ignore during generation.
    #     This is typically used for API-specific Location resources,
    #     which should be handled by the generator as if they were actually
    #     the common Location resources.
    #     Example entry: "documentai.googleapis.com/Location"
    # @!attribute [rw] forced_namespace_aliases
    #   @return [::Array<::String>]
    #     Namespaces which must be aliased in snippets due to
    #     a known (but non-generator-predictable) naming collision
    # @!attribute [rw] handwritten_signatures
    #   @return [::Array<::String>]
    #     Method signatures (in the form "service.method(signature)")
    #     which are provided separately, so shouldn't be generated.
    #     Snippets *calling* these methods are still generated, however.
    class DotnetSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class RenamedServicesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class RenamedResourcesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Settings for Ruby client libraries.
    # @!attribute [rw] common
    #   @return [::Google::Api::CommonLanguageSettings]
    #     Some settings.
    class RubySettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Settings for Go client libraries.
    # @!attribute [rw] common
    #   @return [::Google::Api::CommonLanguageSettings]
    #     Some settings.
    # @!attribute [rw] renamed_services
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Map of service names to renamed services. Keys are the package relative
    #     service names and values are the name to be used for the service client
    #     and call options.
    #
    #     Example:
    #
    #         publishing:
    #           go_settings:
    #             renamed_services:
    #               Publisher: TopicAdmin
    class GoSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class RenamedServicesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Describes the generator configuration for a method.
    # @!attribute [rw] selector
    #   @return [::String]
    #     The fully qualified name of the method, for which the options below apply.
    #     This is used to find the method to apply the options.
    #
    #     Example:
    #
    #         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
    #     API methods for RPCs. Complements RPCs that use the annotations in
    #     google/longrunning/operations.proto.
    #
    #     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
    # @!attribute [rw] auto_populated_fields
    #   @return [::Array<::String>]
    #     List of top-level fields of the request message, that should be
    #     automatically populated by the client libraries based on their
    #     (google.api.field_info).format. Currently supported format: UUID4.
    #
    #     Example of a YAML configuration:
    #
    #         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

      # Describes settings to use when generating API methods that use the
      # long-running operation pattern.
      # All default values below are from those used in the client library
      # generators (e.g.
      # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
      # @!attribute [rw] initial_poll_delay
      #   @return [::Google::Protobuf::Duration]
      #     Initial delay after which the first poll request will be made.
      #     Default value: 5 seconds.
      # @!attribute [rw] poll_delay_multiplier
      #   @return [::Float]
      #     Multiplier to gradually increase delay between subsequent polls until it
      #     reaches max_poll_delay.
      #     Default value: 1.5.
      # @!attribute [rw] max_poll_delay
      #   @return [::Google::Protobuf::Duration]
      #     Maximum time between two subsequent poll requests.
      #     Default value: 45 seconds.
      # @!attribute [rw] total_poll_timeout
      #   @return [::Google::Protobuf::Duration]
      #     Total polling timeout.
      #     Default value: 5 minutes.
      class LongRunning
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # This message is used to configure the generation of a subset of the RPCs in
    # a service for client libraries.
    # @!attribute [rw] methods
    #   @return [::Array<::String>]
    #     An allowlist of the fully qualified names of RPCs that should be included
    #     on public client surfaces.
    # @!attribute [rw] generate_omitted_as_internal
    #   @return [::Boolean]
    #     Setting this to true indicates to the client generators that methods
    #     that would be excluded from the generation should instead be generated
    #     in a way that indicates these methods should not be consumed by
    #     end users. How this is expressed is up to individual language
    #     implementations to decide. Some examples may be: added annotations,
    #     obfuscated identifiers, or other language idiomatic patterns.
    class SelectiveGapicGeneration
      include ::Google::Protobuf::MessageExts
      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
      # Not useful.
      CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0

      # Google Cloud Platform Org.
      CLOUD = 1

      # Ads (Advertising) Org.
      ADS = 2

      # Photos Org.
      PHOTOS = 3

      # Street View Org.
      STREET_VIEW = 4

      # Shopping Org.
      SHOPPING = 5

      # Geo Org.
      GEO = 6

      # Generative AI - https://developers.generativeai.google
      GENERATIVE_AI = 7
    end

    # To where should client libraries be published?
    module ClientLibraryDestination
      # Client libraries will neither be generated nor published to package
      # managers.
      CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0

      # Generate the client library in a repo under github.com/googleapis,
      # but don't publish it to package managers.
      GITHUB = 10

      # 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