Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::AgentService::Rest::Client (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::AgentService::Rest::Client.

REST client for the AgentService service.

The service that manages agent-related resources in Gemini Enterprise for Customer Engagement (CES).

Inherits

  • Object

Includes

Methods

.configure

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

Configure the AgentService 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 AgentService clients
::Google::Cloud::Ces::V1beta::AgentService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#batch_delete_conversations

def batch_delete_conversations(request, options = nil) -> ::Gapic::Operation
def batch_delete_conversations(parent: nil, conversations: nil) -> ::Gapic::Operation

Batch deletes the specified conversations.

Overloads 
def batch_delete_conversations(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_delete_conversations via a request object, either of type BatchDeleteConversationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::BatchDeleteConversationsRequest, ::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 batch_delete_conversations(parent: nil, conversations: nil) -> ::Gapic::Operation
Pass arguments to batch_delete_conversations 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 resource name of the app to delete conversations from. Format: projects/{project}/locations/{location}/apps/{app}
  • conversations (::Array<::String>) — Required. The resource names of the conversations to delete.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::BatchDeleteConversationsRequest.new

# Call the batch_delete_conversations method.
result = client.batch_delete_conversations 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

#configure

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

Configure the AgentService 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_agent

def create_agent(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Agent
def create_agent(parent: nil, agent_id: nil, agent: nil) -> ::Google::Cloud::Ces::V1beta::Agent

Creates a new agent in the given app.

Overloads 
def create_agent(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Agent
Pass arguments to create_agent via a request object, either of type CreateAgentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::CreateAgentRequest, ::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_agent(parent: nil, agent_id: nil, agent: nil) -> ::Google::Cloud::Ces::V1beta::Agent
Pass arguments to create_agent 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 resource name of the app to create an agent in.
  • agent_id (::String) — Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent.
  • agent (::Google::Cloud::Ces::V1beta::Agent, ::Hash) — Required. The agent to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateAgentRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Agent.
p result

#create_app

def create_app(request, options = nil) -> ::Gapic::Operation
def create_app(parent: nil, app_id: nil, app: nil) -> ::Gapic::Operation

Creates a new app in the given project and location.

Overloads 
def create_app(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_app via a request object, either of type CreateAppRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::CreateAppRequest, ::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_app(parent: nil, app_id: nil, app: nil) -> ::Gapic::Operation
Pass arguments to create_app 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 resource name of the location to create an app in.
  • app_id (::String) — Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app.
  • app (::Google::Cloud::Ces::V1beta::App, ::Hash) — Required. The app to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateAppRequest.new

# Call the create_app method.
result = client.create_app 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

#create_app_version

def create_app_version(request, options = nil) -> ::Google::Cloud::Ces::V1beta::AppVersion
def create_app_version(parent: nil, app_version_id: nil, app_version: nil) -> ::Google::Cloud::Ces::V1beta::AppVersion

Creates a new app version in the given app.

Overloads 
def create_app_version(request, options = nil) -> ::Google::Cloud::Ces::V1beta::AppVersion
Pass arguments to create_app_version via a request object, either of type CreateAppVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::CreateAppVersionRequest, ::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_app_version(parent: nil, app_version_id: nil, app_version: nil) -> ::Google::Cloud::Ces::V1beta::AppVersion
Pass arguments to create_app_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 resource name of the app to create an app version in.
  • app_version_id (::String) — Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
  • app_version (::Google::Cloud::Ces::V1beta::AppVersion, ::Hash) — Required. The app version to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateAppVersionRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::AppVersion.
p result

#create_deployment

def create_deployment(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Deployment
def create_deployment(parent: nil, deployment_id: nil, deployment: nil) -> ::Google::Cloud::Ces::V1beta::Deployment

Creates a new deployment in the given app.

Overloads 
def create_deployment(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Deployment
Pass arguments to create_deployment via a request object, either of type CreateDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::CreateDeploymentRequest, ::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_deployment(parent: nil, deployment_id: nil, deployment: nil) -> ::Google::Cloud::Ces::V1beta::Deployment
Pass arguments to create_deployment 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 app. Format: projects/{project}/locations/{location}/apps/{app}
  • deployment_id (::String) — Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment.
  • deployment (::Google::Cloud::Ces::V1beta::Deployment, ::Hash) — Required. The deployment to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateDeploymentRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Deployment.
p result

#create_example

def create_example(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Example
def create_example(parent: nil, example_id: nil, example: nil) -> ::Google::Cloud::Ces::V1beta::Example

Creates a new example in the given app.

Overloads 
def create_example(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Example
Pass arguments to create_example via a request object, either of type CreateExampleRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::CreateExampleRequest, ::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_example(parent: nil, example_id: nil, example: nil) -> ::Google::Cloud::Ces::V1beta::Example
Pass arguments to create_example 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 resource name of the app to create an example in.
  • example_id (::String) — Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example.
  • example (::Google::Cloud::Ces::V1beta::Example, ::Hash) — Required. The example to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateExampleRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Example.
p result

#create_guardrail

def create_guardrail(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Guardrail
def create_guardrail(parent: nil, guardrail_id: nil, guardrail: nil) -> ::Google::Cloud::Ces::V1beta::Guardrail

Creates a new guardrail in the given app.

Overloads 
def create_guardrail(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Guardrail
Pass arguments to create_guardrail via a request object, either of type CreateGuardrailRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::CreateGuardrailRequest, ::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_guardrail(parent: nil, guardrail_id: nil, guardrail: nil) -> ::Google::Cloud::Ces::V1beta::Guardrail
Pass arguments to create_guardrail 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 resource name of the app to create a guardrail in.
  • guardrail_id (::String) — Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail.
  • guardrail (::Google::Cloud::Ces::V1beta::Guardrail, ::Hash) — Required. The guardrail to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateGuardrailRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Guardrail.
p result

#create_tool

def create_tool(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Tool
def create_tool(parent: nil, tool_id: nil, tool: nil) -> ::Google::Cloud::Ces::V1beta::Tool

Creates a new tool in the given app.

Overloads 
def create_tool(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Tool
Pass arguments to create_tool via a request object, either of type CreateToolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::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_id: nil, tool: nil) -> ::Google::Cloud::Ces::V1beta::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 resource name of the app to create a tool in.
  • tool_id (::String) — Optional. The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
  • tool (::Google::Cloud::Ces::V1beta::Tool, ::Hash) — Required. The tool to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateToolRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Tool.
p result

#create_toolset

def create_toolset(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Toolset
def create_toolset(parent: nil, toolset_id: nil, toolset: nil) -> ::Google::Cloud::Ces::V1beta::Toolset

Creates a new toolset in the given app.

Overloads 
def create_toolset(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Toolset
Pass arguments to create_toolset via a request object, either of type CreateToolsetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::CreateToolsetRequest, ::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_toolset(parent: nil, toolset_id: nil, toolset: nil) -> ::Google::Cloud::Ces::V1beta::Toolset
Pass arguments to create_toolset 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 resource name of the app to create a toolset in.
  • toolset_id (::String) — Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset.
  • toolset (::Google::Cloud::Ces::V1beta::Toolset, ::Hash) — Required. The toolset to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateToolsetRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Toolset.
p result

#delete_agent

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

Deletes the specified agent.

Overloads 
def delete_agent(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_agent via a request object, either of type DeleteAgentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::DeleteAgentRequest, ::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_agent(name: nil, force: nil, etag: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_agent 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 resource name of the agent to delete.
  • force (::Boolean) —

    Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples.

    • If force = false, the deletion fails if other agents/examples reference it.
    • If force = true, delete the agent and remove it from all referencing apps/agents/examples.
  • etag (::String) — Optional. The current etag of the agent. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the agent, deletion will be blocked and an ABORTED error will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteAgentRequest.new

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

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

#delete_app

def delete_app(request, options = nil) -> ::Gapic::Operation
def delete_app(name: nil, etag: nil) -> ::Gapic::Operation

Deletes the specified app.

Overloads 
def delete_app(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_app via a request object, either of type DeleteAppRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::DeleteAppRequest, ::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_app(name: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_app 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 resource name of the app to delete.
  • etag (::String) — Optional. The current etag of the app. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app, deletion will be blocked and an ABORTED error will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteAppRequest.new

# Call the delete_app method.
result = client.delete_app 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_app_version

def delete_app_version(request, options = nil) -> ::Google::Protobuf::Empty
def delete_app_version(name: nil, etag: nil) -> ::Google::Protobuf::Empty

Deletes the specified app version.

Overloads 
def delete_app_version(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_app_version via a request object, either of type DeleteAppVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::DeleteAppVersionRequest, ::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_app_version(name: nil, etag: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_app_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 resource name of the app version to delete.
  • etag (::String) — Optional. The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteAppVersionRequest.new

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

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

#delete_conversation

def delete_conversation(request, options = nil) -> ::Google::Protobuf::Empty
def delete_conversation(name: nil, source: nil) -> ::Google::Protobuf::Empty

Deletes the specified conversation.

Overloads 
def delete_conversation(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_conversation via a request object, either of type DeleteConversationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::DeleteConversationRequest, ::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_conversation(name: nil, source: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_conversation 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteConversationRequest.new

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

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

#delete_deployment

def delete_deployment(request, options = nil) -> ::Google::Protobuf::Empty
def delete_deployment(name: nil, etag: nil) -> ::Google::Protobuf::Empty

Deletes the specified deployment.

Overloads 
def delete_deployment(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_deployment via a request object, either of type DeleteDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::DeleteDeploymentRequest, ::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_deployment(name: nil, etag: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_deployment 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 deployment to delete. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
  • etag (::String) — Optional. The etag of the deployment. If an etag is provided and does not match the current etag of the deployment, deletion will be blocked and an ABORTED error will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteDeploymentRequest.new

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

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

#delete_example

def delete_example(request, options = nil) -> ::Google::Protobuf::Empty
def delete_example(name: nil, etag: nil) -> ::Google::Protobuf::Empty

Deletes the specified example.

Overloads 
def delete_example(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_example via a request object, either of type DeleteExampleRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::DeleteExampleRequest, ::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_example(name: nil, etag: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_example 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 resource name of the example to delete.
  • etag (::String) — Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteExampleRequest.new

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

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

#delete_guardrail

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

Deletes the specified guardrail.

Overloads 
def delete_guardrail(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_guardrail via a request object, either of type DeleteGuardrailRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::DeleteGuardrailRequest, ::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_guardrail(name: nil, force: nil, etag: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_guardrail 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 resource name of the guardrail to delete.
  • force (::Boolean) —

    Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents.

    • If force = false, the deletion fails if any apps/agents still reference the guardrail.
    • If force = true, all existing references from apps/agents will be removed and the guardrail will be deleted.
  • etag (::String) — Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteGuardrailRequest.new

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

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

#delete_tool

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

Deletes the 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::Ces::V1beta::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, etag: 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 resource name of the tool to delete.
  • force (::Boolean) —

    Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples.

    • If force = false, the deletion will fail if any agents still reference the tool.
    • If force = true, all existing references from agents will be removed and the tool will be deleted.
  • etag (::String) — Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteToolRequest.new

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

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

#delete_toolset

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

Deletes the specified toolset.

Overloads 
def delete_toolset(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_toolset via a request object, either of type DeleteToolsetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::DeleteToolsetRequest, ::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_toolset(name: nil, force: nil, etag: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_toolset 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 resource name of the toolset to delete.
  • force (::Boolean) —

    Optional. Indicates whether to forcefully delete the toolset, even if it is still referenced by app/agents.

    • If force = false, the deletion fails if any agents still reference the toolset.
    • If force = true, all existing references from agents will be removed and the toolset will be deleted.
  • etag (::String) — Optional. The current etag of the toolset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the toolset, deletion will be blocked and an ABORTED error will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteToolsetRequest.new

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

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

#export_app

def export_app(request, options = nil) -> ::Gapic::Operation
def export_app(name: nil, export_format: nil, gcs_uri: nil, app_version: nil) -> ::Gapic::Operation

Exports the specified app.

Overloads 
def export_app(request, options = nil) -> ::Gapic::Operation
Pass arguments to export_app via a request object, either of type ExportAppRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ExportAppRequest, ::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 export_app(name: nil, export_format: nil, gcs_uri: nil, app_version: nil) -> ::Gapic::Operation
Pass arguments to export_app 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 resource name of the app to export.
  • export_format (::Google::Cloud::Ces::V1beta::ExportAppRequest::ExportFormat) — Required. The format to export the app in.
  • gcs_uri (::String) — Optional. The Google Cloud Storage URI to which to export the app. The format of this URI must be gs://<bucket-name>/<object-name>. The exported app archive will be written directly to the specified GCS object.
  • app_version (::String) — Optional. The resource name of the app version to export. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ExportAppRequest.new

# Call the export_app method.
result = client.export_app 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

#generate_app_resource

def generate_app_resource(request, options = nil) -> ::Gapic::Operation
def generate_app_resource(agent: nil, tool: nil, toolset: nil, parent: nil, refine_instructions: nil, tool_generation_config: nil, app_generation_config: nil, evaluation_generation_config: nil, evaluation_personas_generation_config: nil, quality_report_generation_config: nil, hill_climbing_fix_config: nil) -> ::Gapic::Operation

Generates specific resources (e.g. agent) in the app using LLM assistant.

Overloads 
def generate_app_resource(request, options = nil) -> ::Gapic::Operation
Pass arguments to generate_app_resource via a request object, either of type GenerateAppResourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GenerateAppResourceRequest, ::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 generate_app_resource(agent: nil, tool: nil, toolset: nil, parent: nil, refine_instructions: nil, tool_generation_config: nil, app_generation_config: nil, evaluation_generation_config: nil, evaluation_personas_generation_config: nil, quality_report_generation_config: nil, hill_climbing_fix_config: nil) -> ::Gapic::Operation
Pass arguments to generate_app_resource 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GenerateAppResourceRequest.new

# Call the generate_app_resource method.
result = client.generate_app_resource 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

#get_agent

def get_agent(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Agent
def get_agent(name: nil) -> ::Google::Cloud::Ces::V1beta::Agent

Gets details of the specified agent.

Overloads 
def get_agent(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Agent
Pass arguments to get_agent via a request object, either of type GetAgentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetAgentRequest, ::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_agent(name: nil) -> ::Google::Cloud::Ces::V1beta::Agent
Pass arguments to get_agent 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 resource name of the agent to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetAgentRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Agent.
p result

#get_app

def get_app(request, options = nil) -> ::Google::Cloud::Ces::V1beta::App
def get_app(name: nil) -> ::Google::Cloud::Ces::V1beta::App

Gets details of the specified app.

Overloads 
def get_app(request, options = nil) -> ::Google::Cloud::Ces::V1beta::App
Pass arguments to get_app via a request object, either of type GetAppRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetAppRequest, ::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_app(name: nil) -> ::Google::Cloud::Ces::V1beta::App
Pass arguments to get_app 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 resource name of the app to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetAppRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::App.
p result

#get_app_version

def get_app_version(request, options = nil) -> ::Google::Cloud::Ces::V1beta::AppVersion
def get_app_version(name: nil) -> ::Google::Cloud::Ces::V1beta::AppVersion

Gets details of the specified app version.

Overloads 
def get_app_version(request, options = nil) -> ::Google::Cloud::Ces::V1beta::AppVersion
Pass arguments to get_app_version via a request object, either of type GetAppVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetAppVersionRequest, ::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_app_version(name: nil) -> ::Google::Cloud::Ces::V1beta::AppVersion
Pass arguments to get_app_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 resource name of the app version to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetAppVersionRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::AppVersion.
p result

#get_changelog

def get_changelog(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Changelog
def get_changelog(name: nil) -> ::Google::Cloud::Ces::V1beta::Changelog

Gets the specified changelog.

Overloads 
def get_changelog(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Changelog
Pass arguments to get_changelog via a request object, either of type GetChangelogRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetChangelogRequest, ::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_changelog(name: nil) -> ::Google::Cloud::Ces::V1beta::Changelog
Pass arguments to get_changelog 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 resource name of the changelog to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetChangelogRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Changelog.
p result

#get_conversation

def get_conversation(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Conversation
def get_conversation(name: nil, source: nil) -> ::Google::Cloud::Ces::V1beta::Conversation

Gets details of the specified conversation.

Overloads 
def get_conversation(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Conversation
Pass arguments to get_conversation via a request object, either of type GetConversationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetConversationRequest, ::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_conversation(name: nil, source: nil) -> ::Google::Cloud::Ces::V1beta::Conversation
Pass arguments to get_conversation 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetConversationRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Conversation.
p result

#get_deployment

def get_deployment(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Deployment
def get_deployment(name: nil) -> ::Google::Cloud::Ces::V1beta::Deployment

Gets details of the specified deployment.

Overloads 
def get_deployment(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Deployment
Pass arguments to get_deployment via a request object, either of type GetDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetDeploymentRequest, ::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_deployment(name: nil) -> ::Google::Cloud::Ces::V1beta::Deployment
Pass arguments to get_deployment 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 deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetDeploymentRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Deployment.
p result

#get_example

def get_example(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Example
def get_example(name: nil) -> ::Google::Cloud::Ces::V1beta::Example

Gets details of the specified example.

Overloads 
def get_example(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Example
Pass arguments to get_example via a request object, either of type GetExampleRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetExampleRequest, ::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_example(name: nil) -> ::Google::Cloud::Ces::V1beta::Example
Pass arguments to get_example 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 resource name of the example to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetExampleRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Example.
p result

#get_guardrail

def get_guardrail(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Guardrail
def get_guardrail(name: nil) -> ::Google::Cloud::Ces::V1beta::Guardrail

Gets details of the specified guardrail.

Overloads 
def get_guardrail(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Guardrail
Pass arguments to get_guardrail via a request object, either of type GetGuardrailRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetGuardrailRequest, ::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_guardrail(name: nil) -> ::Google::Cloud::Ces::V1beta::Guardrail
Pass arguments to get_guardrail 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 resource name of the guardrail to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetGuardrailRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Guardrail.
p result

#get_security_settings

def get_security_settings(request, options = nil) -> ::Google::Cloud::Ces::V1beta::SecuritySettings
def get_security_settings(name: nil) -> ::Google::Cloud::Ces::V1beta::SecuritySettings

Retrieves the security settings for the project and location.

Overloads 
def get_security_settings(request, options = nil) -> ::Google::Cloud::Ces::V1beta::SecuritySettings
Pass arguments to get_security_settings via a request object, either of type GetSecuritySettingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetSecuritySettingsRequest, ::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_security_settings(name: nil) -> ::Google::Cloud::Ces::V1beta::SecuritySettings
Pass arguments to get_security_settings 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 resource name of the security settings to retrieve. Format: projects/{project}/locations/{location}/securitySettings
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetSecuritySettingsRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::SecuritySettings.
p result

#get_tool

def get_tool(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Tool
def get_tool(name: nil) -> ::Google::Cloud::Ces::V1beta::Tool

Gets details of the specified tool.

Overloads 
def get_tool(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Tool
Pass arguments to get_tool via a request object, either of type GetToolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::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::Ces::V1beta::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 resource name of the tool to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetToolRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Tool.
p result

#get_toolset

def get_toolset(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Toolset
def get_toolset(name: nil) -> ::Google::Cloud::Ces::V1beta::Toolset

Gets details of the specified toolset.

Overloads 
def get_toolset(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Toolset
Pass arguments to get_toolset via a request object, either of type GetToolsetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::GetToolsetRequest, ::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_toolset(name: nil) -> ::Google::Cloud::Ces::V1beta::Toolset
Pass arguments to get_toolset 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 resource name of the toolset to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetToolsetRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Toolset.
p result

#import_app

def import_app(request, options = nil) -> ::Gapic::Operation
def import_app(gcs_uri: nil, app_content: nil, parent: nil, display_name: nil, app_id: nil, import_options: nil, ignore_app_lock: nil) -> ::Gapic::Operation

Imports the specified app.

Overloads 
def import_app(request, options = nil) -> ::Gapic::Operation
Pass arguments to import_app via a request object, either of type ImportAppRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ImportAppRequest, ::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 import_app(gcs_uri: nil, app_content: nil, parent: nil, display_name: nil, app_id: nil, import_options: nil, ignore_app_lock: nil) -> ::Gapic::Operation
Pass arguments to import_app 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
  • gcs_uri (::String) — The Google Cloud Storage URI from which to import app. The format of this URI must be gs://<bucket-name>/<object-name>.

    Note: The following parameters are mutually exclusive: gcs_uri, app_content. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • app_content (::String) — Raw bytes representing the compressed zip file with the app folder structure.

    Note: The following parameters are mutually exclusive: app_content, gcs_uri. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • parent (::String) — Required. The parent resource name with the location of the app to import.
  • display_name (::String) —

    Optional. The display name of the app to import.

    • If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique.
    • If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.
  • app_id (::String) —

    Optional. The ID to use for the imported app.

    • If not specified, a unique ID will be automatically assigned for the app.
    • Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.
  • import_options (::Google::Cloud::Ces::V1beta::ImportAppRequest::ImportOptions, ::Hash) — Optional. Options governing the import process for the app.
  • ignore_app_lock (::Boolean) — Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ImportAppRequest.new

# Call the import_app method.
result = client.import_app 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

#initialize

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

Create a new AgentService REST client object.

Yields
  • (config) — Configure the AgentService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_agents

def list_agents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Agent>
def list_agents(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Agent>

Lists agents in the given app.

Overloads 
def list_agents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Agent>
Pass arguments to list_agents via a request object, either of type ListAgentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ListAgentsRequest, ::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_agents(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Agent>
Pass arguments to list_agents 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 resource name of the app to list agents from.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.
  • filter (::String) — Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details.
  • order_by (::String) — Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListAgentsRequest.new

# Call the list_agents method.
result = client.list_agents 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::Ces::V1beta::Agent.
  p item
end

#list_app_versions

def list_app_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::AppVersion>
def list_app_versions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::AppVersion>

Lists all app versions in the given app.

Overloads 
def list_app_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::AppVersion>
Pass arguments to list_app_versions via a request object, either of type ListAppVersionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ListAppVersionsRequest, ::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_app_versions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::AppVersion>
Pass arguments to list_app_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 resource name of the app to list app versions from.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call.
  • filter (::String) — Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details.
  • order_by (::String) — Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListAppVersionsRequest.new

# Call the list_app_versions method.
result = client.list_app_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::Ces::V1beta::AppVersion.
  p item
end

#list_apps

def list_apps(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::App>
def list_apps(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::App>

Lists apps in the given project and location.

Overloads 
def list_apps(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::App>
Pass arguments to list_apps via a request object, either of type ListAppsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ListAppsRequest, ::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_apps(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::App>
Pass arguments to list_apps 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 resource name of the location to list apps from.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list AgentService.ListApps call.
  • filter (::String) — Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details.
  • order_by (::String) — Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListAppsRequest.new

# Call the list_apps method.
result = client.list_apps 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::Ces::V1beta::App.
  p item
end

#list_changelogs

def list_changelogs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Changelog>
def list_changelogs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Changelog>

Lists the changelogs of the specified app.

Overloads 
def list_changelogs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Changelog>
Pass arguments to list_changelogs via a request object, either of type ListChangelogsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ListChangelogsRequest, ::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_changelogs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Changelog>
Pass arguments to list_changelogs 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 resource name of the app to list changelogs from.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list AgentService.ListChangelogs call.
  • filter (::String) —

    Optional. Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details.

    The filter string can be used to filter by action, resource_type, resource_name, author, and create_time. The : comparator can be used for case-insensitive partial matching on string fields, while = performs an exact case-sensitive match.

    Examples:

    • action:update (case-insensitive partial match)
    • action="Create" (case-sensitive exact match)
    • resource_type:agent
    • resource_name:my-agent
    • author:me@example.com
    • create_time > "2025-01-01T00:00:00Z"
    • create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool
  • order_by (::String) — Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListChangelogsRequest.new

# Call the list_changelogs method.
result = client.list_changelogs 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::Ces::V1beta::Changelog.
  p item
end

#list_conversations

def list_conversations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Conversation>
def list_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil, source: nil, sources: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Conversation>

Lists conversations in the given app.

Overloads 
def list_conversations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Conversation>
Pass arguments to list_conversations via a request object, either of type ListConversationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ListConversationsRequest, ::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_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil, source: nil, sources: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Conversation>
Pass arguments to list_conversations 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 resource name of the app to list conversations from.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.
  • filter (::String) — Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.
  • source (::Google::Cloud::Ces::V1beta::Conversation::Source) — Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of sources field.
  • sources (::Array<::Google::Cloud::Ces::V1beta::Conversation::Source>) — Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListConversationsRequest.new

# Call the list_conversations method.
result = client.list_conversations 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::Ces::V1beta::Conversation.
  p item
end

#list_deployments

def list_deployments(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Deployment>
def list_deployments(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Deployment>

Lists deployments in the given app.

Overloads 
def list_deployments(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Deployment>
Pass arguments to list_deployments via a request object, either of type ListDeploymentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ListDeploymentsRequest, ::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_deployments(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Deployment>
Pass arguments to list_deployments 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 app. Format: projects/{project}/locations/{location}/apps/{app}
  • page_size (::Integer) — Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A page token, received from a previous ListDeployments call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListDeployments must match the call that provided the page token.

  • order_by (::String) — Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListDeploymentsRequest.new

# Call the list_deployments method.
result = client.list_deployments 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::Ces::V1beta::Deployment.
  p item
end

#list_examples

def list_examples(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Example>
def list_examples(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Example>

Lists examples in the given app.

Overloads 
def list_examples(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Example>
Pass arguments to list_examples via a request object, either of type ListExamplesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ListExamplesRequest, ::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_examples(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Example>
Pass arguments to list_examples 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 resource name of the app to list examples from.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list AgentService.ListExamples call.
  • filter (::String) — Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.
  • order_by (::String) — Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListExamplesRequest.new

# Call the list_examples method.
result = client.list_examples 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::Ces::V1beta::Example.
  p item
end

#list_guardrails

def list_guardrails(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Guardrail>
def list_guardrails(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Guardrail>

Lists guardrails in the given app.

Overloads 
def list_guardrails(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Guardrail>
Pass arguments to list_guardrails via a request object, either of type ListGuardrailsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ListGuardrailsRequest, ::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_guardrails(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Guardrail>
Pass arguments to list_guardrails 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 resource name of the app to list guardrails from.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call.
  • filter (::String) — Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details.
  • order_by (::String) — Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListGuardrailsRequest.new

# Call the list_guardrails method.
result = client.list_guardrails 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::Ces::V1beta::Guardrail.
  p item
end

#list_tools

def list_tools(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Tool>
def list_tools(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Tool>

Lists tools in the given app.

Overloads 
def list_tools(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Tool>
Pass arguments to list_tools via a request object, either of type ListToolsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::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, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::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 resource name of the app to list tools from.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list AgentService.ListTools call.
  • filter (::String) — Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details.
  • order_by (::String) — Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::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::Ces::V1beta::Tool.
  p item
end

#list_toolsets

def list_toolsets(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Toolset>
def list_toolsets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Toolset>

Lists toolsets in the given app.

Overloads 
def list_toolsets(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Toolset>
Pass arguments to list_toolsets via a request object, either of type ListToolsetsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::ListToolsetsRequest, ::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_toolsets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Toolset>
Pass arguments to list_toolsets 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 resource name of the app to list toolsets from.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list AgentService.ListToolsets call.
  • filter (::String) — Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details.
  • order_by (::String) — Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListToolsetsRequest.new

# Call the list_toolsets method.
result = client.list_toolsets 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::Ces::V1beta::Toolset.
  p item
end

#location_client

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

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

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::Ces::V1beta::AgentService::Rest::Operations

Get the associated client for long-running operations.

Returns

#restore_app_version

def restore_app_version(request, options = nil) -> ::Gapic::Operation
def restore_app_version(name: nil) -> ::Gapic::Operation

Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.

Overloads 
def restore_app_version(request, options = nil) -> ::Gapic::Operation
Pass arguments to restore_app_version via a request object, either of type RestoreAppVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::RestoreAppVersionRequest, ::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_app_version(name: nil) -> ::Gapic::Operation
Pass arguments to restore_app_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 resource name of the app version to restore.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::RestoreAppVersionRequest.new

# Call the restore_app_version method.
result = client.restore_app_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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_agent

def update_agent(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Agent
def update_agent(agent: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Agent

Updates the specified agent.

Overloads 
def update_agent(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Agent
Pass arguments to update_agent via a request object, either of type UpdateAgentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::UpdateAgentRequest, ::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_agent(agent: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Agent
Pass arguments to update_agent 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateAgentRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Agent.
p result

#update_app

def update_app(request, options = nil) -> ::Google::Cloud::Ces::V1beta::App
def update_app(app: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::App

Updates the specified app.

Overloads 
def update_app(request, options = nil) -> ::Google::Cloud::Ces::V1beta::App
Pass arguments to update_app via a request object, either of type UpdateAppRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::UpdateAppRequest, ::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_app(app: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::App
Pass arguments to update_app 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateAppRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::App.
p result

#update_deployment

def update_deployment(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Deployment
def update_deployment(deployment: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Deployment

Updates the specified deployment.

Overloads 
def update_deployment(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Deployment
Pass arguments to update_deployment via a request object, either of type UpdateDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::UpdateDeploymentRequest, ::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_deployment(deployment: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Deployment
Pass arguments to update_deployment 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateDeploymentRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Deployment.
p result

#update_example

def update_example(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Example
def update_example(example: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Example

Updates the specified example.

Overloads 
def update_example(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Example
Pass arguments to update_example via a request object, either of type UpdateExampleRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::UpdateExampleRequest, ::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_example(example: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Example
Pass arguments to update_example 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateExampleRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Example.
p result

#update_guardrail

def update_guardrail(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Guardrail
def update_guardrail(guardrail: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Guardrail

Updates the specified guardrail.

Overloads 
def update_guardrail(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Guardrail
Pass arguments to update_guardrail via a request object, either of type UpdateGuardrailRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::UpdateGuardrailRequest, ::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_guardrail(guardrail: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Guardrail
Pass arguments to update_guardrail 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateGuardrailRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Guardrail.
p result

#update_security_settings

def update_security_settings(request, options = nil) -> ::Google::Cloud::Ces::V1beta::SecuritySettings
def update_security_settings(security_settings: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::SecuritySettings

Updates the security settings for the project and location.

Overloads 
def update_security_settings(request, options = nil) -> ::Google::Cloud::Ces::V1beta::SecuritySettings
Pass arguments to update_security_settings via a request object, either of type UpdateSecuritySettingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::UpdateSecuritySettingsRequest, ::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_security_settings(security_settings: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::SecuritySettings
Pass arguments to update_security_settings 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateSecuritySettingsRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::SecuritySettings.
p result

#update_tool

def update_tool(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Tool
def update_tool(tool: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Tool

Updates the specified tool.

Overloads 
def update_tool(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Tool
Pass arguments to update_tool via a request object, either of type UpdateToolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::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::Ces::V1beta::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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateToolRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Tool.
p result

#update_toolset

def update_toolset(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Toolset
def update_toolset(toolset: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Toolset

Updates the specified toolset.

Overloads 
def update_toolset(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Toolset
Pass arguments to update_toolset via a request object, either of type UpdateToolsetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Ces::V1beta::UpdateToolsetRequest, ::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_toolset(toolset: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Toolset
Pass arguments to update_toolset 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::AgentService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateToolsetRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Toolset.
p result