# frozen_string_literal: true # Copyright 2023 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! require "google/cloud/errors" require "google/cloud/dialogflow/cx/v3/environment_pb" require "google/cloud/dialogflow/cx/v3/environments/rest/service_stub" require "google/cloud/location/rest" module Google module Cloud module Dialogflow module CX module V3 module Environments module Rest ## # REST client for the Environments service. # # Service for managing # {::Google::Cloud::Dialogflow::CX::V3::Environment Environments}. # class Client include Paths # @private attr_reader :environments_stub ## # Configure the Environments Client class. # # See {::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all Environments clients # ::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dialogflow", "CX", "V3"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end ## # Configure the Environments Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new Environments REST client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Environments client. # @yieldparam config [Client::Configuration] # def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials 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 == Client.configure.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) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.bindings_override = @config.bindings_override end @environments_stub = ::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Operations] # attr_reader :operations_client ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Rest::Client] # attr_reader :location_client # Service calls ## # Returns the list of all environments in the specified # {::Google::Cloud::Dialogflow::CX::V3::Agent Agent}. # # @overload list_environments(request, options = nil) # Pass arguments to `list_environments` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::ListEnvironmentsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::ListEnvironmentsRequest, ::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_environments(parent: nil, page_size: nil, page_token: nil) # Pass arguments to `list_environments` 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 {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to list all # environments for. Format: `projects//locations//agents/`. # @param page_size [::Integer] # The maximum number of items to return in a single page. By default 20 and # at most 100. # @param page_token [::String] # The next_page_token value returned from a previous list request. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Environment>] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Environment>] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_environments request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListEnvironmentsRequest # 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 call_metadata = @config.rpcs.list_environments.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_environments.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_environments.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @environments_stub.list_environments request, options do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @environments_stub, :list_environments, "environments", request, result, options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Retrieves the specified # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. # # @overload get_environment(request, options = nil) # Pass arguments to `get_environment` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::GetEnvironmentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::GetEnvironmentRequest, ::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 get_environment(name: nil) # Pass arguments to `get_environment` 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 name [::String] # Required. The name of the # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. Format: # `projects//locations//agents//environments/`. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::Environment] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Dialogflow::CX::V3::Environment] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def get_environment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::GetEnvironmentRequest # 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 call_metadata = @config.rpcs.get_environment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_environment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_environment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @environments_stub.get_environment request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Creates an {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} in the # specified {::Google::Cloud::Dialogflow::CX::V3::Agent Agent}. # # This method is a [long-running # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). # The returned `Operation` type has the following method-specific fields: # # - `metadata`: An empty [Struct # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) # - `response`: {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} # # @overload create_environment(request, options = nil) # Pass arguments to `create_environment` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::CreateEnvironmentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::CreateEnvironmentRequest, ::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 create_environment(parent: nil, environment: nil) # Pass arguments to `create_environment` 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 {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for. Format: # `projects//locations//agents/`. # @param environment [::Google::Cloud::Dialogflow::CX::V3::Environment, ::Hash] # Required. The environment to create. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def create_environment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::CreateEnvironmentRequest # 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 call_metadata = @config.rpcs.create_environment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.create_environment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.create_environment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @environments_stub.create_environment request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates the specified # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. # # This method is a [long-running # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). # The returned `Operation` type has the following method-specific fields: # # - `metadata`: An empty [Struct # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) # - `response`: {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} # # @overload update_environment(request, options = nil) # Pass arguments to `update_environment` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::UpdateEnvironmentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::UpdateEnvironmentRequest, ::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 update_environment(environment: nil, update_mask: nil) # Pass arguments to `update_environment` 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 environment [::Google::Cloud::Dialogflow::CX::V3::Environment, ::Hash] # Required. The environment to update. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Required. The mask to control which fields get updated. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def update_environment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::UpdateEnvironmentRequest # 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 call_metadata = @config.rpcs.update_environment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.update_environment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.update_environment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @environments_stub.update_environment request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes the specified # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. # # @overload delete_environment(request, options = nil) # Pass arguments to `delete_environment` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::DeleteEnvironmentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::DeleteEnvironmentRequest, ::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 delete_environment(name: nil) # Pass arguments to `delete_environment` 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 name [::String] # Required. The name of the # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete. Format: # `projects//locations//agents//environments/`. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Protobuf::Empty] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Protobuf::Empty] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def delete_environment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::DeleteEnvironmentRequest # 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 call_metadata = @config.rpcs.delete_environment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.delete_environment.timeout, metadata: call_metadata, retry_policy: @config.rpcs.delete_environment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @environments_stub.delete_environment request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Looks up the history of the specified # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. # # @overload lookup_environment_history(request, options = nil) # Pass arguments to `lookup_environment_history` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::LookupEnvironmentHistoryRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::LookupEnvironmentHistoryRequest, ::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 lookup_environment_history(name: nil, page_size: nil, page_token: nil) # Pass arguments to `lookup_environment_history` 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 name [::String] # Required. Resource name of the environment to look up the history for. # Format: `projects//locations//agents//environments/`. # @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 [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Environment>] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Environment>] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def lookup_environment_history request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::LookupEnvironmentHistoryRequest # 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 call_metadata = @config.rpcs.lookup_environment_history.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.lookup_environment_history.timeout, metadata: call_metadata, retry_policy: @config.rpcs.lookup_environment_history.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @environments_stub.lookup_environment_history request, options do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @environments_stub, :lookup_environment_history, "environments", request, result, options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Kicks off a continuous test under the specified # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. # # This method is a [long-running # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). # The returned `Operation` type has the following method-specific fields: # # - `metadata`: # {::Google::Cloud::Dialogflow::CX::V3::RunContinuousTestMetadata RunContinuousTestMetadata} # - `response`: # {::Google::Cloud::Dialogflow::CX::V3::RunContinuousTestResponse RunContinuousTestResponse} # # @overload run_continuous_test(request, options = nil) # Pass arguments to `run_continuous_test` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::RunContinuousTestRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::RunContinuousTestRequest, ::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 run_continuous_test(environment: nil) # Pass arguments to `run_continuous_test` 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 environment [::String] # Required. Format: `projects//locations//agents//environments/`. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def run_continuous_test request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::RunContinuousTestRequest # 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 call_metadata = @config.rpcs.run_continuous_test.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.run_continuous_test.timeout, metadata: call_metadata, retry_policy: @config.rpcs.run_continuous_test.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @environments_stub.run_continuous_test request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Fetches a list of continuous test results for a given environment. # # @overload list_continuous_test_results(request, options = nil) # Pass arguments to `list_continuous_test_results` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::ListContinuousTestResultsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::ListContinuousTestResultsRequest, ::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_continuous_test_results(parent: nil, page_size: nil, page_token: nil) # Pass arguments to `list_continuous_test_results` 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 environment to list results for. # Format: `projects//locations//agents// # environments/`. # @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 [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::ContinuousTestResult>] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::ContinuousTestResult>] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_continuous_test_results request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListContinuousTestResultsRequest # 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 call_metadata = @config.rpcs.list_continuous_test_results.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_continuous_test_results.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_continuous_test_results.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @environments_stub.list_continuous_test_results request, options do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @environments_stub, :list_continuous_test_results, "continuous_test_results", request, result, options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Deploys a flow to the specified # {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. # # This method is a [long-running # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). # The returned `Operation` type has the following method-specific fields: # # - `metadata`: # {::Google::Cloud::Dialogflow::CX::V3::DeployFlowMetadata DeployFlowMetadata} # - `response`: # {::Google::Cloud::Dialogflow::CX::V3::DeployFlowResponse DeployFlowResponse} # # @overload deploy_flow(request, options = nil) # Pass arguments to `deploy_flow` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::DeployFlowRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::DeployFlowRequest, ::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 deploy_flow(environment: nil, flow_version: nil) # Pass arguments to `deploy_flow` 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 environment [::String] # Required. The environment to deploy the flow to. # Format: `projects//locations//agents// # environments/`. # @param flow_version [::String] # Required. The flow version to deploy. # Format: `projects//locations//agents// # flows//versions/`. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def deploy_flow request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::DeployFlowRequest # 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 call_metadata = @config.rpcs.deploy_flow.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.deploy_flow.timeout, metadata: call_metadata, retry_policy: @config.rpcs.deploy_flow.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @environments_stub.deploy_flow request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the Environments REST API. # # This class represents the configuration for Environments REST, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # list_environments to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_environments.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::Dialogflow::CX::V3::Environments::Rest::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_environments.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"dialogflow.googleapis.com"`. # @return [::String] # @!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 # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config config_attr :endpoint, "dialogflow.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil # @private # Overrides for http bindings for the RPCs of this service # are only used when this service is used as mixin, and only # by the host service. # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}] config_attr :bindings_override, {}, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the Environments API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_environments` # @return [::Gapic::Config::Method] # attr_reader :list_environments ## # RPC-specific configuration for `get_environment` # @return [::Gapic::Config::Method] # attr_reader :get_environment ## # RPC-specific configuration for `create_environment` # @return [::Gapic::Config::Method] # attr_reader :create_environment ## # RPC-specific configuration for `update_environment` # @return [::Gapic::Config::Method] # attr_reader :update_environment ## # RPC-specific configuration for `delete_environment` # @return [::Gapic::Config::Method] # attr_reader :delete_environment ## # RPC-specific configuration for `lookup_environment_history` # @return [::Gapic::Config::Method] # attr_reader :lookup_environment_history ## # RPC-specific configuration for `run_continuous_test` # @return [::Gapic::Config::Method] # attr_reader :run_continuous_test ## # RPC-specific configuration for `list_continuous_test_results` # @return [::Gapic::Config::Method] # attr_reader :list_continuous_test_results ## # RPC-specific configuration for `deploy_flow` # @return [::Gapic::Config::Method] # attr_reader :deploy_flow # @private def initialize parent_rpcs = nil list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments @list_environments = ::Gapic::Config::Method.new list_environments_config get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment @get_environment = ::Gapic::Config::Method.new get_environment_config create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment @create_environment = ::Gapic::Config::Method.new create_environment_config update_environment_config = parent_rpcs.update_environment if parent_rpcs.respond_to? :update_environment @update_environment = ::Gapic::Config::Method.new update_environment_config delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment @delete_environment = ::Gapic::Config::Method.new delete_environment_config lookup_environment_history_config = parent_rpcs.lookup_environment_history if parent_rpcs.respond_to? :lookup_environment_history @lookup_environment_history = ::Gapic::Config::Method.new lookup_environment_history_config run_continuous_test_config = parent_rpcs.run_continuous_test if parent_rpcs.respond_to? :run_continuous_test @run_continuous_test = ::Gapic::Config::Method.new run_continuous_test_config list_continuous_test_results_config = parent_rpcs.list_continuous_test_results if parent_rpcs.respond_to? :list_continuous_test_results @list_continuous_test_results = ::Gapic::Config::Method.new list_continuous_test_results_config deploy_flow_config = parent_rpcs.deploy_flow if parent_rpcs.respond_to? :deploy_flow @deploy_flow = ::Gapic::Config::Method.new deploy_flow_config yield self if block_given? end end end end end end end end end end end