- 3.48.0 (latest)
- 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GroundingMetadata.BuilderImplements
GroundingMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllGroundingAttributions(Iterable<? extends GroundingAttribution> values)
public GroundingMetadata.Builder addAllGroundingAttributions(Iterable<? extends GroundingAttribution> values)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.aiplatform.v1.GroundingAttribution> |
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. |
addGroundingAttributions(GroundingAttribution value)
public GroundingMetadata.Builder addGroundingAttributions(GroundingAttribution value)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
GroundingAttribution |
Returns | |
---|---|
Type | Description |
GroundingMetadata.Builder |
addGroundingAttributions(GroundingAttribution.Builder builderForValue)
public GroundingMetadata.Builder addGroundingAttributions(GroundingAttribution.Builder builderForValue)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
GroundingAttribution.Builder |
Returns | |
---|---|
Type | Description |
GroundingMetadata.Builder |
addGroundingAttributions(int index, GroundingAttribution value)
public GroundingMetadata.Builder addGroundingAttributions(int index, GroundingAttribution value)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
GroundingAttribution |
Returns | |
---|---|
Type | Description |
GroundingMetadata.Builder |
addGroundingAttributions(int index, GroundingAttribution.Builder builderForValue)
public GroundingMetadata.Builder addGroundingAttributions(int index, GroundingAttribution.Builder builderForValue)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
GroundingAttribution.Builder |
Returns | |
---|---|
Type | Description |
GroundingMetadata.Builder |
addGroundingAttributionsBuilder()
public GroundingAttribution.Builder addGroundingAttributionsBuilder()
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
GroundingAttribution.Builder |
addGroundingAttributionsBuilder(int index)
public GroundingAttribution.Builder addGroundingAttributionsBuilder(int index)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
GroundingAttribution.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 |
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 |
clearField(Descriptors.FieldDescriptor field)
public GroundingMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
GroundingMetadata.Builder |
clearGroundingAttributions()
public GroundingMetadata.Builder clearGroundingAttributions()
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.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 |
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];
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 |
getDefaultInstanceForType()
public GroundingMetadata getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
GroundingMetadata |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getGroundingAttributions(int index)
public GroundingAttribution getGroundingAttributions(int index)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
GroundingAttribution |
getGroundingAttributionsBuilder(int index)
public GroundingAttribution.Builder getGroundingAttributionsBuilder(int index)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
GroundingAttribution.Builder |
getGroundingAttributionsBuilderList()
public List<GroundingAttribution.Builder> getGroundingAttributionsBuilderList()
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Builder> |
getGroundingAttributionsCount()
public int getGroundingAttributionsCount()
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getGroundingAttributionsList()
public List<GroundingAttribution> getGroundingAttributionsList()
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<GroundingAttribution> |
getGroundingAttributionsOrBuilder(int index)
public GroundingAttributionOrBuilder getGroundingAttributionsOrBuilder(int index)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
GroundingAttributionOrBuilder |
getGroundingAttributionsOrBuilderList()
public List<? extends GroundingAttributionOrBuilder> getGroundingAttributionsOrBuilderList()
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.aiplatform.v1.GroundingAttributionOrBuilder> |
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];
Returns | |
---|---|
Type | Description |
SearchEntryPoint |
The searchEntryPoint. |
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];
Returns | |
---|---|
Type | Description |
SearchEntryPoint.Builder |
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];
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.aiplatform.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 |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public GroundingMetadata.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
GroundingMetadata.Builder |
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];
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 |
removeGroundingAttributions(int index)
public GroundingMetadata.Builder removeGroundingAttributions(int index)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.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 |
setGroundingAttributions(int index, GroundingAttribution value)
public GroundingMetadata.Builder setGroundingAttributions(int index, GroundingAttribution value)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
GroundingAttribution |
Returns | |
---|---|
Type | Description |
GroundingMetadata.Builder |
setGroundingAttributions(int index, GroundingAttribution.Builder builderForValue)
public GroundingMetadata.Builder setGroundingAttributions(int index, GroundingAttribution.Builder builderForValue)
Optional. List of grounding attributions.
repeated .google.cloud.aiplatform.v1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
GroundingAttribution.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 |
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];
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.aiplatform.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 |
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. |