@Generated public final class GroundingMetadata extends com.google.protobuf.GeneratedMessage implements GroundingMetadataOrBuilder
Metadata returned to client when grounding is enabled.Protobuf type
google.cloud.aiplatform.v1.GroundingMetadata| Modifier and Type | Class and Description |
|---|---|
static class |
GroundingMetadata.Builder
Metadata returned to client when grounding is enabled.
|
static class |
GroundingMetadata.SourceFlaggingUri
Source content flagging uri for a place or review.
|
static interface |
GroundingMetadata.SourceFlaggingUriOrBuilder |
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
GOOGLE_MAPS_WIDGET_CONTEXT_TOKEN_FIELD_NUMBER |
static int |
GROUNDING_CHUNKS_FIELD_NUMBER |
static int |
GROUNDING_SUPPORTS_FIELD_NUMBER |
static int |
RETRIEVAL_METADATA_FIELD_NUMBER |
static int |
SEARCH_ENTRY_POINT_FIELD_NUMBER |
static int |
SOURCE_FLAGGING_URIS_FIELD_NUMBER |
static int |
WEB_SEARCH_QUERIES_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static GroundingMetadata |
getDefaultInstance() |
GroundingMetadata |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getGoogleMapsWidgetContextToken()
Optional.
|
com.google.protobuf.ByteString |
getGoogleMapsWidgetContextTokenBytes()
Optional.
|
GroundingChunk |
getGroundingChunks(int index)
List of supporting references retrieved from specified grounding source.
|
int |
getGroundingChunksCount()
List of supporting references retrieved from specified grounding source.
|
List<GroundingChunk> |
getGroundingChunksList()
List of supporting references retrieved from specified grounding source.
|
GroundingChunkOrBuilder |
getGroundingChunksOrBuilder(int index)
List of supporting references retrieved from specified grounding source.
|
List<? extends GroundingChunkOrBuilder> |
getGroundingChunksOrBuilderList()
List of supporting references retrieved from specified grounding source.
|
GroundingSupport |
getGroundingSupports(int index)
Optional.
|
int |
getGroundingSupportsCount()
Optional.
|
List<GroundingSupport> |
getGroundingSupportsList()
Optional.
|
GroundingSupportOrBuilder |
getGroundingSupportsOrBuilder(int index)
Optional.
|
List<? extends GroundingSupportOrBuilder> |
getGroundingSupportsOrBuilderList()
Optional.
|
com.google.protobuf.Parser<GroundingMetadata> |
getParserForType() |
RetrievalMetadata |
getRetrievalMetadata()
Optional.
|
RetrievalMetadataOrBuilder |
getRetrievalMetadataOrBuilder()
Optional.
|
SearchEntryPoint |
getSearchEntryPoint()
Optional.
|
SearchEntryPointOrBuilder |
getSearchEntryPointOrBuilder()
Optional.
|
int |
getSerializedSize() |
GroundingMetadata.SourceFlaggingUri |
getSourceFlaggingUris(int index)
List of source flagging uris.
|
int |
getSourceFlaggingUrisCount()
List of source flagging uris.
|
List<GroundingMetadata.SourceFlaggingUri> |
getSourceFlaggingUrisList()
List of source flagging uris.
|
GroundingMetadata.SourceFlaggingUriOrBuilder |
getSourceFlaggingUrisOrBuilder(int index)
List of source flagging uris.
|
List<? extends GroundingMetadata.SourceFlaggingUriOrBuilder> |
getSourceFlaggingUrisOrBuilderList()
List of source flagging uris.
|
String |
getWebSearchQueries(int index)
Optional.
|
com.google.protobuf.ByteString |
getWebSearchQueriesBytes(int index)
Optional.
|
int |
getWebSearchQueriesCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getWebSearchQueriesList()
Optional.
|
boolean |
hasGoogleMapsWidgetContextToken()
Optional.
|
int |
hashCode() |
boolean |
hasRetrievalMetadata()
Optional.
|
boolean |
hasSearchEntryPoint()
Optional.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static GroundingMetadata.Builder |
newBuilder() |
static GroundingMetadata.Builder |
newBuilder(GroundingMetadata prototype) |
GroundingMetadata.Builder |
newBuilderForType() |
protected GroundingMetadata.Builder |
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) |
static GroundingMetadata |
parseDelimitedFrom(InputStream input) |
static GroundingMetadata |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GroundingMetadata |
parseFrom(byte[] data) |
static GroundingMetadata |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GroundingMetadata |
parseFrom(ByteBuffer data) |
static GroundingMetadata |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GroundingMetadata |
parseFrom(com.google.protobuf.ByteString data) |
static GroundingMetadata |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GroundingMetadata |
parseFrom(com.google.protobuf.CodedInputStream input) |
static GroundingMetadata |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GroundingMetadata |
parseFrom(InputStream input) |
static GroundingMetadata |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<GroundingMetadata> |
parser() |
GroundingMetadata.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashFields, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int WEB_SEARCH_QUERIES_FIELD_NUMBER
public static final int SEARCH_ENTRY_POINT_FIELD_NUMBER
public static final int GROUNDING_CHUNKS_FIELD_NUMBER
public static final int GROUNDING_SUPPORTS_FIELD_NUMBER
public static final int RETRIEVAL_METADATA_FIELD_NUMBER
public static final int GOOGLE_MAPS_WIDGET_CONTEXT_TOKEN_FIELD_NUMBER
public static final int SOURCE_FLAGGING_URIS_FIELD_NUMBER
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessagepublic com.google.protobuf.ProtocolStringList getWebSearchQueriesList()
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];getWebSearchQueriesList in interface GroundingMetadataOrBuilderpublic int getWebSearchQueriesCount()
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];getWebSearchQueriesCount in interface GroundingMetadataOrBuilderpublic String getWebSearchQueries(int index)
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];getWebSearchQueries in interface GroundingMetadataOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getWebSearchQueriesBytes(int index)
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];getWebSearchQueriesBytes in interface GroundingMetadataOrBuilderindex - The index of the value to return.public boolean hasSearchEntryPoint()
Optional. Google search entry for the following-up web searches.
optional .google.cloud.aiplatform.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];
hasSearchEntryPoint in interface GroundingMetadataOrBuilderpublic SearchEntryPoint getSearchEntryPoint()
Optional. Google search entry for the following-up web searches.
optional .google.cloud.aiplatform.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];
getSearchEntryPoint in interface GroundingMetadataOrBuilderpublic SearchEntryPointOrBuilder getSearchEntryPointOrBuilder()
Optional. Google search entry for the following-up web searches.
optional .google.cloud.aiplatform.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];
getSearchEntryPointOrBuilder in interface GroundingMetadataOrBuilderpublic List<GroundingChunk> getGroundingChunksList()
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;getGroundingChunksList in interface GroundingMetadataOrBuilderpublic List<? extends GroundingChunkOrBuilder> getGroundingChunksOrBuilderList()
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;getGroundingChunksOrBuilderList in interface GroundingMetadataOrBuilderpublic int getGroundingChunksCount()
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;getGroundingChunksCount in interface GroundingMetadataOrBuilderpublic GroundingChunk getGroundingChunks(int index)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;getGroundingChunks in interface GroundingMetadataOrBuilderpublic GroundingChunkOrBuilder getGroundingChunksOrBuilder(int index)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;getGroundingChunksOrBuilder in interface GroundingMetadataOrBuilderpublic List<GroundingSupport> getGroundingSupportsList()
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
getGroundingSupportsList in interface GroundingMetadataOrBuilderpublic List<? extends GroundingSupportOrBuilder> getGroundingSupportsOrBuilderList()
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
getGroundingSupportsOrBuilderList in interface GroundingMetadataOrBuilderpublic int getGroundingSupportsCount()
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
getGroundingSupportsCount in interface GroundingMetadataOrBuilderpublic GroundingSupport getGroundingSupports(int index)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
getGroundingSupports in interface GroundingMetadataOrBuilderpublic GroundingSupportOrBuilder getGroundingSupportsOrBuilder(int index)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
getGroundingSupportsOrBuilder in interface GroundingMetadataOrBuilderpublic boolean hasRetrievalMetadata()
Optional. Output only. Retrieval metadata.
optional .google.cloud.aiplatform.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
hasRetrievalMetadata in interface GroundingMetadataOrBuilderpublic RetrievalMetadata getRetrievalMetadata()
Optional. Output only. Retrieval metadata.
optional .google.cloud.aiplatform.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
getRetrievalMetadata in interface GroundingMetadataOrBuilderpublic RetrievalMetadataOrBuilder getRetrievalMetadataOrBuilder()
Optional. Output only. Retrieval metadata.
optional .google.cloud.aiplatform.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
getRetrievalMetadataOrBuilder in interface GroundingMetadataOrBuilderpublic boolean hasGoogleMapsWidgetContextToken()
Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
optional string google_maps_widget_context_token = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
hasGoogleMapsWidgetContextToken in interface GroundingMetadataOrBuilderpublic String getGoogleMapsWidgetContextToken()
Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
optional string google_maps_widget_context_token = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
getGoogleMapsWidgetContextToken in interface GroundingMetadataOrBuilderpublic com.google.protobuf.ByteString getGoogleMapsWidgetContextTokenBytes()
Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
optional string google_maps_widget_context_token = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
getGoogleMapsWidgetContextTokenBytes in interface GroundingMetadataOrBuilderpublic List<GroundingMetadata.SourceFlaggingUri> getSourceFlaggingUrisList()
List of source flagging uris. This is currently populated only for Google Maps grounding.
repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
getSourceFlaggingUrisList in interface GroundingMetadataOrBuilderpublic List<? extends GroundingMetadata.SourceFlaggingUriOrBuilder> getSourceFlaggingUrisOrBuilderList()
List of source flagging uris. This is currently populated only for Google Maps grounding.
repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
getSourceFlaggingUrisOrBuilderList in interface GroundingMetadataOrBuilderpublic int getSourceFlaggingUrisCount()
List of source flagging uris. This is currently populated only for Google Maps grounding.
repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
getSourceFlaggingUrisCount in interface GroundingMetadataOrBuilderpublic GroundingMetadata.SourceFlaggingUri getSourceFlaggingUris(int index)
List of source flagging uris. This is currently populated only for Google Maps grounding.
repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
getSourceFlaggingUris in interface GroundingMetadataOrBuilderpublic GroundingMetadata.SourceFlaggingUriOrBuilder getSourceFlaggingUrisOrBuilder(int index)
List of source flagging uris. This is currently populated only for Google Maps grounding.
repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
getSourceFlaggingUrisOrBuilder in interface GroundingMetadataOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessagepublic void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageIOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessagepublic boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static GroundingMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GroundingMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GroundingMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GroundingMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GroundingMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GroundingMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GroundingMetadata parseFrom(InputStream input) throws IOException
IOExceptionpublic static GroundingMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static GroundingMetadata parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static GroundingMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static GroundingMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static GroundingMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic GroundingMetadata.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static GroundingMetadata.Builder newBuilder()
public static GroundingMetadata.Builder newBuilder(GroundingMetadata prototype)
public GroundingMetadata.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected GroundingMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
newBuilderForType in class com.google.protobuf.AbstractMessagepublic static GroundingMetadata getDefaultInstance()
public static com.google.protobuf.Parser<GroundingMetadata> parser()
public com.google.protobuf.Parser<GroundingMetadata> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessagepublic GroundingMetadata getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2026 Google LLC. All rights reserved.