Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Versions::Client.
Client for the Versions service.
Service for managing Versions.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::ConfigurationConfigure the Versions Client class.
See Configuration for a description of the configuration fields.
Yields
- (config) — Configure the Client client.
Yield Parameter
- config (Client::Configuration)
Returns
Example # Modify the configuration for all Versions clients ::Google::Cloud::Dialogflow::CX::V3::Versions::Client.configure do |config| config.timeout = 10.0 end
#compare_versions
def compare_versions(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse def compare_versions(base_version: nil, target_version: nil, language_code: nil) -> ::Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponseCompares the specified base version with target version.
Overloads
def compare_versions(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse Pass arguments to
compare_versions via a request object, either of type CompareVersionsRequest or an equivalent Hash. Parameters
- request (::Google::Cloud::Dialogflow::CX::V3::CompareVersionsRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def compare_versions(base_version: nil, target_version: nil, language_code: nil) -> ::Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse Pass arguments to
compare_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). Parameters
- base_version (::String) — Required. Name of the base flow version to compare with the target version. Use version ID
0to indicate the draft version of the specified flow.Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>. - target_version (::String) — Required. Name of the target flow version to compare with the base version. Use version ID
0to indicate the draft version of the specified flow. Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>. - language_code (::String) — The language to compare the flow versions for.
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
Yields
- (response, operation) — Access the result along with the RPC operation
Yield Parameters
- response (::Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse)
- operation (::GRPC::ActiveCall::Operation)
Raises
Example - (::Google::Cloud::Error) — if the RPC is aborted.
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::Versions::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dialogflow::CX::V3::CompareVersionsRequest.new # Call the compare_versions method. result = client.compare_versions request # The returned object is of type Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse. p result
#configure
def configure() { |config| ... } -> Client::ConfigurationConfigure 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 Configuration for a description of the configuration fields.
Yields
- (config) — Configure the Client client.
Yield Parameter
- config (Client::Configuration)
Returns
#create_version
def create_version(request, options = nil) -> ::Gapic::Operation def create_version(parent: nil, version: nil) -> ::Gapic::OperationCreates a Version in the specified Flow.
This method is a long-running operation. The returned Operation type has the following method-specific fields:
metadata: CreateVersionOperationMetadataresponse: Version
Overloads
def create_version(request, options = nil) -> ::Gapic::Operation Pass arguments to
create_version via a request object, either of type CreateVersionRequest or an equivalent Hash. Parameters
- request (::Google::Cloud::Dialogflow::CX::V3::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_version(parent: nil, version: nil) -> ::Gapic::Operation 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). Parameters
- parent (::String) — Required. The Flow to create an Version for. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>. - version (::Google::Cloud::Dialogflow::CX::V3::Version, ::Hash) — Required. The version to create.
Yields
- (response, operation) — Access the result along with the RPC operation
Yield Parameters
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
Returns
- (::Gapic::Operation)
Raises
Example - (::Google::Cloud::Error) — if the RPC is aborted.
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::Versions::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dialogflow::CX::V3::CreateVersionRequest.new # Call the create_version method. result = client.create_version request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#delete_version
def delete_version(request, options = nil) -> ::Google::Protobuf::Empty def delete_version(name: nil) -> ::Google::Protobuf::EmptyDeletes the specified Version.
Overloads
def delete_version(request, options = nil) -> ::Google::Protobuf::Empty Pass arguments to
delete_version via a request object, either of type DeleteVersionRequest or an equivalent Hash. Parameters
- request (::Google::Cloud::Dialogflow::CX::V3::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_version(name: nil) -> ::Google::Protobuf::Empty 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). Parameter
- name (::String) — Required. The name of the Version to delete. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
Yields
- (response, operation) — Access the result along with the RPC operation
Yield Parameters
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
Returns
Raises
Example - (::Google::Cloud::Error) — if the RPC is aborted.
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::Versions::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dialogflow::CX::V3::DeleteVersionRequest.new # Call the delete_version method. result = client.delete_version request # The returned object is of type Google::Protobuf::Empty. p result
#get_version
def get_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Version def get_version(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::VersionRetrieves the specified Version.
Overloads
def get_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Version Pass arguments to
get_version via a request object, either of type GetVersionRequest or an equivalent Hash. Parameters
- request (::Google::Cloud::Dialogflow::CX::V3::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_version(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Version 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). Parameter
- name (::String) — Required. The name of the Version. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
Yields
- (response, operation) — Access the result along with the RPC operation
Yield Parameters
- response (::Google::Cloud::Dialogflow::CX::V3::Version)
- operation (::GRPC::ActiveCall::Operation)
Raises
Example - (::Google::Cloud::Error) — if the RPC is aborted.
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::Versions::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dialogflow::CX::V3::GetVersionRequest.new # Call the get_version method. result = client.get_version request # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Version. p result
#initialize
def initialize() { |config| ... } -> ClientCreate a new Versions client object.
Yields
- (config) — Configure the Versions client.
Yield Parameter
- config (Client::Configuration)
Returns
Example - (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Dialogflow::CX::V3::Versions::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Dialogflow::CX::V3::Versions::Client.new do |config| config.timeout = 10.0 end
#list_versions
def list_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Version> def list_versions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Version>Returns the list of all versions in the specified Flow.
Overloads
def list_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Version> Pass arguments to
list_versions via a request object, either of type ListVersionsRequest or an equivalent Hash. Parameters
- request (::Google::Cloud::Dialogflow::CX::V3::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_versions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Version> 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). Parameters
- parent (::String) — Required. The Flow to list all versions for. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>. - page_size (::Integer) — The maximum number of items to return in a single page. By default 20 and at most 100.
- page_token (::String) — The next_page_token value returned from a previous list request.
Yields
- (response, operation) — Access the result along with the RPC operation
Yield Parameters
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Version>)
- operation (::GRPC::ActiveCall::Operation)
Returns
- (::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Version>)
Raises
Example - (::Google::Cloud::Error) — if the RPC is aborted.
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::Versions::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dialogflow::CX::V3::ListVersionsRequest.new # Call the list_versions method. result = client.list_versions 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::Version. p item end
#load_version
def load_version(request, options = nil) -> ::Gapic::Operation def load_version(name: nil, allow_override_agent_resources: nil) -> ::Gapic::OperationLoads resources in the specified version to the draft flow.
This method is a long-running operation. The returned Operation type has the following method-specific fields:
metadata: An empty Struct messageresponse: An Empty message
Overloads
def load_version(request, options = nil) -> ::Gapic::Operation Pass arguments to
load_version via a request object, either of type LoadVersionRequest or an equivalent Hash. Parameters
- request (::Google::Cloud::Dialogflow::CX::V3::LoadVersionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def load_version(name: nil, allow_override_agent_resources: nil) -> ::Gapic::Operation Pass arguments to
load_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). Parameters
- name (::String) — Required. The Version to be loaded to draft flow. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>. - allow_override_agent_resources (::Boolean) — This field is used to prevent accidental overwrite of other agent resources, which can potentially impact other flow's behavior. If
allow_override_agent_resourcesis false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).
Yields
- (response, operation) — Access the result along with the RPC operation
Yield Parameters
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
Returns
- (::Gapic::Operation)
Raises
Example - (::Google::Cloud::Error) — if the RPC is aborted.
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::Versions::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dialogflow::CX::V3::LoadVersionRequest.new # Call the load_version method. result = client.load_version request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#location_client
def location_client() -> Google::Cloud::Location::Locations::ClientGet the associated client for mix-in of the Locations.
Returns
- (Google::Cloud::Location::Locations::Client)
#logger
def logger() -> LoggerThe logger used for request/response debug logging.
Returns
- (Logger)
#operations_client
def operations_client() -> ::Google::Cloud::Dialogflow::CX::V3::Versions::OperationsGet the associated client for long-running operations.
#universe_domain
def universe_domain() -> StringThe effective universe domain
Returns
- (String)
#update_version
def update_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Version def update_version(version: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::CX::V3::VersionUpdates the specified Version.
Overloads
def update_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Version Pass arguments to
update_version via a request object, either of type UpdateVersionRequest or an equivalent Hash. Parameters
- request (::Google::Cloud::Dialogflow::CX::V3::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_version(version: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Version 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). Parameters
- version (::Google::Cloud::Dialogflow::CX::V3::Version, ::Hash) — Required. The version to update.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The mask to control which fields get updated. Currently only
descriptionanddisplay_namecan be updated.
Yields
- (response, operation) — Access the result along with the RPC operation
Yield Parameters
- response (::Google::Cloud::Dialogflow::CX::V3::Version)
- operation (::GRPC::ActiveCall::Operation)
Raises
Example - (::Google::Cloud::Error) — if the RPC is aborted.
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::Versions::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dialogflow::CX::V3::UpdateVersionRequest.new # Call the update_version method. result = client.update_version request # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Version. p result