Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class EventMetadata (3.84.0)

public final class EventMetadata extends GeneratedMessage implements EventMetadataOrBuilder

Metadata relating to a LLM response event.

Protobuf type google.cloud.aiplatform.v1beta1.EventMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > EventMetadata

Implements

EventMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BRANCH_FIELD_NUMBER

public static final int BRANCH_FIELD_NUMBER

Field Value
Type	Description
`int`

CUSTOM_METADATA_FIELD_NUMBER

public static final int CUSTOM_METADATA_FIELD_NUMBER

Field Value
Type	Description
`int`

GROUNDING_METADATA_FIELD_NUMBER

public static final int GROUNDING_METADATA_FIELD_NUMBER

Field Value
Type	Description
`int`

INTERRUPTED_FIELD_NUMBER

public static final int INTERRUPTED_FIELD_NUMBER

Field Value
Type	Description
`int`

LONG_RUNNING_TOOL_IDS_FIELD_NUMBER

public static final int LONG_RUNNING_TOOL_IDS_FIELD_NUMBER

Field Value
Type	Description
`int`

PARTIAL_FIELD_NUMBER

public static final int PARTIAL_FIELD_NUMBER

Field Value
Type	Description
`int`

TURN_COMPLETE_FIELD_NUMBER

public static final int TURN_COMPLETE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static EventMetadata getDefaultInstance()

Returns
Type	Description
`EventMetadata`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static EventMetadata.Builder newBuilder()

Returns
Type	Description
`EventMetadata.Builder`

newBuilder(EventMetadata prototype)

public static EventMetadata.Builder newBuilder(EventMetadata prototype)

Parameter
Name	Description
`prototype`	`EventMetadata`

Returns
Type	Description
`EventMetadata.Builder`

parseDelimitedFrom(InputStream input)

public static EventMetadata parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static EventMetadata parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EventMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static EventMetadata parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EventMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static EventMetadata parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EventMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static EventMetadata parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static EventMetadata parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EventMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EventMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<EventMetadata> parser()

Returns
Type	Description
`Parser<EventMetadata>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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

Returns
Type	Description
`String`	The branch.

getBranchBytes()

public ByteString getBranchBytes()

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

Returns
Type	Description
`ByteString`	The bytes for branch.

getCustomMetadata()

public Struct getCustomMetadata()

The custom metadata of the LlmResponse.

.google.protobuf.Struct custom_metadata = 7;

Returns
Type	Description
`Struct`	The customMetadata.

getCustomMetadataOrBuilder()

public StructOrBuilder getCustomMetadataOrBuilder()

The custom metadata of the LlmResponse.

.google.protobuf.Struct custom_metadata = 7;

Returns
Type	Description
`StructOrBuilder`

getDefaultInstanceForType()

public EventMetadata getDefaultInstanceForType()

Returns
Type	Description
`EventMetadata`

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

Returns
Type	Description
`GroundingMetadata`	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];

Returns
Type	Description
`GroundingMetadataOrBuilder`

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

Returns
Type	Description
`boolean`	The interrupted.

getLongRunningToolIds(int index)

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
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The longRunningToolIds at the given index.

getLongRunningToolIdsBytes(int 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
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the longRunningToolIds at the given index.

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

Returns
Type	Description
`int`	The count of longRunningToolIds.

getLongRunningToolIdsList()

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

Returns
Type	Description
`ProtocolStringList`	A list containing the longRunningToolIds.

getParserForType()

public Parser<EventMetadata> getParserForType()

Returns
Type	Description
`Parser<EventMetadata>`

Overrides

GeneratedMessage.getParserForType()

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

Returns
Type	Description
`boolean`	The partial.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

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

Returns
Type	Description
`boolean`	The turnComplete.

hasCustomMetadata()

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.

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

Returns
Type	Description
`boolean`	Whether the groundingMetadata field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public EventMetadata.Builder newBuilderForType()

Returns
Type	Description
`EventMetadata.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected EventMetadata.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`EventMetadata.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public EventMetadata.Builder toBuilder()

Returns
Type	Description
`EventMetadata.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`