Send feedback
Class EventMetadata (3.79.0)
Version latestkeyboard_arrow_down
public final class EventMetadata extends GeneratedMessageV3 implements EventMetadataOrBuilder
Metadata relating to a LLM response event.
Protobuf type google.cloud.aiplatform.v1beta1.EventMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int BRANCH_FIELD_NUMBER
Field Value
Type Description
int
public static final int CUSTOM_METADATA_FIELD_NUMBER
Field Value
Type Description
int
public static final int GROUNDING_METADATA_FIELD_NUMBER
Field Value
Type Description
int
public static final int INTERRUPTED_FIELD_NUMBER
Field Value
Type Description
int
public static final int LONG_RUNNING_TOOL_IDS_FIELD_NUMBER
Field Value
Type Description
int
public static final int PARTIAL_FIELD_NUMBER
Field Value
Type Description
int
public static final int TURN_COMPLETE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static EventMetadata getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static EventMetadata . Builder newBuilder ()
public static EventMetadata . Builder newBuilder ( EventMetadata prototype )
public static EventMetadata parseDelimitedFrom ( InputStream input )
public static EventMetadata parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static EventMetadata parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static EventMetadata parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static EventMetadata parseFrom ( ByteString data )
public static EventMetadata parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static EventMetadata parseFrom ( CodedInputStream input )
public static EventMetadata parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static EventMetadata parseFrom ( InputStream input )
public static EventMetadata parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static EventMetadata parseFrom ( ByteBuffer data )
public static EventMetadata parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<EventMetadata> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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];
Returns
Type Description
String The branch.
public 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];
Returns
Type Description
ByteString The bytes for branch.
public Struct getCustomMetadata ()
The custom metadata of the LlmResponse.
.google.protobuf.Struct custom_metadata = 7;
Returns
Type Description
Struct The customMetadata.
public StructOrBuilder getCustomMetadataOrBuilder ()
The custom metadata of the LlmResponse.
.google.protobuf.Struct custom_metadata = 7;
public EventMetadata getDefaultInstanceForType ()
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];
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];
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];
Returns
Type Description
boolean The interrupted.
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];
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
String The longRunningToolIds at the given index.
public 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];
Parameter
Name Description
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the longRunningToolIds at the given index.
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];
Returns
Type Description
int The count of longRunningToolIds.
public 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];
public Parser<EventMetadata> getParserForType ()
Overrides
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];
Returns
Type Description
boolean The partial.
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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];
Returns
Type Description
boolean The turnComplete.
public boolean hasCustomMetadata ()
The custom metadata of the LlmResponse.
.google.protobuf.Struct custom_metadata = 7;
Returns
Type Description
boolean Whether the customMetadata field is set.
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];
Returns
Type Description
boolean Whether the groundingMetadata field is set.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public EventMetadata . Builder newBuilderForType ()
protected EventMetadata . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public EventMetadata . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
