Class GroundingMetadata.Builder (1.11.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.vertexai.v1.GroundingMetadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GroundingMetadata.Builder

Implements

GroundingMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllGroundingChunks(Iterable<? extends GroundingChunk> values)

public GroundingMetadata.Builder addAllGroundingChunks(Iterable<? extends GroundingChunk> values)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.vertexai.api.GroundingChunk>

Returns
Type	Description
GroundingMetadata.Builder

addAllGroundingSupports(Iterable<? extends GroundingSupport> values)

public GroundingMetadata.Builder addAllGroundingSupports(Iterable<? extends GroundingSupport> values)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.vertexai.api.GroundingSupport>

Returns
Type	Description
GroundingMetadata.Builder

addAllWebSearchQueries(Iterable<String> values)

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
values	Iterable<String> The webSearchQueries to add.

Returns
Type	Description
GroundingMetadata.Builder	This builder for chaining.

addGroundingChunks(GroundingChunk value)

public GroundingMetadata.Builder addGroundingChunks(GroundingChunk value)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameter
Name	Description
value	GroundingChunk

Returns
Type	Description
GroundingMetadata.Builder

addGroundingChunks(GroundingChunk.Builder builderForValue)

public GroundingMetadata.Builder addGroundingChunks(GroundingChunk.Builder builderForValue)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameter
Name	Description
builderForValue	GroundingChunk.Builder

Returns
Type	Description
GroundingMetadata.Builder

addGroundingChunks(int index, GroundingChunk value)

public GroundingMetadata.Builder addGroundingChunks(int index, GroundingChunk value)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameters
Name	Description
index	int
value	GroundingChunk

Returns
Type	Description
GroundingMetadata.Builder

addGroundingChunks(int index, GroundingChunk.Builder builderForValue)

public GroundingMetadata.Builder addGroundingChunks(int index, GroundingChunk.Builder builderForValue)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameters
Name	Description
index	int
builderForValue	GroundingChunk.Builder

Returns
Type	Description
GroundingMetadata.Builder

addGroundingChunksBuilder()

public GroundingChunk.Builder addGroundingChunksBuilder()

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Returns
Type	Description
GroundingChunk.Builder

addGroundingChunksBuilder(int index)

public GroundingChunk.Builder addGroundingChunksBuilder(int index)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingChunk.Builder

addGroundingSupports(GroundingSupport value)

public GroundingMetadata.Builder addGroundingSupports(GroundingSupport value)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	GroundingSupport

Returns
Type	Description
GroundingMetadata.Builder

addGroundingSupports(GroundingSupport.Builder builderForValue)

public GroundingMetadata.Builder addGroundingSupports(GroundingSupport.Builder builderForValue)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	GroundingSupport.Builder

Returns
Type	Description
GroundingMetadata.Builder

addGroundingSupports(int index, GroundingSupport value)

public GroundingMetadata.Builder addGroundingSupports(int index, GroundingSupport value)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	GroundingSupport

Returns
Type	Description
GroundingMetadata.Builder

addGroundingSupports(int index, GroundingSupport.Builder builderForValue)

public GroundingMetadata.Builder addGroundingSupports(int index, GroundingSupport.Builder builderForValue)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	GroundingSupport.Builder

Returns
Type	Description
GroundingMetadata.Builder

addGroundingSupportsBuilder()

public GroundingSupport.Builder addGroundingSupportsBuilder()

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GroundingSupport.Builder

addGroundingSupportsBuilder(int index)

public GroundingSupport.Builder addGroundingSupportsBuilder(int index)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingSupport.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GroundingMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addWebSearchQueries(String value)

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
value	String The webSearchQueries to add.

Returns
Type	Description
GroundingMetadata.Builder	This builder for chaining.

addWebSearchQueriesBytes(ByteString value)

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
value	ByteString The bytes of the webSearchQueries to add.

Returns
Type	Description
GroundingMetadata.Builder	This builder for chaining.

build()

public GroundingMetadata build()

Returns
Type	Description
GroundingMetadata

buildPartial()

public GroundingMetadata buildPartial()

Returns
Type	Description
GroundingMetadata

clear()

public GroundingMetadata.Builder clear()

Returns
Type	Description
GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public GroundingMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGroundingChunks()

public GroundingMetadata.Builder clearGroundingChunks()

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Returns
Type	Description
GroundingMetadata.Builder

clearGroundingSupports()

public GroundingMetadata.Builder clearGroundingSupports()

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GroundingMetadata.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public GroundingMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSearchEntryPoint()

public GroundingMetadata.Builder clearSearchEntryPoint()

Optional. Google search entry for the following-up web searches.

optional .google.cloud.vertexai.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GroundingMetadata.Builder

clearWebSearchQueries()

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

Returns
Type	Description
GroundingMetadata.Builder	This builder for chaining.

clone()

public GroundingMetadata.Builder clone()

Returns
Type	Description
GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public GroundingMetadata getDefaultInstanceForType()

Returns
Type	Description
GroundingMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGroundingChunks(int index)

public GroundingChunk getGroundingChunks(int index)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingChunk

getGroundingChunksBuilder(int index)

public GroundingChunk.Builder getGroundingChunksBuilder(int index)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingChunk.Builder

getGroundingChunksBuilderList()

public List<GroundingChunk.Builder> getGroundingChunksBuilderList()

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Returns
Type	Description
List<Builder>

getGroundingChunksCount()

public int getGroundingChunksCount()

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Returns
Type	Description
int

getGroundingChunksList()

public List<GroundingChunk> getGroundingChunksList()

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Returns
Type	Description
List<GroundingChunk>

getGroundingChunksOrBuilder(int index)

public GroundingChunkOrBuilder getGroundingChunksOrBuilder(int index)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingChunkOrBuilder

getGroundingChunksOrBuilderList()

public List<? extends GroundingChunkOrBuilder> getGroundingChunksOrBuilderList()

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.GroundingChunkOrBuilder>

getGroundingSupports(int index)

public GroundingSupport getGroundingSupports(int index)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingSupport

getGroundingSupportsBuilder(int index)

public GroundingSupport.Builder getGroundingSupportsBuilder(int index)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingSupport.Builder

getGroundingSupportsBuilderList()

public List<GroundingSupport.Builder> getGroundingSupportsBuilderList()

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getGroundingSupportsCount()

public int getGroundingSupportsCount()

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getGroundingSupportsList()

public List<GroundingSupport> getGroundingSupportsList()

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<GroundingSupport>

getGroundingSupportsOrBuilder(int index)

public GroundingSupportOrBuilder getGroundingSupportsOrBuilder(int index)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingSupportOrBuilder

getGroundingSupportsOrBuilderList()

public List<? extends GroundingSupportOrBuilder> getGroundingSupportsOrBuilderList()

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.GroundingSupportOrBuilder>

getSearchEntryPoint()

public SearchEntryPoint getSearchEntryPoint()

Optional. Google search entry for the following-up web searches.

optional .google.cloud.vertexai.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchEntryPoint	The searchEntryPoint.

getSearchEntryPointBuilder()

public SearchEntryPoint.Builder getSearchEntryPointBuilder()

Optional. Google search entry for the following-up web searches.

optional .google.cloud.vertexai.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchEntryPoint.Builder

getSearchEntryPointOrBuilder()

public SearchEntryPointOrBuilder getSearchEntryPointOrBuilder()

Optional. Google search entry for the following-up web searches.

optional .google.cloud.vertexai.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchEntryPointOrBuilder

getWebSearchQueries(int index)

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

Returns
Type	Description
String	The webSearchQueries at the given index.

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

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

getWebSearchQueriesCount()

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.

getWebSearchQueriesList()

public ProtocolStringList getWebSearchQueriesList()

Optional. Web search queries for the following-up web search.

repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the webSearchQueries.

hasSearchEntryPoint()

public boolean hasSearchEntryPoint()

Optional. Google search entry for the following-up web searches.

optional .google.cloud.vertexai.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the searchEntryPoint field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(GroundingMetadata other)

public GroundingMetadata.Builder mergeFrom(GroundingMetadata other)

Parameter
Name	Description
other	GroundingMetadata

Returns
Type	Description
GroundingMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GroundingMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public GroundingMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
GroundingMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSearchEntryPoint(SearchEntryPoint value)

public GroundingMetadata.Builder mergeSearchEntryPoint(SearchEntryPoint value)

Optional. Google search entry for the following-up web searches.

optional .google.cloud.vertexai.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	SearchEntryPoint

Returns
Type	Description
GroundingMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GroundingMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeGroundingChunks(int index)

public GroundingMetadata.Builder removeGroundingChunks(int index)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingMetadata.Builder

removeGroundingSupports(int index)

public GroundingMetadata.Builder removeGroundingSupports(int index)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
GroundingMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public GroundingMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGroundingChunks(int index, GroundingChunk value)

public GroundingMetadata.Builder setGroundingChunks(int index, GroundingChunk value)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameters
Name	Description
index	int
value	GroundingChunk

Returns
Type	Description
GroundingMetadata.Builder

setGroundingChunks(int index, GroundingChunk.Builder builderForValue)

public GroundingMetadata.Builder setGroundingChunks(int index, GroundingChunk.Builder builderForValue)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.GroundingChunk grounding_chunks = 5;

Parameters
Name	Description
index	int
builderForValue	GroundingChunk.Builder

Returns
Type	Description
GroundingMetadata.Builder

setGroundingSupports(int index, GroundingSupport value)

public GroundingMetadata.Builder setGroundingSupports(int index, GroundingSupport value)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	GroundingSupport

Returns
Type	Description
GroundingMetadata.Builder

setGroundingSupports(int index, GroundingSupport.Builder builderForValue)

public GroundingMetadata.Builder setGroundingSupports(int index, GroundingSupport.Builder builderForValue)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	GroundingSupport.Builder

Returns
Type	Description
GroundingMetadata.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GroundingMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSearchEntryPoint(SearchEntryPoint value)

public GroundingMetadata.Builder setSearchEntryPoint(SearchEntryPoint value)

Optional. Google search entry for the following-up web searches.

optional .google.cloud.vertexai.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	SearchEntryPoint

Returns
Type	Description
GroundingMetadata.Builder

setSearchEntryPoint(SearchEntryPoint.Builder builderForValue)

public GroundingMetadata.Builder setSearchEntryPoint(SearchEntryPoint.Builder builderForValue)

Optional. Google search entry for the following-up web searches.

optional .google.cloud.vertexai.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	SearchEntryPoint.Builder

Returns
Type	Description
GroundingMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final GroundingMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setWebSearchQueries(int index, String value)

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
index	int The index to set the value at.
value	String The webSearchQueries to set.

Returns
Type	Description
GroundingMetadata.Builder	This builder for chaining.