Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Tools::Client (v1.11.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Tools::Client.

Client for the Tools service.

Service for managing Tools.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Tools Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all Tools clients
::Google::Cloud::Dialogflow::CX::V3::Tools::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Tools 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
Returns

#create_tool

def create_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool
def create_tool(parent: nil, tool: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool

Creates a Tool in the specified agent.

Overloads 
def create_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool
Pass arguments to create_tool via a request object, either of type CreateToolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::CreateToolRequest, ::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_tool(parent: nil, tool: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool
Pass arguments to create_tool 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 agent to create a Tool for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
  • tool (::Google::Cloud::Dialogflow::CX::V3::Tool, ::Hash) — Required. The Tool to be created.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::CreateToolRequest.new

# Call the create_tool method.
result = client.create_tool request

# The returned object is of type Google::Cloud::Dialogflow::CX::V3::Tool.
p result

#create_tool_version

def create_tool_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::ToolVersion
def create_tool_version(parent: nil, tool_version: nil) -> ::Google::Cloud::Dialogflow::CX::V3::ToolVersion

Creates a version for the specified Tool.

Overloads 
def create_tool_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::ToolVersion
Pass arguments to create_tool_version via a request object, either of type CreateToolVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::CreateToolVersionRequest, ::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_tool_version(parent: nil, tool_version: nil) -> ::Google::Cloud::Dialogflow::CX::V3::ToolVersion
Pass arguments to create_tool_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 tool to create a version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
  • tool_version (::Google::Cloud::Dialogflow::CX::V3::ToolVersion, ::Hash) — Required. The tool version to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::CreateToolVersionRequest.new

# Call the create_tool_version method.
result = client.create_tool_version request

# The returned object is of type Google::Cloud::Dialogflow::CX::V3::ToolVersion.
p result

#delete_tool

def delete_tool(request, options = nil) -> ::Google::Protobuf::Empty
def delete_tool(name: nil, force: nil) -> ::Google::Protobuf::Empty

Deletes a specified Tool.

Overloads 
def delete_tool(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_tool via a request object, either of type DeleteToolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::DeleteToolRequest, ::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_tool(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_tool 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 name of the Tool to be deleted. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
  • force (::Boolean) —

    This field has no effect for Tools not being used. For Tools that are used:

    • If force is set to false, an error will be returned with message indicating the referenced resources.
    • If force is set to true, Dialogflow will remove the tool, as well as any references to the tool.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::DeleteToolRequest.new

# Call the delete_tool method.
result = client.delete_tool request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_tool_version

def delete_tool_version(request, options = nil) -> ::Google::Protobuf::Empty
def delete_tool_version(name: nil, force: nil) -> ::Google::Protobuf::Empty

Deletes the specified version of the Tool.

Overloads 
def delete_tool_version(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_tool_version via a request object, either of type DeleteToolVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::DeleteToolVersionRequest, ::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_tool_version(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_tool_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 name of the tool version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
  • force (::Boolean) —

    Optional. This field has no effect for Tools not being used. For Tools that are used:

    • If force is set to false, an error will be returned with message indicating the referenced resources.
    • If force is set to true, Dialogflow will remove the tool, as well as any references to the tool.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::DeleteToolVersionRequest.new

# Call the delete_tool_version method.
result = client.delete_tool_version request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_tool

def get_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool
def get_tool(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool

Retrieves the specified Tool.

Overloads 
def get_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool
Pass arguments to get_tool via a request object, either of type GetToolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::GetToolRequest, ::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_tool(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool
Pass arguments to get_tool 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 Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::GetToolRequest.new

# Call the get_tool method.
result = client.get_tool request

# The returned object is of type Google::Cloud::Dialogflow::CX::V3::Tool.
p result

#get_tool_version

def get_tool_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::ToolVersion
def get_tool_version(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::ToolVersion

Retrieves the specified version of the Tool.

Overloads 
def get_tool_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::ToolVersion
Pass arguments to get_tool_version via a request object, either of type GetToolVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::GetToolVersionRequest, ::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_tool_version(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::ToolVersion
Pass arguments to get_tool_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 tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::GetToolVersionRequest.new

# Call the get_tool_version method.
result = client.get_tool_version request

# The returned object is of type Google::Cloud::Dialogflow::CX::V3::ToolVersion.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new Tools client object.

Yields
  • (config) — Configure the Tools client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::CX::V3::Tools::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::CX::V3::Tools::Client.new do |config|
  config.timeout = 10.0
end

#list_tool_versions

def list_tool_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::ToolVersion>
def list_tool_versions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::ToolVersion>

List versions of the specified Tool.

Overloads 
def list_tool_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::ToolVersion>
Pass arguments to list_tool_versions via a request object, either of type ListToolVersionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::ListToolVersionsRequest, ::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_tool_versions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::ToolVersion>
Pass arguments to list_tool_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 parent of the tool versions. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
  • page_size (::Integer) — Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list request.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::ListToolVersionsRequest.new

# Call the list_tool_versions method.
result = client.list_tool_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::ToolVersion.
  p item
end

#list_tools

def list_tools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Tool>
def list_tools(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Tool>

Returns a list of Tools in the specified agent.

Overloads 
def list_tools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Tool>
Pass arguments to list_tools via a request object, either of type ListToolsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::ListToolsRequest, ::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_tools(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Tool>
Pass arguments to list_tools 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 agent to list the Tools from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
  • page_size (::Integer) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • 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
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::ListToolsRequest.new

# Call the list_tools method.
result = client.list_tools 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::Tool.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#restore_tool_version

def restore_tool_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::RestoreToolVersionResponse
def restore_tool_version(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::RestoreToolVersionResponse

Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources updated.

Overloads 
def restore_tool_version(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::RestoreToolVersionResponse
Pass arguments to restore_tool_version via a request object, either of type RestoreToolVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::RestoreToolVersionRequest, ::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 restore_tool_version(name: nil) -> ::Google::Cloud::Dialogflow::CX::V3::RestoreToolVersionResponse
Pass arguments to restore_tool_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 tool version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::RestoreToolVersionRequest.new

# Call the restore_tool_version method.
result = client.restore_tool_version request

# The returned object is of type Google::Cloud::Dialogflow::CX::V3::RestoreToolVersionResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_tool

def update_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool
def update_tool(tool: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool

Update the specified Tool.

Overloads 
def update_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool
Pass arguments to update_tool via a request object, either of type UpdateToolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::CX::V3::UpdateToolRequest, ::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_tool(tool: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::CX::V3::Tool
Pass arguments to update_tool 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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::Tools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::CX::V3::UpdateToolRequest.new

# Call the update_tool method.
result = client.update_tool request

# The returned object is of type Google::Cloud::Dialogflow::CX::V3::Tool.
p result