Class GroundingMetadata.Builder (3.46.0)
3.88.0 (latest)
3.86.0
3.84.0
3.83.0
3.82.0
3.81.0
3.79.0
3.77.0
3.76.0
3.75.0
3.74.0
3.73.0
3.71.0
3.69.0
3.68.0
3.65.0
3.64.0
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 GroundingMetadata . Builder extends GeneratedMessageV3 . Builder<GroundingMetadata . Builder > implements GroundingMetadataOrBuilder
Metadata returned to client when grounding is enabled.
Protobuf type google.cloud.aiplatform.v1.GroundingMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors . Descriptor getDescriptor ()
Methods
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];
Parameter
Name Description
valuesIterable <String >The webSearchQueries to add.
public GroundingMetadata . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
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];
Parameter
Name Description
valueString The webSearchQueries to add.
public GroundingMetadata . Builder addWebSearchQueriesBytes ( ByteString value )
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
valueByteString The bytes of the webSearchQueries to add.
public GroundingMetadata build ()
public GroundingMetadata buildPartial ()
public GroundingMetadata . Builder clear ()
Overrides
public GroundingMetadata . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
public GroundingMetadata . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clearSearchEntryPoint()
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 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 clone ()
Overrides
public GroundingMetadata getDefaultInstanceForType ()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getSearchEntryPoint()
public 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];
getSearchEntryPointBuilder()
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];
getSearchEntryPointOrBuilder()
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];
public 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];
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
String The webSearchQueries at the given index.
public 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];
Parameter
Name Description
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the webSearchQueries at the given index.
public int getWebSearchQueriesCount ()
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The count of webSearchQueries.
public ProtocolStringList getWebSearchQueriesList ()
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
hasSearchEntryPoint()
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];
Returns
Type Description
boolean Whether the searchEntryPoint field is set.
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public GroundingMetadata . Builder mergeFrom ( GroundingMetadata other )
public GroundingMetadata . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
public GroundingMetadata . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeSearchEntryPoint(SearchEntryPoint value)
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 final GroundingMetadata . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
public GroundingMetadata . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
public GroundingMetadata . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setSearchEntryPoint(SearchEntryPoint value)
public 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];
setSearchEntryPoint(SearchEntryPoint.Builder builderForValue)
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 final GroundingMetadata . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
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];
Parameters
Name Description
indexint The index to set the value at.
valueString The webSearchQueries to set.
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 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
