- 3.64.0 (latest)
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class EventMetadata.Builder extends GeneratedMessageV3.Builder.Builder> implements EventMetadataOrBuilder Metadata relating to a LLM response event.
Protobuf type google.cloud.aiplatform.v1beta1.EventMetadata
Inheritance
Object > AbstractMessageLite.BuilderImplements
EventMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllLongRunningToolIds(Iterable values)
public EventMetadata.Builder addAllLongRunningToolIds(IterableOptional. 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 |
values |
Iterable<String>The longRunningToolIds to add. |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
addLongRunningToolIds(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe longRunningToolIds to add. |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
addLongRunningToolIdsBytes(ByteString value)
public EventMetadata.Builder addLongRunningToolIdsBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the longRunningToolIds to add. |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public EventMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
build()
public EventMetadata build()| Returns | |
|---|---|
| Type | Description |
EventMetadata |
|
buildPartial()
public EventMetadata buildPartial()| Returns | |
|---|---|
| Type | Description |
EventMetadata |
|
clear()
public EventMetadata.Builder clear()| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
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 | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public EventMetadata.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
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 | |
|---|---|
| Type | Description |
EventMetadata.Builder |
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 | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public EventMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
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 | |
|---|---|
| Type | Description |
EventMetadata.Builder |
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 | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
clone()
public EventMetadata.Builder clone()| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
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()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. |
getDefaultInstanceForType()
public EventMetadata getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
EventMetadata |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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];
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
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 |
intThe 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 |
intThe 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. |
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. |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(EventMetadata other)
public EventMetadata.Builder mergeFrom(EventMetadata other)| Parameter | |
|---|---|
| Name | Description |
other |
EventMetadata |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public EventMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public EventMetadata.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
mergeGroundingMetadata(GroundingMetadata value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
GroundingMetadata |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final EventMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
setBranch(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe branch to set. |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
setBranchBytes(ByteString value)
public EventMetadata.Builder setBranchBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for branch to set. |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public EventMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
setGroundingMetadata(GroundingMetadata value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
GroundingMetadata |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
setGroundingMetadata(GroundingMetadata.Builder builderForValue)
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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GroundingMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
setInterrupted(boolean value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe interrupted to set. |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
setLongRunningToolIds(int index, String value)
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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe longRunningToolIds to set. |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
setPartial(boolean value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe partial to set. |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public EventMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|
setTurnComplete(boolean value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe turnComplete to set. |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final EventMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
EventMetadata.Builder |
|