public static final class GroundingMetadata.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder> implements GroundingMetadataOrBuilder
Metadata returned to client when grounding is enabled.Protobuf type
google.cloud.aiplatform.v1.GroundingMetadatagetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public GroundingMetadata.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public GroundingMetadata getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic GroundingMetadata build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic GroundingMetadata buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic GroundingMetadata.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public GroundingMetadata.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public GroundingMetadata.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public GroundingMetadata.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public GroundingMetadata.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public GroundingMetadata.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public GroundingMetadata.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<GroundingMetadata.Builder>public GroundingMetadata.Builder mergeFrom(GroundingMetadata other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public GroundingMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<GroundingMetadata.Builder>IOExceptionpublic 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 GroundingMetadata.Builder setWebSearchQueries(int index, String value)
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
index - The index to set the value at.value - The webSearchQueries to set.public GroundingMetadata.Builder addWebSearchQueries(String value)
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
value - The webSearchQueries to add.public GroundingMetadata.Builder addAllWebSearchQueries(Iterable<String> values)
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
values - The webSearchQueries to add.public GroundingMetadata.Builder clearWebSearchQueries()
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadata.Builder addWebSearchQueriesBytes(com.google.protobuf.ByteString value)
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
value - The bytes of the webSearchQueries to add.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 GroundingMetadata.Builder setSearchEntryPoint(SearchEntryPoint value)
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];
public GroundingMetadata.Builder setSearchEntryPoint(SearchEntryPoint.Builder builderForValue)
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];
public GroundingMetadata.Builder mergeSearchEntryPoint(SearchEntryPoint value)
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];
public GroundingMetadata.Builder clearSearchEntryPoint()
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];
public SearchEntryPoint.Builder getSearchEntryPointBuilder()
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];
public 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 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 GroundingMetadata.Builder setGroundingChunks(int index, GroundingChunk value)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingMetadata.Builder setGroundingChunks(int index, GroundingChunk.Builder builderForValue)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingMetadata.Builder addGroundingChunks(GroundingChunk value)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingMetadata.Builder addGroundingChunks(int index, GroundingChunk value)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingMetadata.Builder addGroundingChunks(GroundingChunk.Builder builderForValue)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingMetadata.Builder addGroundingChunks(int index, GroundingChunk.Builder builderForValue)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingMetadata.Builder addAllGroundingChunks(Iterable<? extends GroundingChunk> values)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingMetadata.Builder clearGroundingChunks()
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingMetadata.Builder removeGroundingChunks(int index)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingChunk.Builder getGroundingChunksBuilder(int index)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public 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<? 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 GroundingChunk.Builder addGroundingChunksBuilder()
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public GroundingChunk.Builder addGroundingChunksBuilder(int index)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public List<GroundingChunk.Builder> getGroundingChunksBuilderList()
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;public 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 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 GroundingMetadata.Builder setGroundingSupports(int index, GroundingSupport value)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadata.Builder setGroundingSupports(int index, GroundingSupport.Builder builderForValue)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadata.Builder addGroundingSupports(GroundingSupport value)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadata.Builder addGroundingSupports(int index, GroundingSupport value)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadata.Builder addGroundingSupports(GroundingSupport.Builder builderForValue)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadata.Builder addGroundingSupports(int index, GroundingSupport.Builder builderForValue)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadata.Builder addAllGroundingSupports(Iterable<? extends GroundingSupport> values)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadata.Builder clearGroundingSupports()
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadata.Builder removeGroundingSupports(int index)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingSupport.Builder getGroundingSupportsBuilder(int index)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public 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 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 GroundingSupport.Builder addGroundingSupportsBuilder()
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingSupport.Builder addGroundingSupportsBuilder(int index)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public List<GroundingSupport.Builder> getGroundingSupportsBuilderList()
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public 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 GroundingMetadata.Builder setRetrievalMetadata(RetrievalMetadata value)
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];
public GroundingMetadata.Builder setRetrievalMetadata(RetrievalMetadata.Builder builderForValue)
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];
public GroundingMetadata.Builder mergeRetrievalMetadata(RetrievalMetadata value)
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];
public GroundingMetadata.Builder clearRetrievalMetadata()
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];
public RetrievalMetadata.Builder getRetrievalMetadataBuilder()
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];
public 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 final GroundingMetadata.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>public final GroundingMetadata.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GroundingMetadata.Builder>Copyright © 2025 Google LLC. All rights reserved.