Class AgentEvent.Builder (3.100.0)

public static final class AgentEvent.Builder extends GeneratedMessage.Builder<AgentEvent.Builder> implements AgentEventOrBuilder

Represents a single event in the execution trace.

Protobuf type google.cloud.aiplatform.v1beta1.AgentEvent

Implements

AgentEventOrBuilder

Static Methods

getDescriptor()

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

Methods

addActiveTools(Tool value)

public AgentEvent.Builder addActiveTools(Tool value)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Tool
Returns
Type Description
AgentEvent.Builder

addActiveTools(Tool.Builder builderForValue)

public AgentEvent.Builder addActiveTools(Tool.Builder builderForValue)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Tool.Builder
Returns
Type Description
AgentEvent.Builder

addActiveTools(int index, Tool value)

public AgentEvent.Builder addActiveTools(int index, Tool value)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Tool
Returns
Type Description
AgentEvent.Builder

addActiveTools(int index, Tool.Builder builderForValue)

public AgentEvent.Builder addActiveTools(int index, Tool.Builder builderForValue)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Tool.Builder
Returns
Type Description
AgentEvent.Builder

addActiveToolsBuilder()

public Tool.Builder addActiveToolsBuilder()

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Tool.Builder

addActiveToolsBuilder(int index)

public Tool.Builder addActiveToolsBuilder(int index)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Tool.Builder

addAllActiveTools(Iterable<? extends Tool> values)

public AgentEvent.Builder addAllActiveTools(Iterable<? extends Tool> values)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.Tool>
Returns
Type Description
AgentEvent.Builder

build()

public AgentEvent build()
Returns
Type Description
AgentEvent

buildPartial()

public AgentEvent buildPartial()
Returns
Type Description
AgentEvent

clear()

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

clearActiveTools()

public AgentEvent.Builder clearActiveTools()

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AgentEvent.Builder

clearAuthor()

public AgentEvent.Builder clearAuthor()

Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.

optional string author = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AgentEvent.Builder

This builder for chaining.

clearContent()

public AgentEvent.Builder clearContent()

Required. The content of the event (e.g., text response, tool call, tool response).

optional .google.cloud.aiplatform.v1beta1.Content content = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AgentEvent.Builder

clearEventTime()

public AgentEvent.Builder clearEventTime()

Optional. The timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AgentEvent.Builder

clearStateDelta()

public AgentEvent.Builder clearStateDelta()

Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.

.google.protobuf.Struct state_delta = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AgentEvent.Builder

getActiveTools(int index)

public Tool getActiveTools(int index)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Tool

getActiveToolsBuilder(int index)

public Tool.Builder getActiveToolsBuilder(int index)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Tool.Builder

getActiveToolsBuilderList()

public List<Tool.Builder> getActiveToolsBuilderList()

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getActiveToolsCount()

public int getActiveToolsCount()

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getActiveToolsList()

public List<Tool> getActiveToolsList()

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Tool>

getActiveToolsOrBuilder(int index)

public ToolOrBuilder getActiveToolsOrBuilder(int index)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ToolOrBuilder

getActiveToolsOrBuilderList()

public List<? extends ToolOrBuilder> getActiveToolsOrBuilderList()

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.ToolOrBuilder>

getAuthor()

public String getAuthor()

Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.

optional string author = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The author.

getAuthorBytes()

public ByteString getAuthorBytes()

Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.

optional string author = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for author.

getContent()

public Content getContent()

Required. The content of the event (e.g., text response, tool call, tool response).

optional .google.cloud.aiplatform.v1beta1.Content content = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Content

The content.

getContentBuilder()

public Content.Builder getContentBuilder()

Required. The content of the event (e.g., text response, tool call, tool response).

optional .google.cloud.aiplatform.v1beta1.Content content = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Content.Builder

getContentOrBuilder()

public ContentOrBuilder getContentOrBuilder()

Required. The content of the event (e.g., text response, tool call, tool response).

optional .google.cloud.aiplatform.v1beta1.Content content = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ContentOrBuilder

getDefaultInstanceForType()

public AgentEvent getDefaultInstanceForType()
Returns
Type Description
AgentEvent

getDescriptorForType()

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

getEventTime()

public Timestamp getEventTime()

Optional. The timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The eventTime.

getEventTimeBuilder()

public Timestamp.Builder getEventTimeBuilder()

Optional. The timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getEventTimeOrBuilder()

public TimestampOrBuilder getEventTimeOrBuilder()

Optional. The timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getStateDelta()

public Struct getStateDelta()

Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.

.google.protobuf.Struct state_delta = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The stateDelta.

getStateDeltaBuilder()

public Struct.Builder getStateDeltaBuilder()

Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.

.google.protobuf.Struct state_delta = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getStateDeltaOrBuilder()

public StructOrBuilder getStateDeltaOrBuilder()

Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.

.google.protobuf.Struct state_delta = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

hasAuthor()

public boolean hasAuthor()

Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.

optional string author = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the author field is set.

hasContent()

public boolean hasContent()

Required. The content of the event (e.g., text response, tool call, tool response).

optional .google.cloud.aiplatform.v1beta1.Content content = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the content field is set.

hasEventTime()

public boolean hasEventTime()

Optional. The timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the eventTime field is set.

hasStateDelta()

public boolean hasStateDelta()

Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.

.google.protobuf.Struct state_delta = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the stateDelta field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeContent(Content value)

public AgentEvent.Builder mergeContent(Content value)

Required. The content of the event (e.g., text response, tool call, tool response).

optional .google.cloud.aiplatform.v1beta1.Content content = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Content
Returns
Type Description
AgentEvent.Builder

mergeEventTime(Timestamp value)

public AgentEvent.Builder mergeEventTime(Timestamp value)

Optional. The timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
AgentEvent.Builder

mergeFrom(AgentEvent other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeStateDelta(Struct value)

public AgentEvent.Builder mergeStateDelta(Struct value)

Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.

.google.protobuf.Struct state_delta = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
AgentEvent.Builder

removeActiveTools(int index)

public AgentEvent.Builder removeActiveTools(int index)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AgentEvent.Builder

setActiveTools(int index, Tool value)

public AgentEvent.Builder setActiveTools(int index, Tool value)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Tool
Returns
Type Description
AgentEvent.Builder

setActiveTools(int index, Tool.Builder builderForValue)

public AgentEvent.Builder setActiveTools(int index, Tool.Builder builderForValue)

Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the AgentConfig.tools if set.

repeated .google.cloud.aiplatform.v1beta1.Tool active_tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Tool.Builder
Returns
Type Description
AgentEvent.Builder

setAuthor(String value)

public AgentEvent.Builder setAuthor(String value)

Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.

optional string author = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The author to set.

Returns
Type Description
AgentEvent.Builder

This builder for chaining.

setAuthorBytes(ByteString value)

public AgentEvent.Builder setAuthorBytes(ByteString value)

Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.

optional string author = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for author to set.

Returns
Type Description
AgentEvent.Builder

This builder for chaining.

setContent(Content value)

public AgentEvent.Builder setContent(Content value)

Required. The content of the event (e.g., text response, tool call, tool response).

optional .google.cloud.aiplatform.v1beta1.Content content = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Content
Returns
Type Description
AgentEvent.Builder

setContent(Content.Builder builderForValue)

public AgentEvent.Builder setContent(Content.Builder builderForValue)

Required. The content of the event (e.g., text response, tool call, tool response).

optional .google.cloud.aiplatform.v1beta1.Content content = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Content.Builder
Returns
Type Description
AgentEvent.Builder

setEventTime(Timestamp value)

public AgentEvent.Builder setEventTime(Timestamp value)

Optional. The timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
AgentEvent.Builder

setEventTime(Timestamp.Builder builderForValue)

public AgentEvent.Builder setEventTime(Timestamp.Builder builderForValue)

Optional. The timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AgentEvent.Builder

setStateDelta(Struct value)

public AgentEvent.Builder setStateDelta(Struct value)

Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.

.google.protobuf.Struct state_delta = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
AgentEvent.Builder

setStateDelta(Struct.Builder builderForValue)

public AgentEvent.Builder setStateDelta(Struct.Builder builderForValue)

Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.

.google.protobuf.Struct state_delta = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AgentEvent.Builder