com.google.cloud.aiplatform.v1beta1

Class EventMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.EventMetadata

All Implemented Interfaces:

EventMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class EventMetadata
extends com.google.protobuf.GeneratedMessageV3
implements EventMetadataOrBuilder

 Metadata relating to a LLM response event.
 

Protobuf type google.cloud.aiplatform.v1beta1.EventMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventMetadata.Builder Metadata relating to a LLM response event.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BRANCH_FIELD_NUMBER
static int	GROUNDING_METADATA_FIELD_NUMBER
static int	INTERRUPTED_FIELD_NUMBER
static int	LONG_RUNNING_TOOL_IDS_FIELD_NUMBER
static int	PARTIAL_FIELD_NUMBER
static int	TURN_COMPLETE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBranch() Optional.
com.google.protobuf.ByteString	getBranchBytes() Optional.
static EventMetadata	getDefaultInstance()
EventMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
GroundingMetadata	getGroundingMetadata() 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.
com.google.protobuf.Parser<EventMetadata>	getParserForType()
boolean	getPartial() Optional.
int	getSerializedSize()
boolean	getTurnComplete() Optional.
boolean	hasGroundingMetadata() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static EventMetadata.Builder	newBuilder()
static EventMetadata.Builder	newBuilder(EventMetadata prototype)
EventMetadata.Builder	newBuilderForType()
protected EventMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static EventMetadata	parseDelimitedFrom(InputStream input)
static EventMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EventMetadata	parseFrom(byte[] data)
static EventMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EventMetadata	parseFrom(ByteBuffer data)
static EventMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EventMetadata	parseFrom(com.google.protobuf.ByteString data)
static EventMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EventMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static EventMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EventMetadata	parseFrom(InputStream input)
static EventMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<EventMetadata>	parser()
EventMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

GROUNDING_METADATA_FIELD_NUMBER

public static final int GROUNDING_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

PARTIAL_FIELD_NUMBER

public static final int PARTIAL_FIELD_NUMBER

See Also:

Constant Field Values

TURN_COMPLETE_FIELD_NUMBER

public static final int TURN_COMPLETE_FIELD_NUMBER

See Also:

Constant Field Values

INTERRUPTED_FIELD_NUMBER

public static final int INTERRUPTED_FIELD_NUMBER

See Also:

Constant Field Values

LONG_RUNNING_TOOL_IDS_FIELD_NUMBER

public static final int LONG_RUNNING_TOOL_IDS_FIELD_NUMBER

See Also:

Constant Field Values

BRANCH_FIELD_NUMBER

public static final int BRANCH_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

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.

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.

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static EventMetadata parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EventMetadata parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EventMetadata parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EventMetadata parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EventMetadata parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EventMetadata parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EventMetadata parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static EventMetadata parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static EventMetadata parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static EventMetadata parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static EventMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static EventMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public EventMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static EventMetadata.Builder newBuilder()

newBuilder

public static EventMetadata.Builder newBuilder(EventMetadata prototype)

toBuilder

public EventMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected EventMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static EventMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<EventMetadata> parser()

getParserForType

public com.google.protobuf.Parser<EventMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public EventMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder