Class Agent.Builder (0.1.0)

public static final class Agent.Builder extends GeneratedMessage.Builder<Agent.Builder> implements AgentOrBuilder

An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.

Protobuf type google.cloud.ces.v1.Agent

Implements

AgentOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAfterAgentCallbacks(Callback value)

public Agent.Builder addAfterAgentCallbacks(Callback value)

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
value Callback
Returns
Type Description
Agent.Builder

addAfterAgentCallbacks(Callback.Builder builderForValue)

public Agent.Builder addAfterAgentCallbacks(Callback.Builder builderForValue)

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
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addAfterAgentCallbacks(int index, Callback value)

public Agent.Builder addAfterAgentCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

addAfterAgentCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder addAfterAgentCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addAfterAgentCallbacksBuilder()

public Callback.Builder addAfterAgentCallbacksBuilder()

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
Callback.Builder

addAfterAgentCallbacksBuilder(int index)

public Callback.Builder addAfterAgentCallbacksBuilder(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.Builder

addAfterModelCallbacks(Callback value)

public Agent.Builder addAfterModelCallbacks(Callback value)

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
value Callback
Returns
Type Description
Agent.Builder

addAfterModelCallbacks(Callback.Builder builderForValue)

public Agent.Builder addAfterModelCallbacks(Callback.Builder builderForValue)

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
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addAfterModelCallbacks(int index, Callback value)

public Agent.Builder addAfterModelCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

addAfterModelCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder addAfterModelCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addAfterModelCallbacksBuilder()

public Callback.Builder addAfterModelCallbacksBuilder()

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
Callback.Builder

addAfterModelCallbacksBuilder(int index)

public Callback.Builder addAfterModelCallbacksBuilder(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.Builder

addAfterToolCallbacks(Callback value)

public Agent.Builder addAfterToolCallbacks(Callback value)

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
value Callback
Returns
Type Description
Agent.Builder

addAfterToolCallbacks(Callback.Builder builderForValue)

public Agent.Builder addAfterToolCallbacks(Callback.Builder builderForValue)

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
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addAfterToolCallbacks(int index, Callback value)

public Agent.Builder addAfterToolCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

addAfterToolCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder addAfterToolCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addAfterToolCallbacksBuilder()

public Callback.Builder addAfterToolCallbacksBuilder()

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
Callback.Builder

addAfterToolCallbacksBuilder(int index)

public Callback.Builder addAfterToolCallbacksBuilder(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.Builder

addAllAfterAgentCallbacks(Iterable<? extends Callback> values)

public Agent.Builder addAllAfterAgentCallbacks(Iterable<? extends Callback> values)

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
values Iterable<? extends com.google.cloud.ces.v1.Callback>
Returns
Type Description
Agent.Builder

addAllAfterModelCallbacks(Iterable<? extends Callback> values)

public Agent.Builder addAllAfterModelCallbacks(Iterable<? extends Callback> values)

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
values Iterable<? extends com.google.cloud.ces.v1.Callback>
Returns
Type Description
Agent.Builder

addAllAfterToolCallbacks(Iterable<? extends Callback> values)

public Agent.Builder addAllAfterToolCallbacks(Iterable<? extends Callback> values)

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
values Iterable<? extends com.google.cloud.ces.v1.Callback>
Returns
Type Description
Agent.Builder

addAllBeforeAgentCallbacks(Iterable<? extends Callback> values)

public Agent.Builder addAllBeforeAgentCallbacks(Iterable<? extends Callback> values)

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
values Iterable<? extends com.google.cloud.ces.v1.Callback>
Returns
Type Description
Agent.Builder

addAllBeforeModelCallbacks(Iterable<? extends Callback> values)

public Agent.Builder addAllBeforeModelCallbacks(Iterable<? extends Callback> values)

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
values Iterable<? extends com.google.cloud.ces.v1.Callback>
Returns
Type Description
Agent.Builder

addAllBeforeToolCallbacks(Iterable<? extends Callback> values)

public Agent.Builder addAllBeforeToolCallbacks(Iterable<? extends Callback> values)

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
values Iterable<? extends com.google.cloud.ces.v1.Callback>
Returns
Type Description
Agent.Builder

addAllChildAgents(Iterable<String> values)

public Agent.Builder addAllChildAgents(Iterable<String> values)

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
values Iterable<String>

The childAgents to add.

Returns
Type Description
Agent.Builder

This builder for chaining.

addAllGuardrails(Iterable<String> values)

public Agent.Builder addAllGuardrails(Iterable<String> values)

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
values Iterable<String>

The guardrails to add.

Returns
Type Description
Agent.Builder

This builder for chaining.

addAllTools(Iterable<String> values)

public Agent.Builder addAllTools(Iterable<String> values)

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
values Iterable<String>

The tools to add.

Returns
Type Description
Agent.Builder

This builder for chaining.

addAllToolsets(Iterable<? extends Agent.AgentToolset> values)

public Agent.Builder addAllToolsets(Iterable<? extends Agent.AgentToolset> values)

Optional. List of toolsets for the agent.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.ces.v1.Agent.AgentToolset>
Returns
Type Description
Agent.Builder

addAllTransferRules(Iterable<? extends TransferRule> values)

public Agent.Builder addAllTransferRules(Iterable<? extends TransferRule> values)

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
values Iterable<? extends com.google.cloud.ces.v1.TransferRule>
Returns
Type Description
Agent.Builder

addBeforeAgentCallbacks(Callback value)

public Agent.Builder addBeforeAgentCallbacks(Callback value)

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
value Callback
Returns
Type Description
Agent.Builder

addBeforeAgentCallbacks(Callback.Builder builderForValue)

public Agent.Builder addBeforeAgentCallbacks(Callback.Builder builderForValue)

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
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addBeforeAgentCallbacks(int index, Callback value)

public Agent.Builder addBeforeAgentCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

addBeforeAgentCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder addBeforeAgentCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addBeforeAgentCallbacksBuilder()

public Callback.Builder addBeforeAgentCallbacksBuilder()

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
Callback.Builder

addBeforeAgentCallbacksBuilder(int index)

public Callback.Builder addBeforeAgentCallbacksBuilder(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.Builder

addBeforeModelCallbacks(Callback value)

public Agent.Builder addBeforeModelCallbacks(Callback value)

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
value Callback
Returns
Type Description
Agent.Builder

addBeforeModelCallbacks(Callback.Builder builderForValue)

public Agent.Builder addBeforeModelCallbacks(Callback.Builder builderForValue)

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
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addBeforeModelCallbacks(int index, Callback value)

public Agent.Builder addBeforeModelCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

addBeforeModelCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder addBeforeModelCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addBeforeModelCallbacksBuilder()

public Callback.Builder addBeforeModelCallbacksBuilder()

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
Callback.Builder

addBeforeModelCallbacksBuilder(int index)

public Callback.Builder addBeforeModelCallbacksBuilder(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.Builder

addBeforeToolCallbacks(Callback value)

public Agent.Builder addBeforeToolCallbacks(Callback value)

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
value Callback
Returns
Type Description
Agent.Builder

addBeforeToolCallbacks(Callback.Builder builderForValue)

public Agent.Builder addBeforeToolCallbacks(Callback.Builder builderForValue)

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
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addBeforeToolCallbacks(int index, Callback value)

public Agent.Builder addBeforeToolCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

addBeforeToolCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder addBeforeToolCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

addBeforeToolCallbacksBuilder()

public Callback.Builder addBeforeToolCallbacksBuilder()

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
Callback.Builder

addBeforeToolCallbacksBuilder(int index)

public Callback.Builder addBeforeToolCallbacksBuilder(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.Builder

addChildAgents(String value)

public Agent.Builder addChildAgents(String value)

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
value String

The childAgents to add.

Returns
Type Description
Agent.Builder

This builder for chaining.

addChildAgentsBytes(ByteString value)

public Agent.Builder addChildAgentsBytes(ByteString value)

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
value ByteString

The bytes of the childAgents to add.

Returns
Type Description
Agent.Builder

This builder for chaining.

addGuardrails(String value)

public Agent.Builder addGuardrails(String value)

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
value String

The guardrails to add.

Returns
Type Description
Agent.Builder

This builder for chaining.

addGuardrailsBytes(ByteString value)

public Agent.Builder addGuardrailsBytes(ByteString value)

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
value ByteString

The bytes of the guardrails to add.

Returns
Type Description
Agent.Builder

This builder for chaining.

addTools(String value)

public Agent.Builder addTools(String value)

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
value String

The tools to add.

Returns
Type Description
Agent.Builder

This builder for chaining.

addToolsBytes(ByteString value)

public Agent.Builder addToolsBytes(ByteString value)

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
value ByteString

The bytes of the tools to add.

Returns
Type Description
Agent.Builder

This builder for chaining.

addToolsets(Agent.AgentToolset value)

public Agent.Builder addToolsets(Agent.AgentToolset value)

Optional. List of toolsets for the agent.

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

Parameter
Name Description
value Agent.AgentToolset
Returns
Type Description
Agent.Builder

addToolsets(Agent.AgentToolset.Builder builderForValue)

public Agent.Builder addToolsets(Agent.AgentToolset.Builder builderForValue)

Optional. List of toolsets for the agent.

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

Parameter
Name Description
builderForValue Agent.AgentToolset.Builder
Returns
Type Description
Agent.Builder

addToolsets(int index, Agent.AgentToolset value)

public Agent.Builder addToolsets(int index, Agent.AgentToolset value)

Optional. List of toolsets for the agent.

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

Parameters
Name Description
index int
value Agent.AgentToolset
Returns
Type Description
Agent.Builder

addToolsets(int index, Agent.AgentToolset.Builder builderForValue)

public Agent.Builder addToolsets(int index, Agent.AgentToolset.Builder builderForValue)

Optional. List of toolsets for the agent.

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

Parameters
Name Description
index int
builderForValue Agent.AgentToolset.Builder
Returns
Type Description
Agent.Builder

addToolsetsBuilder()

public Agent.AgentToolset.Builder addToolsetsBuilder()

Optional. List of toolsets for the agent.

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

Returns
Type Description
Agent.AgentToolset.Builder

addToolsetsBuilder(int index)

public Agent.AgentToolset.Builder addToolsetsBuilder(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.Builder

addTransferRules(TransferRule value)

public Agent.Builder addTransferRules(TransferRule value)

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
value TransferRule
Returns
Type Description
Agent.Builder

addTransferRules(TransferRule.Builder builderForValue)

public Agent.Builder addTransferRules(TransferRule.Builder builderForValue)

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
builderForValue TransferRule.Builder
Returns
Type Description
Agent.Builder

addTransferRules(int index, TransferRule value)

public Agent.Builder addTransferRules(int index, TransferRule value)

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];

Parameters
Name Description
index int
value TransferRule
Returns
Type Description
Agent.Builder

addTransferRules(int index, TransferRule.Builder builderForValue)

public Agent.Builder addTransferRules(int index, TransferRule.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue TransferRule.Builder
Returns
Type Description
Agent.Builder

addTransferRulesBuilder()

public TransferRule.Builder addTransferRulesBuilder()

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
TransferRule.Builder

addTransferRulesBuilder(int index)

public TransferRule.Builder addTransferRulesBuilder(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.Builder

build()

public Agent build()
Returns
Type Description
Agent

buildPartial()

public Agent buildPartial()
Returns
Type Description
Agent

clear()

public Agent.Builder clear()
Returns
Type Description
Agent.Builder
Overrides

clearAfterAgentCallbacks()

public Agent.Builder clearAfterAgentCallbacks()

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
Agent.Builder

clearAfterModelCallbacks()

public Agent.Builder clearAfterModelCallbacks()

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
Agent.Builder

clearAfterToolCallbacks()

public Agent.Builder clearAfterToolCallbacks()

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
Agent.Builder

clearAgentType()

public Agent.Builder clearAgentType()
Returns
Type Description
Agent.Builder

clearBeforeAgentCallbacks()

public Agent.Builder clearBeforeAgentCallbacks()

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
Agent.Builder

clearBeforeModelCallbacks()

public Agent.Builder clearBeforeModelCallbacks()

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
Agent.Builder

clearBeforeToolCallbacks()

public Agent.Builder clearBeforeToolCallbacks()

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
Agent.Builder

clearChildAgents()

public Agent.Builder clearChildAgents()

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
Agent.Builder

This builder for chaining.

clearCreateTime()

public Agent.Builder clearCreateTime()

Output only. Timestamp when the agent was created.

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

Returns
Type Description
Agent.Builder

clearDescription()

public Agent.Builder clearDescription()

Optional. Human-readable description of the agent.

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

Returns
Type Description
Agent.Builder

This builder for chaining.

clearDisplayName()

public Agent.Builder clearDisplayName()

Required. Display name of the agent.

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

Returns
Type Description
Agent.Builder

This builder for chaining.

clearEtag()

public Agent.Builder clearEtag()

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
Agent.Builder

This builder for chaining.

clearGeneratedSummary()

public Agent.Builder clearGeneratedSummary()

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
Agent.Builder

This builder for chaining.

clearGuardrails()

public Agent.Builder clearGuardrails()

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
Agent.Builder

This builder for chaining.

clearInstruction()

public Agent.Builder clearInstruction()

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

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

Returns
Type Description
Agent.Builder

This builder for chaining.

clearLlmAgent()

public Agent.Builder clearLlmAgent()

Optional. The default agent type.

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

Returns
Type Description
Agent.Builder

clearModelSettings()

public Agent.Builder clearModelSettings()

Optional. Configurations for the LLM model.

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

Returns
Type Description
Agent.Builder

clearName()

public Agent.Builder clearName()

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
Agent.Builder

This builder for chaining.

clearRemoteDialogflowAgent()

public Agent.Builder clearRemoteDialogflowAgent()

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.Builder

clearTools()

public Agent.Builder clearTools()

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
Agent.Builder

This builder for chaining.

clearToolsets()

public Agent.Builder clearToolsets()

Optional. List of toolsets for the agent.

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

Returns
Type Description
Agent.Builder

clearTransferRules()

public Agent.Builder clearTransferRules()

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
Agent.Builder

clearUpdateTime()

public Agent.Builder clearUpdateTime()

Output only. Timestamp when the agent was last updated.

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

Returns
Type Description
Agent.Builder

getAfterAgentCallbacks(int index)

public 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

getAfterAgentCallbacksBuilder(int index)

public Callback.Builder getAfterAgentCallbacksBuilder(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.Builder

getAfterAgentCallbacksBuilderList()

public List<Callback.Builder> getAfterAgentCallbacksBuilderList()

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<Builder>

getAfterAgentCallbacksCount()

public 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 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 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 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 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

getAfterModelCallbacksBuilder(int index)

public Callback.Builder getAfterModelCallbacksBuilder(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.Builder

getAfterModelCallbacksBuilderList()

public List<Callback.Builder> getAfterModelCallbacksBuilderList()

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<Builder>

getAfterModelCallbacksCount()

public 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 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 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 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 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

getAfterToolCallbacksBuilder(int index)

public Callback.Builder getAfterToolCallbacksBuilder(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.Builder

getAfterToolCallbacksBuilderList()

public List<Callback.Builder> getAfterToolCallbacksBuilderList()

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<Builder>

getAfterToolCallbacksCount()

public 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 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 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 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 Agent.AgentTypeCase getAgentTypeCase()
Returns
Type Description
Agent.AgentTypeCase

getBeforeAgentCallbacks(int index)

public 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

getBeforeAgentCallbacksBuilder(int index)

public Callback.Builder getBeforeAgentCallbacksBuilder(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.Builder

getBeforeAgentCallbacksBuilderList()

public List<Callback.Builder> getBeforeAgentCallbacksBuilderList()

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<Builder>

getBeforeAgentCallbacksCount()

public 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 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 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 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 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

getBeforeModelCallbacksBuilder(int index)

public Callback.Builder getBeforeModelCallbacksBuilder(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.Builder

getBeforeModelCallbacksBuilderList()

public List<Callback.Builder> getBeforeModelCallbacksBuilderList()

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<Builder>

getBeforeModelCallbacksCount()

public 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 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 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 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 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

getBeforeToolCallbacksBuilder(int index)

public Callback.Builder getBeforeToolCallbacksBuilder(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.Builder

getBeforeToolCallbacksBuilderList()

public List<Callback.Builder> getBeforeToolCallbacksBuilderList()

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<Builder>

getBeforeToolCallbacksCount()

public 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 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the childAgents.

getCreateTime()

public 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when the agent was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public Agent getDefaultInstanceForType()
Returns
Type Description
Agent

getDescription()

public 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 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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public 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 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 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 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the guardrails.

getInstruction()

public 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 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 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.

getLlmAgentBuilder()

public Agent.LlmAgent.Builder getLlmAgentBuilder()

Optional. The default agent type.

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

Returns
Type Description
Agent.LlmAgent.Builder

getLlmAgentOrBuilder()

public 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 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.

getModelSettingsBuilder()

public ModelSettings.Builder getModelSettingsBuilder()

Optional. Configurations for the LLM model.

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

Returns
Type Description
ModelSettings.Builder

getModelSettingsOrBuilder()

public 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 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 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 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.

getRemoteDialogflowAgentBuilder()

public Agent.RemoteDialogflowAgent.Builder getRemoteDialogflowAgentBuilder()

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.Builder

getRemoteDialogflowAgentOrBuilder()

public 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the tools.

getToolsets(int index)

public 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

getToolsetsBuilder(int index)

public Agent.AgentToolset.Builder getToolsetsBuilder(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.Builder

getToolsetsBuilderList()

public List<Agent.AgentToolset.Builder> getToolsetsBuilderList()

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<Builder>

getToolsetsCount()

public 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 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 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 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 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

getTransferRulesBuilder(int index)

public TransferRule.Builder getTransferRulesBuilder(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.Builder

getTransferRulesBuilderList()

public List<TransferRule.Builder> getTransferRulesBuilderList()

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<Builder>

getTransferRulesCount()

public 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 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 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 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 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when the agent was last updated.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Agent.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when the agent was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Agent.Builder

mergeFrom(Agent other)

public Agent.Builder mergeFrom(Agent other)
Parameter
Name Description
other Agent
Returns
Type Description
Agent.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Agent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Agent.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Agent.Builder
Overrides

mergeLlmAgent(Agent.LlmAgent value)

public Agent.Builder mergeLlmAgent(Agent.LlmAgent value)

Optional. The default agent type.

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

Parameter
Name Description
value Agent.LlmAgent
Returns
Type Description
Agent.Builder

mergeModelSettings(ModelSettings value)

public Agent.Builder mergeModelSettings(ModelSettings value)

Optional. Configurations for the LLM model.

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

Parameter
Name Description
value ModelSettings
Returns
Type Description
Agent.Builder

mergeRemoteDialogflowAgent(Agent.RemoteDialogflowAgent value)

public Agent.Builder mergeRemoteDialogflowAgent(Agent.RemoteDialogflowAgent value)

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];

Parameter
Name Description
value Agent.RemoteDialogflowAgent
Returns
Type Description
Agent.Builder

mergeUpdateTime(Timestamp value)

public Agent.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when the agent was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Agent.Builder

removeAfterAgentCallbacks(int index)

public Agent.Builder removeAfterAgentCallbacks(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
Agent.Builder

removeAfterModelCallbacks(int index)

public Agent.Builder removeAfterModelCallbacks(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
Agent.Builder

removeAfterToolCallbacks(int index)

public Agent.Builder removeAfterToolCallbacks(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
Agent.Builder

removeBeforeAgentCallbacks(int index)

public Agent.Builder removeBeforeAgentCallbacks(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
Agent.Builder

removeBeforeModelCallbacks(int index)

public Agent.Builder removeBeforeModelCallbacks(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
Agent.Builder

removeBeforeToolCallbacks(int index)

public Agent.Builder removeBeforeToolCallbacks(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
Agent.Builder

removeToolsets(int index)

public Agent.Builder removeToolsets(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.Builder

removeTransferRules(int index)

public Agent.Builder removeTransferRules(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
Agent.Builder

setAfterAgentCallbacks(int index, Callback value)

public Agent.Builder setAfterAgentCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

setAfterAgentCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder setAfterAgentCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

setAfterModelCallbacks(int index, Callback value)

public Agent.Builder setAfterModelCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

setAfterModelCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder setAfterModelCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

setAfterToolCallbacks(int index, Callback value)

public Agent.Builder setAfterToolCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

setAfterToolCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder setAfterToolCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

setBeforeAgentCallbacks(int index, Callback value)

public Agent.Builder setBeforeAgentCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

setBeforeAgentCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder setBeforeAgentCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

setBeforeModelCallbacks(int index, Callback value)

public Agent.Builder setBeforeModelCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

setBeforeModelCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder setBeforeModelCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

setBeforeToolCallbacks(int index, Callback value)

public Agent.Builder setBeforeToolCallbacks(int index, Callback value)

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];

Parameters
Name Description
index int
value Callback
Returns
Type Description
Agent.Builder

setBeforeToolCallbacks(int index, Callback.Builder builderForValue)

public Agent.Builder setBeforeToolCallbacks(int index, Callback.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Callback.Builder
Returns
Type Description
Agent.Builder

setChildAgents(int index, String value)

public Agent.Builder setChildAgents(int index, String value)

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) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The childAgents to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Agent.Builder setCreateTime(Timestamp value)

Output only. Timestamp when the agent was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Agent.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Agent.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the agent was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Agent.Builder

setDescription(String value)

public Agent.Builder setDescription(String value)

Optional. Human-readable description of the agent.

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Agent.Builder setDescriptionBytes(ByteString value)

Optional. Human-readable description of the agent.

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setDisplayName(String value)

public Agent.Builder setDisplayName(String value)

Required. Display name of the agent.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Agent.Builder setDisplayNameBytes(ByteString value)

Required. Display name of the agent.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setEtag(String value)

public Agent.Builder setEtag(String value)

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;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Agent.Builder setEtagBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setGeneratedSummary(String value)

public Agent.Builder setGeneratedSummary(String value)

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];

Parameter
Name Description
value String

The generatedSummary to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setGeneratedSummaryBytes(ByteString value)

public Agent.Builder setGeneratedSummaryBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for generatedSummary to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setGuardrails(int index, String value)

public Agent.Builder setGuardrails(int index, String value)

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) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The guardrails to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setInstruction(String value)

public Agent.Builder setInstruction(String value)

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

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

Parameter
Name Description
value String

The instruction to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setInstructionBytes(ByteString value)

public Agent.Builder setInstructionBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for instruction to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setLlmAgent(Agent.LlmAgent value)

public Agent.Builder setLlmAgent(Agent.LlmAgent value)

Optional. The default agent type.

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

Parameter
Name Description
value Agent.LlmAgent
Returns
Type Description
Agent.Builder

setLlmAgent(Agent.LlmAgent.Builder builderForValue)

public Agent.Builder setLlmAgent(Agent.LlmAgent.Builder builderForValue)

Optional. The default agent type.

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

Parameter
Name Description
builderForValue Agent.LlmAgent.Builder
Returns
Type Description
Agent.Builder

setModelSettings(ModelSettings value)

public Agent.Builder setModelSettings(ModelSettings value)

Optional. Configurations for the LLM model.

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

Parameter
Name Description
value ModelSettings
Returns
Type Description
Agent.Builder

setModelSettings(ModelSettings.Builder builderForValue)

public Agent.Builder setModelSettings(ModelSettings.Builder builderForValue)

Optional. Configurations for the LLM model.

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

Parameter
Name Description
builderForValue ModelSettings.Builder
Returns
Type Description
Agent.Builder

setName(String value)

public Agent.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Agent.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setRemoteDialogflowAgent(Agent.RemoteDialogflowAgent value)

public Agent.Builder setRemoteDialogflowAgent(Agent.RemoteDialogflowAgent value)

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];

Parameter
Name Description
value Agent.RemoteDialogflowAgent
Returns
Type Description
Agent.Builder

setRemoteDialogflowAgent(Agent.RemoteDialogflowAgent.Builder builderForValue)

public Agent.Builder setRemoteDialogflowAgent(Agent.RemoteDialogflowAgent.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Agent.RemoteDialogflowAgent.Builder
Returns
Type Description
Agent.Builder

setTools(int index, String value)

public Agent.Builder setTools(int index, String value)

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) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The tools to set.

Returns
Type Description
Agent.Builder

This builder for chaining.

setToolsets(int index, Agent.AgentToolset value)

public Agent.Builder setToolsets(int index, Agent.AgentToolset value)

Optional. List of toolsets for the agent.

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

Parameters
Name Description
index int
value Agent.AgentToolset
Returns
Type Description
Agent.Builder

setToolsets(int index, Agent.AgentToolset.Builder builderForValue)

public Agent.Builder setToolsets(int index, Agent.AgentToolset.Builder builderForValue)

Optional. List of toolsets for the agent.

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

Parameters
Name Description
index int
builderForValue Agent.AgentToolset.Builder
Returns
Type Description
Agent.Builder

setTransferRules(int index, TransferRule value)

public Agent.Builder setTransferRules(int index, TransferRule value)

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];

Parameters
Name Description
index int
value TransferRule
Returns
Type Description
Agent.Builder

setTransferRules(int index, TransferRule.Builder builderForValue)

public Agent.Builder setTransferRules(int index, TransferRule.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue TransferRule.Builder
Returns
Type Description
Agent.Builder

setUpdateTime(Timestamp value)

public Agent.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when the agent was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Agent.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Agent.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the agent was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Agent.Builder