Class: Google::Apis::CesV1::CustomerEngagementSuiteService

Inherits:

Google::Apis::Core::BaseService

• Object
• Google::Apis::Core::BaseService
• Google::Apis::CesV1::CustomerEngagementSuiteService

Defined in:

lib/google/apis/ces_v1/service.rb

Overview

Gemini Enterprise for Customer Experience API

Examples:

require 'google/apis/ces_v1'

Ces = Google::Apis::CesV1 # Alias the module
service = Ces::CustomerEngagementSuiteService.new

See Also:

• https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps

Constant Summary

DEFAULT_ENDPOINT_TEMPLATE =

"https://ces.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary

• #key ⇒ String

  API key.

• #quota_user ⇒ String

  Available to use for quota purposes for server-side applications.

Instance Method Summary

• #batch_delete_conversations(parent, batch_delete_conversations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

  Batch deletes the specified conversations.

• #cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Starts asynchronous cancellation on a long-running operation.

• #create_project_location_app(parent, app_object = nil, app_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

  Creates a new app in the given project and location.

• #create_project_location_app_agent(parent, agent_object = nil, agent_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Agent

  Creates a new agent in the given app.

• #create_project_location_app_deployment(parent, deployment_object = nil, deployment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Deployment

  Creates a new deployment in the given app.

• #create_project_location_app_example(parent, example_object = nil, example_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Example

  Creates a new example in the given app.

• #create_project_location_app_guardrail(parent, guardrail_object = nil, guardrail_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Guardrail

  Creates a new guardrail in the given app.

• #create_project_location_app_tool(parent, tool_object = nil, tool_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Tool

  Creates a new tool in the given app.

• #create_project_location_app_toolset(parent, toolset_object = nil, toolset_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Toolset

  Creates a new toolset in the given app.

• #create_project_location_app_version(parent, app_version_object = nil, app_version_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::AppVersion

  Creates a new app version in the given app.

• #delete_project_location_app(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

  Deletes the specified app.

• #delete_project_location_app_agent(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Deletes the specified agent.

• #delete_project_location_app_conversation(name, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Deletes the specified conversation.

• #delete_project_location_app_deployment(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Deletes the specified deployment.

• #delete_project_location_app_example(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Deletes the specified example.

• #delete_project_location_app_guardrail(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Deletes the specified guardrail.

• #delete_project_location_app_tool(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Deletes the specified tool.

• #delete_project_location_app_toolset(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Deletes the specified toolset.

• #delete_project_location_app_version(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Deletes the specified app version.

• #delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

  Deletes a long-running operation.

• #execute_app_tool(parent, execute_tool_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ExecuteToolResponse

  Executes the given tool with the given arguments.

• #export_app(name, export_app_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

  Exports the specified app.

• #generate_session_chat_token(name, generate_chat_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::GenerateChatTokenResponse

  Generates a session scoped token for chat widget to authenticate with Session APIs.

• #get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Location

  Gets information about a location.

• #get_project_location_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::App

  Gets details of the specified app.

• #get_project_location_app_agent(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Agent

  Gets details of the specified agent.

• #get_project_location_app_changelog(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Changelog

  Gets the specified changelog.

• #get_project_location_app_conversation(name, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Conversation

  Gets details of the specified conversation.

• #get_project_location_app_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Deployment

  Gets details of the specified deployment.

• #get_project_location_app_deployment_extended_agent_card(tenant, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1AgentCard

  Gets the extended agent card for the authenticated agent.

• #get_project_location_app_example(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Example

  Gets details of the specified example.

• #get_project_location_app_extended_agent_card(tenant, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1AgentCard

  Gets the extended agent card for the authenticated agent.

• #get_project_location_app_guardrail(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Guardrail

  Gets details of the specified guardrail.

• #get_project_location_app_tool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Tool

  Gets details of the specified tool.

• #get_project_location_app_toolset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Toolset

  Gets details of the specified toolset.

• #get_project_location_app_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::AppVersion

  Gets details of the specified app version.

• #get_project_location_app_version_extended_agent_card(tenant, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1AgentCard

  Gets the extended agent card for the authenticated agent.

• #get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

  Gets the latest state of a long-running operation.

• #import_app(parent, import_app_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

  Imports the specified app.

• #initialize ⇒ CustomerEngagementSuiteService constructor

  A new instance of CustomerEngagementSuiteService.

• #list_project_location_app_agents(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListAgentsResponse

  Lists agents in the given app.

• #list_project_location_app_changelogs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListChangelogsResponse

  Lists the changelogs of the specified app.

• #list_project_location_app_conversations(parent, filter: nil, page_size: nil, page_token: nil, source: nil, sources: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListConversationsResponse

  Lists conversations in the given app.

• #list_project_location_app_deployments(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListDeploymentsResponse

  Lists deployments in the given app.

• #list_project_location_app_examples(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListExamplesResponse

  Lists examples in the given app.

• #list_project_location_app_guardrails(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListGuardrailsResponse

  Lists guardrails in the given app.

• #list_project_location_app_tools(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListToolsResponse

  Lists tools in the given app.

• #list_project_location_app_toolsets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListToolsetsResponse

  Lists toolsets in the given app.

• #list_project_location_app_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListAppVersionsResponse

  Lists all app versions in the given app.

• #list_project_location_apps(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListAppsResponse

  Lists apps in the given project and location.

• #list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListOperationsResponse

  Lists operations that match the specified filter in the request.

• #list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListLocationsResponse

  Lists information about the supported locations for this service.

• #patch_project_location_app(name, app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::App

  Updates the specified app.

• #patch_project_location_app_agent(name, agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Agent

  Updates the specified agent.

• #patch_project_location_app_deployment(name, deployment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Deployment

  Updates the specified deployment.

• #patch_project_location_app_example(name, example_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Example

  Updates the specified example.

• #patch_project_location_app_guardrail(name, guardrail_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Guardrail

  Updates the specified guardrail.

• #patch_project_location_app_tool(name, tool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Tool

  Updates the specified tool.

• #patch_project_location_app_toolset(name, toolset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Toolset

  Updates the specified toolset.

• #restore_app_version(name, restore_app_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

  Restores the specified app version.

• #retrieve_app_tool_schema(parent, retrieve_tool_schema_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::RetrieveToolSchemaResponse

  Retrieve the schema of the given tool.

• #retrieve_toolset_tools(toolset, retrieve_tools_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::RetrieveToolsResponse

  Retrieve the list of tools included in the specified toolset.

• #run_session(session, run_session_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::RunSessionResponse

  Initiates a single-turn interaction with the CES agent within a session.

• #send_project_location_app_deployment_message(tenant, lf_a2a_v1_send_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1SendMessageResponse

  Sends a message to an agent.

• #send_project_location_app_message(tenant, lf_a2a_v1_send_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1SendMessageResponse

  Sends a message to an agent.

• #send_project_location_app_version_message(tenant, lf_a2a_v1_send_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1SendMessageResponse

  Sends a message to an agent.

• #stream_project_location_app_session_run_session(session, run_session_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::RunSessionResponse

  Initiates a single-turn interaction with the CES agent.

Constructor Details

#initialize ⇒ CustomerEngagementSuiteService

Returns a new instance of CustomerEngagementSuiteService.

# File 'lib/google/apis/ces_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-ces_v1',
        client_version: Google::Apis::CesV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

• (String) —

  API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

# File 'lib/google/apis/ces_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

• (String) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

# File 'lib/google/apis/ces_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#batch_delete_conversations(parent, batch_delete_conversations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

Batch deletes the specified conversations.

Parameters:

• parent (String) —

  Required. The resource name of the app to delete conversations from. Format: projects/project/locations/location/apps/app``

• batch_delete_conversations_request_object (Google::Apis::CesV1::BatchDeleteConversationsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 792

def batch_delete_conversations(parent, batch_delete_conversations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/conversations:batchDelete', options)
  command.request_representation = Google::Apis::CesV1::BatchDeleteConversationsRequest::Representation
  command.request_object = batch_delete_conversations_request_object
  command.response_representation = Google::Apis::CesV1::Operation::Representation
  command.response_class = Google::Apis::CesV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

• name (String) —

  The name of the operation resource to be cancelled.

• cancel_operation_request_object (Google::Apis::CesV1::CancelOperationRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2400

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::CesV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_app(parent, app_object = nil, app_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

Creates a new app in the given project and location.

Parameters:

• parent (String) —

  Required. The resource name of the location to create an app in.

• app_object (Google::Apis::CesV1::App) (defaults to: nil)
• app_id (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 165

def create_project_location_app(parent, app_object = nil, app_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/apps', options)
  command.request_representation = Google::Apis::CesV1::App::Representation
  command.request_object = app_object
  command.response_representation = Google::Apis::CesV1::Operation::Representation
  command.response_class = Google::Apis::CesV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['appId'] = app_id unless app_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_app_agent(parent, agent_object = nil, agent_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Agent

Creates a new agent in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to create an agent in.

• agent_object (Google::Apis::CesV1::Agent) (defaults to: nil)
• agent_id (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Agent) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Agent)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 518

def create_project_location_app_agent(parent, agent_object = nil, agent_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/agents', options)
  command.request_representation = Google::Apis::CesV1::Agent::Representation
  command.request_object = agent_object
  command.response_representation = Google::Apis::CesV1::Agent::Representation
  command.response_class = Google::Apis::CesV1::Agent
  command.params['parent'] = parent unless parent.nil?
  command.query['agentId'] = agent_id unless agent_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_app_deployment(parent, deployment_object = nil, deployment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Deployment

Creates a new deployment in the given app.

Parameters:

• parent (String) —

  Required. The parent app. Format: projects/project/locations/location/ apps/app``

• deployment_object (Google::Apis::CesV1::Deployment) (defaults to: nil)
• deployment_id (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Deployment) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Deployment)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 948

def create_project_location_app_deployment(parent, deployment_object = nil, deployment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/deployments', options)
  command.request_representation = Google::Apis::CesV1::Deployment::Representation
  command.request_object = deployment_object
  command.response_representation = Google::Apis::CesV1::Deployment::Representation
  command.response_class = Google::Apis::CesV1::Deployment
  command.params['parent'] = parent unless parent.nil?
  command.query['deploymentId'] = deployment_id unless deployment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_app_example(parent, example_object = nil, example_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Example

Creates a new example in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to create an example in.

• example_object (Google::Apis::CesV1::Example) (defaults to: nil)
• example_id (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Example) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Example)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1199

def create_project_location_app_example(parent, example_object = nil, example_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/examples', options)
  command.request_representation = Google::Apis::CesV1::Example::Representation
  command.request_object = example_object
  command.response_representation = Google::Apis::CesV1::Example::Representation
  command.response_class = Google::Apis::CesV1::Example
  command.params['parent'] = parent unless parent.nil?
  command.query['exampleId'] = example_id unless example_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_app_guardrail(parent, guardrail_object = nil, guardrail_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Guardrail

Creates a new guardrail in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to create a guardrail in.

• guardrail_object (Google::Apis::CesV1::Guardrail) (defaults to: nil)
• guardrail_id (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Guardrail) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Guardrail)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1387

def create_project_location_app_guardrail(parent, guardrail_object = nil, guardrail_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/guardrails', options)
  command.request_representation = Google::Apis::CesV1::Guardrail::Representation
  command.request_object = guardrail_object
  command.response_representation = Google::Apis::CesV1::Guardrail::Representation
  command.response_class = Google::Apis::CesV1::Guardrail
  command.params['parent'] = parent unless parent.nil?
  command.query['guardrailId'] = guardrail_id unless guardrail_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_app_tool(parent, tool_object = nil, tool_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Tool

Creates a new tool in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to create a tool in.

• tool_object (Google::Apis::CesV1::Tool) (defaults to: nil)
• tool_id (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Tool) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Tool)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1723

def create_project_location_app_tool(parent, tool_object = nil, tool_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/tools', options)
  command.request_representation = Google::Apis::CesV1::Tool::Representation
  command.request_object = tool_object
  command.response_representation = Google::Apis::CesV1::Tool::Representation
  command.response_class = Google::Apis::CesV1::Tool
  command.params['parent'] = parent unless parent.nil?
  command.query['toolId'] = tool_id unless tool_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_app_toolset(parent, toolset_object = nil, toolset_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Toolset

Creates a new toolset in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to create a toolset in.

• toolset_object (Google::Apis::CesV1::Toolset) (defaults to: nil)
• toolset_id (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Toolset) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Toolset)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1921

def create_project_location_app_toolset(parent, toolset_object = nil, toolset_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/toolsets', options)
  command.request_representation = Google::Apis::CesV1::Toolset::Representation
  command.request_object = toolset_object
  command.response_representation = Google::Apis::CesV1::Toolset::Representation
  command.response_class = Google::Apis::CesV1::Toolset
  command.params['parent'] = parent unless parent.nil?
  command.query['toolsetId'] = toolset_id unless toolset_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_app_version(parent, app_version_object = nil, app_version_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::AppVersion

Creates a new app version in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to create an app version in.

• app_version_object (Google::Apis::CesV1::AppVersion) (defaults to: nil)
• app_version_id (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::AppVersion) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::AppVersion)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2149

def create_project_location_app_version(parent, app_version_object = nil, app_version_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/versions', options)
  command.request_representation = Google::Apis::CesV1::AppVersion::Representation
  command.request_object = app_version_object
  command.response_representation = Google::Apis::CesV1::AppVersion::Representation
  command.response_class = Google::Apis::CesV1::AppVersion
  command.params['parent'] = parent unless parent.nil?
  command.query['appVersionId'] = app_version_id unless app_version_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_app(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

Deletes the specified app.

Parameters:

• name (String) —

  Required. The resource name of the app to delete.

• etag (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 203

def delete_project_location_app(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Operation::Representation
  command.response_class = Google::Apis::CesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_app_agent(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Deletes the specified agent.

Parameters:

• name (String) —

  Required. The resource name of the agent to delete.

• etag (String) (defaults to: nil) —

  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.

• force (Boolean) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 561

def delete_project_location_app_agent(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_app_conversation(name, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Deletes the specified conversation.

Parameters:

• name (String) —

  Required. The resource name of the conversation to delete.

• source (String) (defaults to: nil) —

  Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 827

def delete_project_location_app_conversation(name, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_app_deployment(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Deletes the specified deployment.

Parameters:

• name (String) —

  Required. The name of the deployment to delete. Format: projects/project/ locations/location/apps/app/deployments/deployment``

• etag (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 986

def delete_project_location_app_deployment(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_app_example(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Deletes the specified example.

Parameters:

• name (String) —

  Required. The resource name of the example to delete.

• etag (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1237

def delete_project_location_app_example(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_app_guardrail(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Deletes the specified guardrail.

Parameters:

• name (String) —

  Required. The resource name of the guardrail to delete.

• etag (String) (defaults to: nil) —

  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.

• force (Boolean) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1431

def delete_project_location_app_guardrail(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_app_tool(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Deletes the specified tool.

Parameters:

• name (String) —

  Required. The resource name of the tool to delete.

• etag (String) (defaults to: nil) —

  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.

• force (Boolean) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1766

def delete_project_location_app_tool(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_app_toolset(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Deletes the specified toolset.

Parameters:

• name (String) —

  Required. The resource name of the toolset to delete.

• etag (String) (defaults to: nil) —

  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.

• force (Boolean) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1964

def delete_project_location_app_toolset(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_app_version(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Deletes the specified app version.

Parameters:

• name (String) —

  Required. The resource name of the app version to delete.

• etag (String) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2187

def delete_project_location_app_version(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

• name (String) —

  The name of the operation resource to be deleted.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2435

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Empty::Representation
  command.response_class = Google::Apis::CesV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_app_tool(parent, execute_tool_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ExecuteToolResponse

Executes the given tool with the given arguments.

Parameters:

• parent (String) —

  Required. The resource name of the app which the tool/toolset belongs to. Format: projects/project/locations/location/apps/app``

• execute_tool_request_object (Google::Apis::CesV1::ExecuteToolRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ExecuteToolResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ExecuteToolResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 236

def execute_app_tool(parent, execute_tool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:executeTool', options)
  command.request_representation = Google::Apis::CesV1::ExecuteToolRequest::Representation
  command.request_object = execute_tool_request_object
  command.response_representation = Google::Apis::CesV1::ExecuteToolResponse::Representation
  command.response_class = Google::Apis::CesV1::ExecuteToolResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_app(name, export_app_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

Exports the specified app.

Parameters:

• name (String) —

  Required. The resource name of the app to export.

• export_app_request_object (Google::Apis::CesV1::ExportAppRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 269

def export_app(name, export_app_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:exportApp', options)
  command.request_representation = Google::Apis::CesV1::ExportAppRequest::Representation
  command.request_object = export_app_request_object
  command.response_representation = Google::Apis::CesV1::Operation::Representation
  command.response_class = Google::Apis::CesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_session_chat_token(name, generate_chat_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::GenerateChatTokenResponse

Generates a session scoped token for chat widget to authenticate with Session APIs.

Parameters:

• name (String) —

  Required. The session name to generate the chat token for. Format: projects/ project/locations/location/apps/app/sessions/session

• generate_chat_token_request_object (Google::Apis::CesV1::GenerateChatTokenRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::GenerateChatTokenResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::GenerateChatTokenResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1613

def generate_session_chat_token(name, generate_chat_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:generateChatToken', options)
  command.request_representation = Google::Apis::CesV1::GenerateChatTokenRequest::Representation
  command.request_object = generate_chat_token_request_object
  command.response_representation = Google::Apis::CesV1::GenerateChatTokenResponse::Representation
  command.response_class = Google::Apis::CesV1::GenerateChatTokenResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Location

Gets information about a location.

Parameters:

• name (String) —

  Resource name for the location.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Location) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Location)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 74

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Location::Representation
  command.response_class = Google::Apis::CesV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::App

Gets details of the specified app.

Parameters:

• name (String) —

  Required. The resource name of the app to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::App) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::App)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 301

def get_project_location_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::App::Representation
  command.response_class = Google::Apis::CesV1::App
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_agent(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Agent

Gets details of the specified agent.

Parameters:

• name (String) —

  Required. The resource name of the agent to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Agent) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Agent)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 593

def get_project_location_app_agent(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Agent::Representation
  command.response_class = Google::Apis::CesV1::Agent
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_changelog(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Changelog

Gets the specified changelog.

Parameters:

• name (String) —

  Required. The resource name of the changelog to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Changelog) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Changelog)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 707

def get_project_location_app_changelog(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Changelog::Representation
  command.response_class = Google::Apis::CesV1::Changelog
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_conversation(name, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Conversation

Gets details of the specified conversation.

Parameters:

• name (String) —

  Required. The resource name of the conversation to retrieve.

• source (String) (defaults to: nil) —

  Optional. Indicate the source of the conversation. If not set, all source will be searched.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Conversation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Conversation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 861

def get_project_location_app_conversation(name, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Conversation::Representation
  command.response_class = Google::Apis::CesV1::Conversation
  command.params['name'] = name unless name.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Deployment

Gets details of the specified deployment.

Parameters:

• name (String) —

  Required. The name of the deployment. Format: projects/project/locations/ location/apps/app/deployments/deployment``

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Deployment) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Deployment)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1018

def get_project_location_app_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Deployment::Representation
  command.response_class = Google::Apis::CesV1::Deployment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_deployment_extended_agent_card(tenant, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1AgentCard

Gets the extended agent card for the authenticated agent.

Parameters:

• tenant (String) —

  Optional. Tenant ID, provided as a path parameter.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::LfA2aV1AgentCard) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::LfA2aV1AgentCard)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1048

def get_project_location_app_deployment_extended_agent_card(tenant, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+tenant}/extendedAgentCard', options)
  command.response_representation = Google::Apis::CesV1::LfA2aV1AgentCard::Representation
  command.response_class = Google::Apis::CesV1::LfA2aV1AgentCard
  command.params['tenant'] = tenant unless tenant.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_example(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Example

Gets details of the specified example.

Parameters:

• name (String) —

  Required. The resource name of the example to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Example) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Example)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1268

def get_project_location_app_example(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Example::Representation
  command.response_class = Google::Apis::CesV1::Example
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_extended_agent_card(tenant, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1AgentCard

Gets the extended agent card for the authenticated agent.

Parameters:

• tenant (String) —

  Optional. Tenant ID, provided as a path parameter.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::LfA2aV1AgentCard) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::LfA2aV1AgentCard)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 331

def get_project_location_app_extended_agent_card(tenant, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+tenant}/extendedAgentCard', options)
  command.response_representation = Google::Apis::CesV1::LfA2aV1AgentCard::Representation
  command.response_class = Google::Apis::CesV1::LfA2aV1AgentCard
  command.params['tenant'] = tenant unless tenant.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_guardrail(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Guardrail

Gets details of the specified guardrail.

Parameters:

• name (String) —

  Required. The resource name of the guardrail to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Guardrail) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Guardrail)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1463

def get_project_location_app_guardrail(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Guardrail::Representation
  command.response_class = Google::Apis::CesV1::Guardrail
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_tool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Tool

Gets details of the specified tool.

Parameters:

• name (String) —

  Required. The resource name of the tool to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Tool) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Tool)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1798

def get_project_location_app_tool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Tool::Representation
  command.response_class = Google::Apis::CesV1::Tool
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_toolset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Toolset

Gets details of the specified toolset.

Parameters:

• name (String) —

  Required. The resource name of the toolset to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Toolset) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Toolset)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1996

def get_project_location_app_toolset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Toolset::Representation
  command.response_class = Google::Apis::CesV1::Toolset
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::AppVersion

Gets details of the specified app version.

Parameters:

• name (String) —

  Required. The resource name of the app version to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::AppVersion) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::AppVersion)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2218

def get_project_location_app_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::AppVersion::Representation
  command.response_class = Google::Apis::CesV1::AppVersion
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_app_version_extended_agent_card(tenant, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1AgentCard

Gets the extended agent card for the authenticated agent.

Parameters:

• tenant (String) —

  Optional. Tenant ID, provided as a path parameter.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::LfA2aV1AgentCard) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::LfA2aV1AgentCard)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2248

def get_project_location_app_version_extended_agent_card(tenant, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+tenant}/extendedAgentCard', options)
  command.response_representation = Google::Apis::CesV1::LfA2aV1AgentCard::Representation
  command.response_class = Google::Apis::CesV1::LfA2aV1AgentCard
  command.params['tenant'] = tenant unless tenant.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

• name (String) —

  The name of the operation resource.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2466

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CesV1::Operation::Representation
  command.response_class = Google::Apis::CesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_app(parent, import_app_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Operation

Imports the specified app.

Parameters:

• parent (String) —

  Required. The parent resource name with the location of the app to import.

• import_app_request_object (Google::Apis::CesV1::ImportAppRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 362

def import_app(parent, import_app_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/apps:importApp', options)
  command.request_representation = Google::Apis::CesV1::ImportAppRequest::Representation
  command.request_object = import_app_request_object
  command.response_representation = Google::Apis::CesV1::Operation::Representation
  command.response_class = Google::Apis::CesV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_app_agents(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListAgentsResponse

Lists agents in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to list agents from.

• filter (String) (defaults to: nil) —

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

• order_by (String) (defaults to: nil) —

  Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

• page_token (String) (defaults to: nil) —

  Optional. The next_page_token value returned from a previous list AgentService. ListAgents call.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListAgentsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListAgentsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 635

def list_project_location_app_agents(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/agents', options)
  command.response_representation = Google::Apis::CesV1::ListAgentsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListAgentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_app_changelogs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListChangelogsResponse

Lists the changelogs of the specified app.

Parameters:

• parent (String) —

  Required. The resource name of the app to list changelogs from.

• filter (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

• page_token (String) (defaults to: nil) —

  Optional. The next_page_token value returned from a previous list AgentService. ListChangelogs call.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListChangelogsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListChangelogsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 756

def list_project_location_app_changelogs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/changelogs', options)
  command.response_representation = Google::Apis::CesV1::ListChangelogsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListChangelogsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_app_conversations(parent, filter: nil, page_size: nil, page_token: nil, source: nil, sources: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListConversationsResponse

Lists conversations in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to list conversations from.

• filter (String) (defaults to: nil) —

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

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

• page_token (String) (defaults to: nil) —

  Optional. The next_page_token value returned from a previous list AgentService. ListConversations call.

• source (String) (defaults to: nil) —

  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<String>, String) (defaults to: nil) —

  Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListConversationsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListConversationsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 907

def list_project_location_app_conversations(parent, filter: nil, page_size: nil, page_token: nil, source: nil, sources: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/conversations', options)
  command.response_representation = Google::Apis::CesV1::ListConversationsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListConversationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['source'] = source unless source.nil?
  command.query['sources'] = sources unless sources.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_app_deployments(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListDeploymentsResponse

Lists deployments in the given app.

Parameters:

• parent (String) —

  Required. The parent app. Format: projects/project/locations/location/ apps/app``

• order_by (String) (defaults to: nil) —

  Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

• page_size (Fixnum) (defaults to: nil) —

  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) (defaults to: nil) —

  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.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListDeploymentsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListDeploymentsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1091

def list_project_location_app_deployments(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::CesV1::ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_app_examples(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListExamplesResponse

Lists examples in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to list examples from.

• filter (String) (defaults to: nil) —

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

• order_by (String) (defaults to: nil) —

  Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

• page_token (String) (defaults to: nil) —

  Optional. The next_page_token value returned from a previous list AgentService. ListExamples call.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListExamplesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListExamplesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1310

def list_project_location_app_examples(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/examples', options)
  command.response_representation = Google::Apis::CesV1::ListExamplesResponse::Representation
  command.response_class = Google::Apis::CesV1::ListExamplesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_app_guardrails(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListGuardrailsResponse

Lists guardrails in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to list guardrails from.

• filter (String) (defaults to: nil) —

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

• order_by (String) (defaults to: nil) —

  Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

• page_token (String) (defaults to: nil) —

  Optional. The next_page_token value returned from a previous list AgentService. ListGuardrails call.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListGuardrailsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListGuardrailsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1505

def list_project_location_app_guardrails(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/guardrails', options)
  command.response_representation = Google::Apis::CesV1::ListGuardrailsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListGuardrailsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_app_tools(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListToolsResponse

Lists tools in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to list tools from.

• filter (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

• page_token (String) (defaults to: nil) —

  Optional. The next_page_token value returned from a previous list AgentService. ListTools call.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListToolsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListToolsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1841

def list_project_location_app_tools(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/tools', options)
  command.response_representation = Google::Apis::CesV1::ListToolsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListToolsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_app_toolsets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListToolsetsResponse

Lists toolsets in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to list toolsets from.

• filter (String) (defaults to: nil) —

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

• order_by (String) (defaults to: nil) —

  Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

• page_token (String) (defaults to: nil) —

  Optional. The next_page_token value returned from a previous list AgentService. ListToolsets call.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListToolsetsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListToolsetsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2038

def list_project_location_app_toolsets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/toolsets', options)
  command.response_representation = Google::Apis::CesV1::ListToolsetsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListToolsetsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_app_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListAppVersionsResponse

Lists all app versions in the given app.

Parameters:

• parent (String) —

  Required. The resource name of the app to list app versions from.

• filter (String) (defaults to: nil) —

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

• order_by (String) (defaults to: nil) —

  Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

• page_token (String) (defaults to: nil) —

  Optional. The next_page_token value returned from a previous list AgentService. ListAppVersions call.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListAppVersionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListAppVersionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2290

def list_project_location_app_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/versions', options)
  command.response_representation = Google::Apis::CesV1::ListAppVersionsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListAppVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_apps(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListAppsResponse

Lists apps in the given project and location.

Parameters:

• parent (String) —

  Required. The resource name of the location to list apps from.

• filter (String) (defaults to: nil) —

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

• order_by (String) (defaults to: nil) —

  Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

• page_token (String) (defaults to: nil) —

  Optional. The next_page_token value returned from a previous list AgentService. ListApps call.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListAppsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListAppsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 406

def list_project_location_apps(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps', options)
  command.response_representation = Google::Apis::CesV1::ListAppsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListAppsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

• name (String) —

  The name of the operation's parent resource.

• filter (String) (defaults to: nil) —

  The standard list filter.

• page_size (Fixnum) (defaults to: nil) —

  The standard list page size.

• page_token (String) (defaults to: nil) —

  The standard list page token.

• return_partial_success (Boolean) (defaults to: nil) —

  When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListOperationsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListOperationsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2511

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::CesV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::ListLocationsResponse

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project- specific locations: If name follows the format projects/project`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as thename` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

• name (String) —

  The resource that owns the locations collection, if applicable.

• extra_location_types (Array<String>, String) (defaults to: nil) —

  Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.

• filter (String) (defaults to: nil) —

  A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

• page_size (Fixnum) (defaults to: nil) —

  The maximum number of results to return. If not set, the service selects a default.

• page_token (String) (defaults to: nil) —

  A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::ListLocationsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::ListLocationsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 126

def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::CesV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::CesV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_app(name, app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::App

Updates the specified app.

Parameters:

• name (String) —

  Identifier. The unique identifier of the app. Format: projects/project/ locations/location/apps/app``

• app_object (Google::Apis::CesV1::App) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::App) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::App)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 445

def patch_project_location_app(name, app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CesV1::App::Representation
  command.request_object = app_object
  command.response_representation = Google::Apis::CesV1::App::Representation
  command.response_class = Google::Apis::CesV1::App
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_app_agent(name, agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Agent

Updates the specified agent.

Parameters:

• name (String) —

  Identifier. The unique identifier of the agent. Format: projects/project/ locations/location/apps/app/agents/agent``

• agent_object (Google::Apis::CesV1::Agent) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Agent) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Agent)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 674

def patch_project_location_app_agent(name, agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CesV1::Agent::Representation
  command.request_object = agent_object
  command.response_representation = Google::Apis::CesV1::Agent::Representation
  command.response_class = Google::Apis::CesV1::Agent
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_app_deployment(name, deployment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Deployment

Updates the specified deployment.

Parameters:

• name (String) —

  Identifier. The resource name of the deployment. Format: projects/project/ locations/location/apps/app/deployments/deployment``

• deployment_object (Google::Apis::CesV1::Deployment) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. The list of fields to update.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Deployment) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Deployment)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1128

def patch_project_location_app_deployment(name, deployment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CesV1::Deployment::Representation
  command.request_object = deployment_object
  command.response_representation = Google::Apis::CesV1::Deployment::Representation
  command.response_class = Google::Apis::CesV1::Deployment
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_app_example(name, example_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Example

Updates the specified example.

Parameters:

• name (String) —

  Identifier. The unique identifier of the example. Format: projects/project/ locations/location/apps/app/examples/example``

• example_object (Google::Apis::CesV1::Example) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Example) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Example)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1349

def patch_project_location_app_example(name, example_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CesV1::Example::Representation
  command.request_object = example_object
  command.response_representation = Google::Apis::CesV1::Example::Representation
  command.response_class = Google::Apis::CesV1::Example
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_app_guardrail(name, guardrail_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Guardrail

Updates the specified guardrail.

Parameters:

• name (String) —

  Identifier. The unique identifier of the guardrail. Format: projects/project /locations/location/apps/app/guardrails/guardrail``

• guardrail_object (Google::Apis::CesV1::Guardrail) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Guardrail) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Guardrail)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1544

def patch_project_location_app_guardrail(name, guardrail_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CesV1::Guardrail::Representation
  command.request_object = guardrail_object
  command.response_representation = Google::Apis::CesV1::Guardrail::Representation
  command.response_class = Google::Apis::CesV1::Guardrail
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_app_tool(name, tool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Tool

Updates the specified tool.

Parameters:

• name (String) —

  Identifier. The resource name of the tool. Format: * projects/project/ locations/location/apps/app/tools/toolfor standalone tools. * ` projects/`project`/locations/`location`/apps/`app`/toolsets/`toolset`/tools/` tool for tools retrieved from a toolset. These tools are dynamic and output- only; they cannot be referenced directly where a tool is expected.

• tool_object (Google::Apis::CesV1::Tool) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Tool) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Tool)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1883

def patch_project_location_app_tool(name, tool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CesV1::Tool::Representation
  command.request_object = tool_object
  command.response_representation = Google::Apis::CesV1::Tool::Representation
  command.response_class = Google::Apis::CesV1::Tool
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_app_toolset(name, toolset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::Toolset

Updates the specified toolset.

Parameters:

• name (String) —

  Identifier. The unique identifier of the toolset. Format: projects/project/ locations/location/apps/app/toolsets/toolset``

• toolset_object (Google::Apis::CesV1::Toolset) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Toolset) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Toolset)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2077

def patch_project_location_app_toolset(name, toolset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CesV1::Toolset::Representation
  command.request_object = toolset_object
  command.response_representation = Google::Apis::CesV1::Toolset::Representation
  command.response_class = Google::Apis::CesV1::Toolset
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restore_app_version(name, restore_app_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::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.

Parameters:

• name (String) —

  Required. The resource name of the app version to restore.

• restore_app_version_request_object (Google::Apis::CesV1::RestoreAppVersionRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2327

def restore_app_version(name, restore_app_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:restore', options)
  command.request_representation = Google::Apis::CesV1::RestoreAppVersionRequest::Representation
  command.request_object = restore_app_version_request_object
  command.response_representation = Google::Apis::CesV1::Operation::Representation
  command.response_class = Google::Apis::CesV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#retrieve_app_tool_schema(parent, retrieve_tool_schema_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::RetrieveToolSchemaResponse

Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.

Parameters:

• parent (String) —

  Required. The resource name of the app which the tool/toolset belongs to. Format: projects/project/locations/location/apps/app``

• retrieve_tool_schema_request_object (Google::Apis::CesV1::RetrieveToolSchemaRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::RetrieveToolSchemaResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::RetrieveToolSchemaResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 481

def retrieve_app_tool_schema(parent, retrieve_tool_schema_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:retrieveToolSchema', options)
  command.request_representation = Google::Apis::CesV1::RetrieveToolSchemaRequest::Representation
  command.request_object = retrieve_tool_schema_request_object
  command.response_representation = Google::Apis::CesV1::RetrieveToolSchemaResponse::Representation
  command.response_class = Google::Apis::CesV1::RetrieveToolSchemaResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#retrieve_toolset_tools(toolset, retrieve_tools_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::RetrieveToolsResponse

Retrieve the list of tools included in the specified toolset.

Parameters:

• toolset (String) —

  Required. The name of the toolset to retrieve the tools for. Format: projects/ project/locations/location/apps/app/toolsets/toolset``

• retrieve_tools_request_object (Google::Apis::CesV1::RetrieveToolsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::RetrieveToolsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::RetrieveToolsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2112

def retrieve_toolset_tools(toolset, retrieve_tools_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+toolset}:retrieveTools', options)
  command.request_representation = Google::Apis::CesV1::RetrieveToolsRequest::Representation
  command.request_object = retrieve_tools_request_object
  command.response_representation = Google::Apis::CesV1::RetrieveToolsResponse::Representation
  command.response_class = Google::Apis::CesV1::RetrieveToolsResponse
  command.params['toolset'] = toolset unless toolset.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_session(session, run_session_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::RunSessionResponse

Initiates a single-turn interaction with the CES agent within a session.

Parameters:

• session (String) —

  Required. The unique identifier of the session. Format: projects/project/ locations/location/apps/app/sessions/session``

• run_session_request_object (Google::Apis::CesV1::RunSessionRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::RunSessionResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::RunSessionResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1647

def run_session(session, run_session_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+session}:runSession', options)
  command.request_representation = Google::Apis::CesV1::RunSessionRequest::Representation
  command.request_object = run_session_request_object
  command.response_representation = Google::Apis::CesV1::RunSessionResponse::Representation
  command.response_class = Google::Apis::CesV1::RunSessionResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_project_location_app_deployment_message(tenant, lf_a2a_v1_send_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1SendMessageResponse

Sends a message to an agent.

Parameters:

• tenant (String) —

  Optional. Tenant ID, provided as a path parameter.

• lf_a2a_v1_send_message_request_object (Google::Apis::CesV1::LfA2aV1SendMessageRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::LfA2aV1SendMessageResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::LfA2aV1SendMessageResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1162

def send_project_location_app_deployment_message(tenant, lf_a2a_v1_send_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+tenant}/message:send', options)
  command.request_representation = Google::Apis::CesV1::LfA2aV1SendMessageRequest::Representation
  command.request_object = lf_a2a_v1_send_message_request_object
  command.response_representation = Google::Apis::CesV1::LfA2aV1SendMessageResponse::Representation
  command.response_class = Google::Apis::CesV1::LfA2aV1SendMessageResponse
  command.params['tenant'] = tenant unless tenant.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_project_location_app_message(tenant, lf_a2a_v1_send_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1SendMessageResponse

Sends a message to an agent.

Parameters:

• tenant (String) —

  Optional. Tenant ID, provided as a path parameter.

• lf_a2a_v1_send_message_request_object (Google::Apis::CesV1::LfA2aV1SendMessageRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::LfA2aV1SendMessageResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::LfA2aV1SendMessageResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1578

def send_project_location_app_message(tenant, lf_a2a_v1_send_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+tenant}/message:send', options)
  command.request_representation = Google::Apis::CesV1::LfA2aV1SendMessageRequest::Representation
  command.request_object = lf_a2a_v1_send_message_request_object
  command.response_representation = Google::Apis::CesV1::LfA2aV1SendMessageResponse::Representation
  command.response_class = Google::Apis::CesV1::LfA2aV1SendMessageResponse
  command.params['tenant'] = tenant unless tenant.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_project_location_app_version_message(tenant, lf_a2a_v1_send_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::LfA2aV1SendMessageResponse

Sends a message to an agent.

Parameters:

• tenant (String) —

  Optional. Tenant ID, provided as a path parameter.

• lf_a2a_v1_send_message_request_object (Google::Apis::CesV1::LfA2aV1SendMessageRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::LfA2aV1SendMessageResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::LfA2aV1SendMessageResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 2360

def send_project_location_app_version_message(tenant, lf_a2a_v1_send_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+tenant}/message:send', options)
  command.request_representation = Google::Apis::CesV1::LfA2aV1SendMessageRequest::Representation
  command.request_object = lf_a2a_v1_send_message_request_object
  command.response_representation = Google::Apis::CesV1::LfA2aV1SendMessageResponse::Representation
  command.response_class = Google::Apis::CesV1::LfA2aV1SendMessageResponse
  command.params['tenant'] = tenant unless tenant.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stream_project_location_app_session_run_session(session, run_session_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CesV1::RunSessionResponse

Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true.

Parameters:

• session (String) —

  Required. The unique identifier of the session. Format: projects/project/ locations/location/apps/app/sessions/session``

• run_session_request_object (Google::Apis::CesV1::RunSessionRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::CesV1::RunSessionResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::CesV1::RunSessionResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/ces_v1/service.rb', line 1686

def stream_project_location_app_session_run_session(session, run_session_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+session}:streamRunSession', options)
  command.request_representation = Google::Apis::CesV1::RunSessionRequest::Representation
  command.request_object = run_session_request_object
  command.response_representation = Google::Apis::CesV1::RunSessionResponse::Representation
  command.response_class = Google::Apis::CesV1::RunSessionResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end