Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface AgentOrBuilder (0.1.0)

public interface AgentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAfterAgentCallbacks(int index)

public abstract Callback getAfterAgentCallbacks(int index)

Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Callback`

getAfterAgentCallbacksCount()

public abstract int getAfterAgentCallbacksCount()

Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getAfterAgentCallbacksList()

public abstract List<Callback> getAfterAgentCallbacksList()

Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Callback>`

getAfterAgentCallbacksOrBuilder(int index)

public abstract CallbackOrBuilder getAfterAgentCallbacksOrBuilder(int index)

Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CallbackOrBuilder`

getAfterAgentCallbacksOrBuilderList()

public abstract List<? extends CallbackOrBuilder> getAfterAgentCallbacksOrBuilderList()

Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_agent_callbacks = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.ces.v1.CallbackOrBuilder>`

getAfterModelCallbacks(int index)

public abstract Callback getAfterModelCallbacks(int index)

Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Callback`

getAfterModelCallbacksCount()

public abstract int getAfterModelCallbacksCount()

Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getAfterModelCallbacksList()

public abstract List<Callback> getAfterModelCallbacksList()

Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Callback>`

getAfterModelCallbacksOrBuilder(int index)

public abstract CallbackOrBuilder getAfterModelCallbacksOrBuilder(int index)

Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CallbackOrBuilder`

getAfterModelCallbacksOrBuilderList()

public abstract List<? extends CallbackOrBuilder> getAfterModelCallbacksOrBuilderList()

Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_model_callbacks = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.ces.v1.CallbackOrBuilder>`

getAfterToolCallbacks(int index)

public abstract Callback getAfterToolCallbacks(int index)

Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Callback`

getAfterToolCallbacksCount()

public abstract int getAfterToolCallbacksCount()

Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getAfterToolCallbacksList()

public abstract List<Callback> getAfterToolCallbacksList()

Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Callback>`

getAfterToolCallbacksOrBuilder(int index)

public abstract CallbackOrBuilder getAfterToolCallbacksOrBuilder(int index)

Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CallbackOrBuilder`

getAfterToolCallbacksOrBuilderList()

public abstract List<? extends CallbackOrBuilder> getAfterToolCallbacksOrBuilderList()

Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback after_tool_callbacks = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.ces.v1.CallbackOrBuilder>`

getAgentTypeCase()

public abstract Agent.AgentTypeCase getAgentTypeCase()

Returns
Type	Description
`Agent.AgentTypeCase`

getBeforeAgentCallbacks(int index)

public abstract Callback getBeforeAgentCallbacks(int index)

Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Callback`

getBeforeAgentCallbacksCount()

public abstract int getBeforeAgentCallbacksCount()

Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getBeforeAgentCallbacksList()

public abstract List<Callback> getBeforeAgentCallbacksList()

Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Callback>`

getBeforeAgentCallbacksOrBuilder(int index)

public abstract CallbackOrBuilder getBeforeAgentCallbacksOrBuilder(int index)

Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CallbackOrBuilder`

getBeforeAgentCallbacksOrBuilderList()

public abstract List<? extends CallbackOrBuilder> getBeforeAgentCallbacksOrBuilderList()

Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_agent_callbacks = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.ces.v1.CallbackOrBuilder>`

getBeforeModelCallbacks(int index)

public abstract Callback getBeforeModelCallbacks(int index)

Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Callback`

getBeforeModelCallbacksCount()

public abstract int getBeforeModelCallbacksCount()

Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getBeforeModelCallbacksList()

public abstract List<Callback> getBeforeModelCallbacksList()

Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Callback>`

getBeforeModelCallbacksOrBuilder(int index)

public abstract CallbackOrBuilder getBeforeModelCallbacksOrBuilder(int index)

Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CallbackOrBuilder`

getBeforeModelCallbacksOrBuilderList()

public abstract List<? extends CallbackOrBuilder> getBeforeModelCallbacksOrBuilderList()

Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_model_callbacks = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.ces.v1.CallbackOrBuilder>`

getBeforeToolCallbacks(int index)

public abstract Callback getBeforeToolCallbacks(int index)

Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Callback`

getBeforeToolCallbacksCount()

public abstract int getBeforeToolCallbacksCount()

Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getBeforeToolCallbacksList()

public abstract List<Callback> getBeforeToolCallbacksList()

Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Callback>`

getBeforeToolCallbacksOrBuilder(int index)

public abstract CallbackOrBuilder getBeforeToolCallbacksOrBuilder(int index)

Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CallbackOrBuilder`

getBeforeToolCallbacksOrBuilderList()

public abstract List<? extends CallbackOrBuilder> getBeforeToolCallbacksOrBuilderList()

Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.

repeated .google.cloud.ces.v1.Callback before_tool_callbacks = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.ces.v1.CallbackOrBuilder>`

getChildAgents(int index)

public abstract String getChildAgents(int index)

Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

repeated string child_agents = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The childAgents at the given index.

getChildAgentsBytes(int index)

public abstract ByteString getChildAgentsBytes(int index)

Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

repeated string child_agents = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the childAgents at the given index.

getChildAgentsCount()

public abstract int getChildAgentsCount()

Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

repeated string child_agents = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`int`	The count of childAgents.

getChildAgentsList()

public abstract List<String> getChildAgentsList()

Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

repeated string child_agents = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`List<String>`	A list containing the childAgents.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp when the agent was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the agent was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getDescription()

public abstract String getDescription()

Optional. Human-readable description of the agent.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Human-readable description of the agent.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. Display name of the agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. Display name of the agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for displayName.

getEtag()

public abstract String getEtag()

Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 24;

Returns
Type	Description
`String`	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 24;

Returns
Type	Description
`ByteString`	The bytes for etag.

getGeneratedSummary()

public abstract String getGeneratedSummary()

Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.

string generated_summary = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The generatedSummary.

getGeneratedSummaryBytes()

public abstract ByteString getGeneratedSummaryBytes()

Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.

string generated_summary = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for generatedSummary.

getGuardrails(int index)

public abstract String getGuardrails(int index)

Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The guardrails at the given index.

getGuardrailsBytes(int index)

public abstract ByteString getGuardrailsBytes(int index)

Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the guardrails at the given index.

getGuardrailsCount()

public abstract int getGuardrailsCount()

Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`int`	The count of guardrails.

getGuardrailsList()

public abstract List<String> getGuardrailsList()

Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`List<String>`	A list containing the guardrails.

getInstruction()

public abstract String getInstruction()

Optional. Instructions for the LLM model to guide the agent's behavior.

string instruction = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The instruction.

getInstructionBytes()

public abstract ByteString getInstructionBytes()

Optional. Instructions for the LLM model to guide the agent's behavior.

string instruction = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for instruction.

getLlmAgent()

public abstract Agent.LlmAgent getLlmAgent()

Optional. The default agent type.

.google.cloud.ces.v1.Agent.LlmAgent llm_agent = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Agent.LlmAgent`	The llmAgent.

getLlmAgentOrBuilder()

public abstract Agent.LlmAgentOrBuilder getLlmAgentOrBuilder()

Optional. The default agent type.

.google.cloud.ces.v1.Agent.LlmAgent llm_agent = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Agent.LlmAgentOrBuilder`

getModelSettings()

public abstract ModelSettings getModelSettings()

Optional. Configurations for the LLM model.

.google.cloud.ces.v1.ModelSettings model_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ModelSettings`	The modelSettings.

getModelSettingsOrBuilder()

public abstract ModelSettingsOrBuilder getModelSettingsOrBuilder()

Optional. Configurations for the LLM model.

.google.cloud.ces.v1.ModelSettings model_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ModelSettingsOrBuilder`

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
`ByteString`	The bytes for name.

getRemoteDialogflowAgent()

public abstract Agent.RemoteDialogflowAgent getRemoteDialogflowAgent()

Optional. The remote Dialogflow agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored.

Note: If the Dialogflow agent is in a different project from the app, you should grant roles/dialogflow.client to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

.google.cloud.ces.v1.Agent.RemoteDialogflowAgent remote_dialogflow_agent = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Agent.RemoteDialogflowAgent`	The remoteDialogflowAgent.

getRemoteDialogflowAgentOrBuilder()

public abstract Agent.RemoteDialogflowAgentOrBuilder getRemoteDialogflowAgentOrBuilder()

Optional. The remote Dialogflow agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored.

Note: If the Dialogflow agent is in a different project from the app, you should grant roles/dialogflow.client to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

.google.cloud.ces.v1.Agent.RemoteDialogflowAgent remote_dialogflow_agent = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Agent.RemoteDialogflowAgentOrBuilder`

getTools(int index)

public abstract String getTools(int index)

Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

repeated string tools = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The tools at the given index.

getToolsBytes(int index)

public abstract ByteString getToolsBytes(int index)

Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

repeated string tools = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the tools at the given index.

getToolsCount()

public abstract int getToolsCount()

Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

repeated string tools = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`int`	The count of tools.

getToolsList()

public abstract List<String> getToolsList()

Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

repeated string tools = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`List<String>`	A list containing the tools.

getToolsets(int index)

public abstract Agent.AgentToolset getToolsets(int index)

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Agent.AgentToolset`

getToolsetsCount()

public abstract int getToolsetsCount()

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getToolsetsList()

public abstract List<Agent.AgentToolset> getToolsetsList()

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<AgentToolset>`

getToolsetsOrBuilder(int index)

public abstract Agent.AgentToolsetOrBuilder getToolsetsOrBuilder(int index)

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Agent.AgentToolsetOrBuilder`

getToolsetsOrBuilderList()

public abstract List<? extends Agent.AgentToolsetOrBuilder> getToolsetsOrBuilderList()

Optional. List of toolsets for the agent.

repeated .google.cloud.ces.v1.Agent.AgentToolset toolsets = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.ces.v1.Agent.AgentToolsetOrBuilder>`

getTransferRules(int index)

public abstract TransferRule getTransferRules(int index)

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`TransferRule`

getTransferRulesCount()

public abstract int getTransferRulesCount()

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getTransferRulesList()

public abstract List<TransferRule> getTransferRulesList()

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<TransferRule>`

getTransferRulesOrBuilder(int index)

public abstract TransferRuleOrBuilder getTransferRulesOrBuilder(int index)

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`TransferRuleOrBuilder`

getTransferRulesOrBuilderList()

public abstract List<? extends TransferRuleOrBuilder> getTransferRulesOrBuilderList()

Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

repeated .google.cloud.ces.v1.TransferRule transfer_rules = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.ces.v1.TransferRuleOrBuilder>`

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Timestamp when the agent was last updated.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when the agent was last updated.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp when the agent was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasLlmAgent()

public abstract boolean hasLlmAgent()

Optional. The default agent type.

.google.cloud.ces.v1.Agent.LlmAgent llm_agent = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the llmAgent field is set.

hasModelSettings()

public abstract boolean hasModelSettings()

Optional. Configurations for the LLM model.

.google.cloud.ces.v1.ModelSettings model_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the modelSettings field is set.

hasRemoteDialogflowAgent()

public abstract boolean hasRemoteDialogflowAgent()

Optional. The remote Dialogflow agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored.

Note: If the Dialogflow agent is in a different project from the app, you should grant roles/dialogflow.client to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

.google.cloud.ces.v1.Agent.RemoteDialogflowAgent remote_dialogflow_agent = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the remoteDialogflowAgent field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Timestamp when the agent was last updated.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the updateTime field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-27 UTC.