class Google::Cloud::Dialogflow::V2::Versions::Client
Client
for the Versions
service.
Service
for managing {::Google::Cloud::Dialogflow::V2::Version Versions}.
Attributes
@private
Public Class Methods
Configure the Versions
Client
class.
See {::Google::Cloud::Dialogflow::V2::Versions::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all Versions clients ::Google::Cloud::Dialogflow::V2::Versions::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/dialogflow/v2/versions/client.rb, line 56 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dialogflow", "V2"] 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
Create a new Versions
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Dialogflow::V2::Versions::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Dialogflow::V2::Versions::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the Versions
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/dialogflow/v2/versions/client.rb, line 114 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/dialogflow/v2/version_services_pb" # 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 @versions_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dialogflow::V2::Versions::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the Versions
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::V2::Versions::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/dialogflow/v2/versions/client.rb, line 93 def configure yield @config if block_given? @config end
Creates an agent version.
The new version points to the agent instance in the “default” environment.
@overload create_version
(request, options = nil)
Pass arguments to `create_version` via a request object, either of type {::Google::Cloud::Dialogflow::V2::CreateVersionRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::V2::CreateVersionRequest, ::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_version
(parent: nil, version: nil)
Pass arguments to `create_version` 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 create a version for. Supported formats: - `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent` @param version [::Google::Cloud::Dialogflow::V2::Version, ::Hash] Required. The version to create.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::V2::Version] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dialogflow::V2::Version]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/v2/versions/client.rb, line 340 def create_version request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::CreateVersionRequest # 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.create_version.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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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.create_version.timeout, metadata: metadata, retry_policy: @config.rpcs.create_version.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @versions_stub.call_rpc :create_version, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Delete the specified agent version.
@overload delete_version
(request, options = nil)
Pass arguments to `delete_version` via a request object, either of type {::Google::Cloud::Dialogflow::V2::DeleteVersionRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::V2::DeleteVersionRequest, ::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_version
(name: nil)
Pass arguments to `delete_version` 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 version to delete. Supported formats: - `projects/<Project ID>/agent/versions/<Version ID>` - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Protobuf::Empty]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/v2/versions/client.rb, line 492 def delete_version request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::DeleteVersionRequest # 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.delete_version.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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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.delete_version.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_version.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @versions_stub.call_rpc :delete_version, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Retrieves the specified agent version.
@overload get_version
(request, options = nil)
Pass arguments to `get_version` via a request object, either of type {::Google::Cloud::Dialogflow::V2::GetVersionRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::V2::GetVersionRequest, ::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_version
(name: nil)
Pass arguments to `get_version` 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 version. Supported formats: - `projects/<Project ID>/agent/versions/<Version ID>` - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::V2::Version] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dialogflow::V2::Version]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/v2/versions/client.rb, line 264 def get_version request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GetVersionRequest # 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.get_version.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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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.get_version.timeout, metadata: metadata, retry_policy: @config.rpcs.get_version.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @versions_stub.call_rpc :get_version, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Returns the list of all versions of the specified agent.
@overload list_versions
(request, options = nil)
Pass arguments to `list_versions` via a request object, either of type {::Google::Cloud::Dialogflow::V2::ListVersionsRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::V2::ListVersionsRequest, ::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_versions
(parent: nil, page_size: nil, page_token: nil)
Pass arguments to `list_versions` 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 versions from. Supported formats: - `projects/<Project ID>/agent` - `projects/<Project ID>/locations/<Location ID>/agent` @param page_size [::Integer] Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. @param page_token [::String] Optional. 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::V2::Version>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Version>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/v2/versions/client.rb, line 190 def list_versions request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ListVersionsRequest # 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_versions.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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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_versions.timeout, metadata: metadata, retry_policy: @config.rpcs.list_versions.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @versions_stub.call_rpc :list_versions, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @versions_stub, :list_versions, 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
Updates the specified agent version.
Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.
@overload update_version
(request, options = nil)
Pass arguments to `update_version` via a request object, either of type {::Google::Cloud::Dialogflow::V2::UpdateVersionRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::V2::UpdateVersionRequest, ::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_version
(version: nil, update_mask: nil)
Pass arguments to `update_version` 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 version [::Google::Cloud::Dialogflow::V2::Version, ::Hash] Required. The version to update. Supported formats: - `projects/<Project ID>/agent/versions/<Version ID>` - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>` @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Required. The mask to control which fields get updated.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::V2::Version] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dialogflow::V2::Version]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/v2/versions/client.rb, line 419 def update_version request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::UpdateVersionRequest # 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.update_version.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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "version.name" => request.version.name } 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.update_version.timeout, metadata: metadata, retry_policy: @config.rpcs.update_version.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @versions_stub.call_rpc :update_version, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end