google-cloud-dialogflow-cx-v3 0.22.0 → 0.24.0

data/lib/google/cloud/dialogflow/cx/v3/entity_type_services_pb.rb

@@ -34,8 +34,6 @@ module Google
               self.unmarshal_class_method = :decode
               self.service_name = 'google.cloud.dialogflow.cx.v3.EntityTypes'
 
-              # Returns the list of all entity types in the specified agent.
-              rpc :ListEntityTypes, ::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest, ::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesResponse
               # Retrieves the specified entity type.
               rpc :GetEntityType, ::Google::Cloud::Dialogflow::CX::V3::GetEntityTypeRequest, ::Google::Cloud::Dialogflow::CX::V3::EntityType
               # Creates an entity type in the specified agent.
@@ -56,6 +54,8 @@ module Google
               # [training
               # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
               rpc :DeleteEntityType, ::Google::Cloud::Dialogflow::CX::V3::DeleteEntityTypeRequest, ::Google::Protobuf::Empty
+              # Returns the list of all entity types in the specified agent.
+              rpc :ListEntityTypes, ::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest, ::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesResponse
             end
 
             Stub = Service.rpc_stub_class

data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb

@@ -32,6 +32,9 @@ module Google
             # Service for managing {::Google::Cloud::Dialogflow::CX::V3::EntityType EntityTypes}.
             #
             class Client
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "dialogflow.$UNIVERSE_DOMAIN$"
+
               include Paths
 
               # @private
@@ -97,6 +100,15 @@ module Google
                 @config
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @entity_types_stub.universe_domain
+              end
+
               ##
               # Create a new EntityTypes client object.
               #
@@ -130,8 +142,9 @@ module Google
                 credentials = @config.credentials
                 # Use self-signed JWT if the endpoint is unchanged from default,
                 # but only if the default endpoint does not have a region prefix.
-                enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                         !@config.endpoint.split(".").first.include?("-")
+                enable_self_signed_jwt = @config.endpoint.nil? ||
+                                         (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                         !@config.endpoint.split(".").first.include?("-"))
                 credentials ||= Credentials.default scope: @config.scope,
                                                     enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -144,12 +157,15 @@ module Google
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                 end
 
                 @entity_types_stub = ::Gapic::ServiceStub.new(
                   ::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Stub,
-                  credentials:  credentials,
-                  endpoint:     @config.endpoint,
+                  credentials: credentials,
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
                   channel_args: @config.channel_args,
                   interceptors: @config.interceptors,
                   channel_pool_config: @config.channel_pool
@@ -165,115 +181,6 @@ module Google
 
               # Service calls
 
-              ##
-              # Returns the list of all entity types in the specified agent.
-              #
-              # @overload list_entity_types(request, options = nil)
-              #   Pass arguments to `list_entity_types` via a request object, either of type
-              #   {::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest} or an equivalent Hash.
-              #
-              #   @param request [::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest, ::Hash]
-              #     A request object representing the call parameters. Required. To specify no
-              #     parameters, or to keep all the default parameter values, pass an empty Hash.
-              #   @param options [::Gapic::CallOptions, ::Hash]
-              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
-              #
-              # @overload list_entity_types(parent: nil, language_code: nil, page_size: nil, page_token: nil)
-              #   Pass arguments to `list_entity_types` via keyword arguments. Note that at
-              #   least one keyword argument is required. To specify no parameters, or to keep all
-              #   the default parameter values, pass an empty Hash as a request object (see above).
-              #
-              #   @param parent [::String]
-              #     Required. The agent to list all entity types for.
-              #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
-              #   @param language_code [::String]
-              #     The language to list entity types for. The following fields are language
-              #     dependent:
-              #
-              #     *   `EntityType.entities.value`
-              #     *   `EntityType.entities.synonyms`
-              #     *   `EntityType.excluded_phrases.value`
-              #
-              #     If not specified, the agent's default language is used.
-              #     [Many
-              #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
-              #     are supported.
-              #     Note: languages must be enabled in the agent before they can be used.
-              #   @param page_size [::Integer]
-              #     The maximum number of items to return in a single page. By default 100 and
-              #     at most 1000.
-              #   @param page_token [::String]
-              #     The next_page_token value returned from a previous list request.
-              #
-              # @yield [response, operation] Access the result along with the RPC operation
-              # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::EntityType>]
-              # @yieldparam operation [::GRPC::ActiveCall::Operation]
-              #
-              # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::EntityType>]
-              #
-              # @raise [::Google::Cloud::Error] if the RPC is aborted.
-              #
-              # @example Basic example
-              #   require "google/cloud/dialogflow/cx/v3"
-              #
-              #   # Create a client object. The client can be reused for multiple calls.
-              #   client = Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client.new
-              #
-              #   # Create a request. To set request fields, pass in keyword arguments.
-              #   request = Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest.new
-              #
-              #   # Call the list_entity_types method.
-              #   result = client.list_entity_types request
-              #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
-              #   # over elements, and API calls will be issued to fetch pages as needed.
-              #   result.each do |item|
-              #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::EntityType.
-              #     p item
-              #   end
-              #
-              def list_entity_types request, options = nil
-                raise ::ArgumentError, "request must be provided" if request.nil?
-
-                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest
-
-                # Converts hash and nil to an options object
-                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
-
-                # Customize the options with defaults
-                metadata = @config.rpcs.list_entity_types.metadata.to_h
-
-                # Set x-goog-api-client and x-goog-user-project headers
-                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
-                  lib_name: @config.lib_name, lib_version: @config.lib_version,
-                  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
-                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
-
-                header_params = {}
-                if request.parent
-                  header_params["parent"] = request.parent
-                end
-
-                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
-                metadata[:"x-goog-request-params"] ||= request_params_header
-
-                options.apply_defaults timeout:      @config.rpcs.list_entity_types.timeout,
-                                       metadata:     metadata,
-                                       retry_policy: @config.rpcs.list_entity_types.retry_policy
-
-                options.apply_defaults timeout:      @config.timeout,
-                                       metadata:     @config.metadata,
-                                       retry_policy: @config.retry_policy
-
-                @entity_types_stub.call_rpc :list_entity_types, request, options: options do |response, operation|
-                  response = ::Gapic::PagedEnumerable.new @entity_types_stub, :list_entity_types, request, response, operation, options
-                  yield response, operation if block_given?
-                  return response
-                end
-              rescue ::GRPC::BadStatus => e
-                raise ::Google::Cloud::Error.from_error(e)
-              end
-
               ##
               # Retrieves the specified entity type.
               #
@@ -685,6 +592,115 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Returns the list of all entity types in the specified agent.
+              #
+              # @overload list_entity_types(request, options = nil)
+              #   Pass arguments to `list_entity_types` via a request object, either of type
+              #   {::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload list_entity_types(parent: nil, language_code: nil, page_size: nil, page_token: nil)
+              #   Pass arguments to `list_entity_types` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param parent [::String]
+              #     Required. The agent to list all entity types for.
+              #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+              #   @param language_code [::String]
+              #     The language to list entity types for. The following fields are language
+              #     dependent:
+              #
+              #     *   `EntityType.entities.value`
+              #     *   `EntityType.entities.synonyms`
+              #     *   `EntityType.excluded_phrases.value`
+              #
+              #     If not specified, the agent's default language is used.
+              #     [Many
+              #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+              #     are supported.
+              #     Note: languages must be enabled in the agent before they can be used.
+              #   @param page_size [::Integer]
+              #     The maximum number of items to return in a single page. By default 100 and
+              #     at most 1000.
+              #   @param page_token [::String]
+              #     The next_page_token value returned from a previous list request.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::EntityType>]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::EntityType>]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/dialogflow/cx/v3"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest.new
+              #
+              #   # Call the list_entity_types method.
+              #   result = client.list_entity_types request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::EntityType.
+              #     p item
+              #   end
+              #
+              def list_entity_types request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListEntityTypesRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.list_entity_types.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.parent
+                  header_params["parent"] = request.parent
+                end
+
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.list_entity_types.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.list_entity_types.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @entity_types_stub.call_rpc :list_entity_types, request, options: options do |response, operation|
+                  response = ::Gapic::PagedEnumerable.new @entity_types_stub, :list_entity_types, request, response, operation, options
+                  yield response, operation if block_given?
+                  return response
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the EntityTypes API.
               #
@@ -701,23 +717,23 @@ module Google
               # @example
               #
               #   # Modify the global config, setting the timeout for
-              #   # list_entity_types to 20 seconds,
+              #   # get_entity_type to 20 seconds,
               #   # and all remaining timeouts to 10 seconds.
               #   ::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client.configure do |config|
               #     config.timeout = 10.0
-              #     config.rpcs.list_entity_types.timeout = 20.0
+              #     config.rpcs.get_entity_type.timeout = 20.0
               #   end
               #
               #   # Apply the above configuration only to a new client.
               #   client = ::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client.new do |config|
               #     config.timeout = 10.0
-              #     config.rpcs.list_entity_types.timeout = 20.0
+              #     config.rpcs.get_entity_type.timeout = 20.0
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"dialogflow.googleapis.com"`.
-              #   @return [::String]
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
               # @!attribute [rw] credentials
               #   Credentials to send with calls. You may provide any of the following types:
               #    *  (`String`) The path to a service account key file in JSON format
@@ -763,13 +779,20 @@ module Google
               # @!attribute [rw] quota_project
               #   A separate project against which to charge quota.
               #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
               #
               class Configuration
                 extend ::Gapic::Config
 
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
                 DEFAULT_ENDPOINT = "dialogflow.googleapis.com"
 
-                config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+                config_attr :endpoint,      nil, ::String, nil
                 config_attr :credentials,   nil do |value|
                   allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -784,6 +807,7 @@ module Google
                 config_attr :metadata,      nil, ::Hash, nil
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
+                config_attr :universe_domain, nil, ::String, nil
 
                 # @private
                 def initialize parent_config = nil
@@ -830,11 +854,6 @@ module Google
                 #         trigger a retry.
                 #
                 class Rpcs
-                  ##
-                  # RPC-specific configuration for `list_entity_types`
-                  # @return [::Gapic::Config::Method]
-                  #
-                  attr_reader :list_entity_types
                   ##
                   # RPC-specific configuration for `get_entity_type`
                   # @return [::Gapic::Config::Method]
@@ -855,11 +874,14 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :delete_entity_type
+                  ##
+                  # RPC-specific configuration for `list_entity_types`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_entity_types
 
                   # @private
                   def initialize parent_rpcs = nil
-                    list_entity_types_config = parent_rpcs.list_entity_types if parent_rpcs.respond_to? :list_entity_types
-                    @list_entity_types = ::Gapic::Config::Method.new list_entity_types_config
                     get_entity_type_config = parent_rpcs.get_entity_type if parent_rpcs.respond_to? :get_entity_type
                     @get_entity_type = ::Gapic::Config::Method.new get_entity_type_config
                     create_entity_type_config = parent_rpcs.create_entity_type if parent_rpcs.respond_to? :create_entity_type
@@ -868,6 +890,8 @@ module Google
                     @update_entity_type = ::Gapic::Config::Method.new update_entity_type_config
                     delete_entity_type_config = parent_rpcs.delete_entity_type if parent_rpcs.respond_to? :delete_entity_type
                     @delete_entity_type = ::Gapic::Config::Method.new delete_entity_type_config
+                    list_entity_types_config = parent_rpcs.list_entity_types if parent_rpcs.respond_to? :list_entity_types
+                    @list_entity_types = ::Gapic::Config::Method.new list_entity_types_config
 
                     yield self if block_given?
                   end