com.google.cloud.aiplatform.v1beta1

Class EventMetadata.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

com.google.cloud.aiplatform.v1beta1.EventMetadata.Builder

All Implemented Interfaces:

EventMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

EventMetadata

public static final class EventMetadata.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>
implements EventMetadataOrBuilder

 Metadata relating to a LLM response event.
 

Protobuf type google.cloud.aiplatform.v1beta1.EventMetadata

Method Summary

Modifier and Type	Method and Description
EventMetadata.Builder	addAllLongRunningToolIds(Iterable<String> values) Optional.
EventMetadata.Builder	addLongRunningToolIds(String value) Optional.
EventMetadata.Builder	addLongRunningToolIdsBytes(com.google.protobuf.ByteString value) Optional.
EventMetadata.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
EventMetadata	build()
EventMetadata	buildPartial()
EventMetadata.Builder	clear()
EventMetadata.Builder	clearBranch() Optional.
EventMetadata.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
EventMetadata.Builder	clearGroundingMetadata() Optional.
EventMetadata.Builder	clearInterrupted() Optional.
EventMetadata.Builder	clearLongRunningToolIds() Optional.
EventMetadata.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
EventMetadata.Builder	clearPartial() Optional.
EventMetadata.Builder	clearTurnComplete() Optional.
EventMetadata.Builder	clone()
String	getBranch() Optional.
com.google.protobuf.ByteString	getBranchBytes() Optional.
EventMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
GroundingMetadata	getGroundingMetadata() Optional.
GroundingMetadata.Builder	getGroundingMetadataBuilder() Optional.
GroundingMetadataOrBuilder	getGroundingMetadataOrBuilder() Optional.
boolean	getInterrupted() Optional.
String	getLongRunningToolIds(int index) Optional.
com.google.protobuf.ByteString	getLongRunningToolIdsBytes(int index) Optional.
int	getLongRunningToolIdsCount() Optional.
com.google.protobuf.ProtocolStringList	getLongRunningToolIdsList() Optional.
boolean	getPartial() Optional.
boolean	getTurnComplete() Optional.
boolean	hasGroundingMetadata() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
EventMetadata.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
EventMetadata.Builder	mergeFrom(EventMetadata other)
EventMetadata.Builder	mergeFrom(com.google.protobuf.Message other)
EventMetadata.Builder	mergeGroundingMetadata(GroundingMetadata value) Optional.
EventMetadata.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
EventMetadata.Builder	setBranch(String value) Optional.
EventMetadata.Builder	setBranchBytes(com.google.protobuf.ByteString value) Optional.
EventMetadata.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
EventMetadata.Builder	setGroundingMetadata(GroundingMetadata.Builder builderForValue) Optional.
EventMetadata.Builder	setGroundingMetadata(GroundingMetadata value) Optional.
EventMetadata.Builder	setInterrupted(boolean value) Optional.
EventMetadata.Builder	setLongRunningToolIds(int index, String value) Optional.
EventMetadata.Builder	setPartial(boolean value) Optional.
EventMetadata.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
EventMetadata.Builder	setTurnComplete(boolean value) Optional.
EventMetadata.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

clear

public EventMetadata.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

getDefaultInstanceForType

public EventMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public EventMetadata build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public EventMetadata buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public EventMetadata.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

setField

public EventMetadata.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

clearField

public EventMetadata.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

clearOneof

public EventMetadata.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

setRepeatedField

public EventMetadata.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

addRepeatedField

public EventMetadata.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

mergeFrom

public EventMetadata.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<EventMetadata.Builder>

mergeFrom

public EventMetadata.Builder mergeFrom(EventMetadata other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

mergeFrom

public EventMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<EventMetadata.Builder>

Throws:

IOException

hasGroundingMetadata

public boolean hasGroundingMetadata()

 Optional. Metadata returned to client when grounding is enabled.
 

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasGroundingMetadata in interface EventMetadataOrBuilder

Returns:

Whether the groundingMetadata field is set.

getGroundingMetadata

public GroundingMetadata getGroundingMetadata()

 Optional. Metadata returned to client when grounding is enabled.
 

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGroundingMetadata in interface EventMetadataOrBuilder

Returns:

The groundingMetadata.

setGroundingMetadata

public EventMetadata.Builder setGroundingMetadata(GroundingMetadata value)

 Optional. Metadata returned to client when grounding is enabled.
 

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

setGroundingMetadata

public EventMetadata.Builder setGroundingMetadata(GroundingMetadata.Builder builderForValue)

 Optional. Metadata returned to client when grounding is enabled.
 

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

mergeGroundingMetadata

public EventMetadata.Builder mergeGroundingMetadata(GroundingMetadata value)

 Optional. Metadata returned to client when grounding is enabled.
 

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

clearGroundingMetadata

public EventMetadata.Builder clearGroundingMetadata()

 Optional. Metadata returned to client when grounding is enabled.
 

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

getGroundingMetadataBuilder

public GroundingMetadata.Builder getGroundingMetadataBuilder()

 Optional. Metadata returned to client when grounding is enabled.
 

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

getGroundingMetadataOrBuilder

public GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()

 Optional. Metadata returned to client when grounding is enabled.
 

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGroundingMetadataOrBuilder in interface EventMetadataOrBuilder

getPartial

public boolean getPartial()

 Optional. Indicates whether the text content is part of a unfinished text
 stream. Only used for streaming mode and when the content is plain text.
 

bool partial = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPartial in interface EventMetadataOrBuilder

Returns:

The partial.

setPartial

public EventMetadata.Builder setPartial(boolean value)

 Optional. Indicates whether the text content is part of a unfinished text
 stream. Only used for streaming mode and when the content is plain text.
 

bool partial = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The partial to set.

Returns:

This builder for chaining.

clearPartial

public EventMetadata.Builder clearPartial()

 Optional. Indicates whether the text content is part of a unfinished text
 stream. Only used for streaming mode and when the content is plain text.
 

bool partial = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

getTurnComplete

public boolean getTurnComplete()

 Optional. Indicates whether the response from the model is complete.
 Only used for streaming mode.
 

bool turn_complete = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTurnComplete in interface EventMetadataOrBuilder

Returns:

The turnComplete.

setTurnComplete

public EventMetadata.Builder setTurnComplete(boolean value)

 Optional. Indicates whether the response from the model is complete.
 Only used for streaming mode.
 

bool turn_complete = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The turnComplete to set.

Returns:

This builder for chaining.

clearTurnComplete

public EventMetadata.Builder clearTurnComplete()

 Optional. Indicates whether the response from the model is complete.
 Only used for streaming mode.
 

bool turn_complete = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

getInterrupted

public boolean getInterrupted()

 Optional. Flag indicating that LLM was interrupted when generating the
 content. Usually it's due to user interruption during a bidi streaming.
 

bool interrupted = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getInterrupted in interface EventMetadataOrBuilder

Returns:

The interrupted.

setInterrupted

public EventMetadata.Builder setInterrupted(boolean value)

 Optional. Flag indicating that LLM was interrupted when generating the
 content. Usually it's due to user interruption during a bidi streaming.
 

bool interrupted = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The interrupted to set.

Returns:

This builder for chaining.

clearInterrupted

public EventMetadata.Builder clearInterrupted()

 Optional. Flag indicating that LLM was interrupted when generating the
 content. Usually it's due to user interruption during a bidi streaming.
 

bool interrupted = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

getLongRunningToolIdsList

public com.google.protobuf.ProtocolStringList getLongRunningToolIdsList()

 Optional. Set of ids of the long running function calls.
 Agent client will know from this field about which function call is long
 running. Only valid for function call event.
 

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLongRunningToolIdsList in interface EventMetadataOrBuilder

Returns:

A list containing the longRunningToolIds.

getLongRunningToolIdsCount

public int getLongRunningToolIdsCount()

 Optional. Set of ids of the long running function calls.
 Agent client will know from this field about which function call is long
 running. Only valid for function call event.
 

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLongRunningToolIdsCount in interface EventMetadataOrBuilder

Returns:

The count of longRunningToolIds.

getLongRunningToolIds

public String getLongRunningToolIds(int index)

 Optional. Set of ids of the long running function calls.
 Agent client will know from this field about which function call is long
 running. Only valid for function call event.
 

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLongRunningToolIds in interface EventMetadataOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The longRunningToolIds at the given index.

getLongRunningToolIdsBytes

public com.google.protobuf.ByteString getLongRunningToolIdsBytes(int index)

 Optional. Set of ids of the long running function calls.
 Agent client will know from this field about which function call is long
 running. Only valid for function call event.
 

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLongRunningToolIdsBytes in interface EventMetadataOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the longRunningToolIds at the given index.

setLongRunningToolIds

public EventMetadata.Builder setLongRunningToolIds(int index,
                                                   String value)

 Optional. Set of ids of the long running function calls.
 Agent client will know from this field about which function call is long
 running. Only valid for function call event.
 

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index to set the value at.

value - The longRunningToolIds to set.

Returns:

This builder for chaining.

addLongRunningToolIds

public EventMetadata.Builder addLongRunningToolIds(String value)

 Optional. Set of ids of the long running function calls.
 Agent client will know from this field about which function call is long
 running. Only valid for function call event.
 

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The longRunningToolIds to add.

Returns:

This builder for chaining.

addAllLongRunningToolIds

public EventMetadata.Builder addAllLongRunningToolIds(Iterable<String> values)

 Optional. Set of ids of the long running function calls.
 Agent client will know from this field about which function call is long
 running. Only valid for function call event.
 

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

values - The longRunningToolIds to add.

Returns:

This builder for chaining.

clearLongRunningToolIds

public EventMetadata.Builder clearLongRunningToolIds()

 Optional. Set of ids of the long running function calls.
 Agent client will know from this field about which function call is long
 running. Only valid for function call event.
 

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

addLongRunningToolIdsBytes

public EventMetadata.Builder addLongRunningToolIdsBytes(com.google.protobuf.ByteString value)

 Optional. Set of ids of the long running function calls.
 Agent client will know from this field about which function call is long
 running. Only valid for function call event.
 

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes of the longRunningToolIds to add.

Returns:

This builder for chaining.

getBranch

public String getBranch()

 Optional. The branch of the event.
 The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of
 agent_2, and agent_2 is the parent of agent_3.
 Branch is used when multiple child agents shouldn't see their siblings'
 conversation history.
 

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

Specified by:

getBranch in interface EventMetadataOrBuilder

Returns:

The branch.

getBranchBytes

public com.google.protobuf.ByteString getBranchBytes()

 Optional. The branch of the event.
 The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of
 agent_2, and agent_2 is the parent of agent_3.
 Branch is used when multiple child agents shouldn't see their siblings'
 conversation history.
 

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

Specified by:

getBranchBytes in interface EventMetadataOrBuilder

Returns:

The bytes for branch.

setBranch

public EventMetadata.Builder setBranch(String value)

 Optional. The branch of the event.
 The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of
 agent_2, and agent_2 is the parent of agent_3.
 Branch is used when multiple child agents shouldn't see their siblings'
 conversation history.
 

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

Parameters:

value - The branch to set.

Returns:

This builder for chaining.

clearBranch

public EventMetadata.Builder clearBranch()

 Optional. The branch of the event.
 The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of
 agent_2, and agent_2 is the parent of agent_3.
 Branch is used when multiple child agents shouldn't see their siblings'
 conversation history.
 

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

Returns:

This builder for chaining.

setBranchBytes

public EventMetadata.Builder setBranchBytes(com.google.protobuf.ByteString value)

 Optional. The branch of the event.
 The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of
 agent_2, and agent_2 is the parent of agent_3.
 Branch is used when multiple child agents shouldn't see their siblings'
 conversation history.
 

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

Parameters:

value - The bytes for branch to set.

Returns:

This builder for chaining.

setUnknownFields

public final EventMetadata.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>

mergeUnknownFields

public final EventMetadata.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<EventMetadata.Builder>