com.google.cloud.aiplatform.v1beta1

Class GroundingMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.GroundingMetadata

All Implemented Interfaces:

GroundingMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class GroundingMetadata
extends com.google.protobuf.GeneratedMessageV3
implements GroundingMetadataOrBuilder

 Metadata returned to client when grounding is enabled.
 

Protobuf type google.cloud.aiplatform.v1beta1.GroundingMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroundingMetadata.Builder Metadata returned to client when grounding is enabled.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	GROUNDING_ATTRIBUTIONS_FIELD_NUMBER
static int	RETRIEVAL_QUERIES_FIELD_NUMBER
static int	SEARCH_ENTRY_POINT_FIELD_NUMBER
static int	WEB_SEARCH_QUERIES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static GroundingMetadata	getDefaultInstance()
GroundingMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
GroundingAttribution	getGroundingAttributions(int index) Optional.
int	getGroundingAttributionsCount() Optional.
List<GroundingAttribution>	getGroundingAttributionsList() Optional.
GroundingAttributionOrBuilder	getGroundingAttributionsOrBuilder(int index) Optional.
List<? extends GroundingAttributionOrBuilder>	getGroundingAttributionsOrBuilderList() Optional.
com.google.protobuf.Parser<GroundingMetadata>	getParserForType()
String	getRetrievalQueries(int index) Optional.
com.google.protobuf.ByteString	getRetrievalQueriesBytes(int index) Optional.
int	getRetrievalQueriesCount() Optional.
com.google.protobuf.ProtocolStringList	getRetrievalQueriesList() Optional.
SearchEntryPoint	getSearchEntryPoint() Optional.
SearchEntryPointOrBuilder	getSearchEntryPointOrBuilder() Optional.
int	getSerializedSize()
String	getWebSearchQueries(int index) Optional.
com.google.protobuf.ByteString	getWebSearchQueriesBytes(int index) Optional.
int	getWebSearchQueriesCount() Optional.
com.google.protobuf.ProtocolStringList	getWebSearchQueriesList() Optional.
int	hashCode()
boolean	hasSearchEntryPoint() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GroundingMetadata.Builder	newBuilder()
static GroundingMetadata.Builder	newBuilder(GroundingMetadata prototype)
GroundingMetadata.Builder	newBuilderForType()
protected GroundingMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
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)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

WEB_SEARCH_QUERIES_FIELD_NUMBER

public static final int WEB_SEARCH_QUERIES_FIELD_NUMBER

See Also:

Constant Field Values

SEARCH_ENTRY_POINT_FIELD_NUMBER

public static final int SEARCH_ENTRY_POINT_FIELD_NUMBER

See Also:

Constant Field Values

RETRIEVAL_QUERIES_FIELD_NUMBER

public static final int RETRIEVAL_QUERIES_FIELD_NUMBER

See Also:

Constant Field Values

GROUNDING_ATTRIBUTIONS_FIELD_NUMBER

public static final int GROUNDING_ATTRIBUTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getWebSearchQueriesList

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

Specified by:

getWebSearchQueriesList in interface GroundingMetadataOrBuilder

Returns:

A list containing the webSearchQueries.

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

Specified by:

getWebSearchQueriesCount in interface GroundingMetadataOrBuilder

Returns:

The count of webSearchQueries.

getWebSearchQueries

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

Specified by:

getWebSearchQueries in interface GroundingMetadataOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The webSearchQueries at the given index.

getWebSearchQueriesBytes

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

Specified by:

getWebSearchQueriesBytes in interface GroundingMetadataOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the webSearchQueries at the given index.

hasSearchEntryPoint

public boolean hasSearchEntryPoint()

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

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

Specified by:

hasSearchEntryPoint in interface GroundingMetadataOrBuilder

Returns:

Whether the searchEntryPoint field is set.

getSearchEntryPoint

public SearchEntryPoint getSearchEntryPoint()

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

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

Specified by:

getSearchEntryPoint in interface GroundingMetadataOrBuilder

Returns:

The searchEntryPoint.

getSearchEntryPointOrBuilder

public SearchEntryPointOrBuilder getSearchEntryPointOrBuilder()

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

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

Specified by:

getSearchEntryPointOrBuilder in interface GroundingMetadataOrBuilder

getRetrievalQueriesList

public com.google.protobuf.ProtocolStringList getRetrievalQueriesList()

 Optional. Queries executed by the retrieval tools.
 

repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetrievalQueriesList in interface GroundingMetadataOrBuilder

Returns:

A list containing the retrievalQueries.

getRetrievalQueriesCount

public int getRetrievalQueriesCount()

 Optional. Queries executed by the retrieval tools.
 

repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetrievalQueriesCount in interface GroundingMetadataOrBuilder

Returns:

The count of retrievalQueries.

getRetrievalQueries

public String getRetrievalQueries(int index)

 Optional. Queries executed by the retrieval tools.
 

repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetrievalQueries in interface GroundingMetadataOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The retrievalQueries at the given index.

getRetrievalQueriesBytes

public com.google.protobuf.ByteString getRetrievalQueriesBytes(int index)

 Optional. Queries executed by the retrieval tools.
 

repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetrievalQueriesBytes in interface GroundingMetadataOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the retrievalQueries at the given index.

getGroundingAttributionsList

public List<GroundingAttribution> getGroundingAttributionsList()

 Optional. List of grounding attributions.
 

repeated .google.cloud.aiplatform.v1beta1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGroundingAttributionsList in interface GroundingMetadataOrBuilder

getGroundingAttributionsOrBuilderList

public List<? extends GroundingAttributionOrBuilder> getGroundingAttributionsOrBuilderList()

 Optional. List of grounding attributions.
 

repeated .google.cloud.aiplatform.v1beta1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGroundingAttributionsOrBuilderList in interface GroundingMetadataOrBuilder

getGroundingAttributionsCount

public int getGroundingAttributionsCount()

 Optional. List of grounding attributions.
 

repeated .google.cloud.aiplatform.v1beta1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGroundingAttributionsCount in interface GroundingMetadataOrBuilder

getGroundingAttributions

public GroundingAttribution getGroundingAttributions(int index)

 Optional. List of grounding attributions.
 

repeated .google.cloud.aiplatform.v1beta1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGroundingAttributions in interface GroundingMetadataOrBuilder

getGroundingAttributionsOrBuilder

public GroundingAttributionOrBuilder getGroundingAttributionsOrBuilder(int index)

 Optional. List of grounding attributions.
 

repeated .google.cloud.aiplatform.v1beta1.GroundingAttribution grounding_attributions = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGroundingAttributionsOrBuilder in interface GroundingMetadataOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GroundingMetadata parseFrom(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GroundingMetadata parseFrom(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GroundingMetadata parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GroundingMetadata parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GroundingMetadata parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GroundingMetadata parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GroundingMetadata parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static GroundingMetadata parseFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static GroundingMetadata parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static GroundingMetadata parseDelimitedFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static GroundingMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static GroundingMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

newBuilderForType

public GroundingMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GroundingMetadata.Builder newBuilder()

newBuilder

public static GroundingMetadata.Builder newBuilder(GroundingMetadata prototype)

toBuilder

public GroundingMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GroundingMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GroundingMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<GroundingMetadata> parser()

getParserForType

public com.google.protobuf.Parser<GroundingMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GroundingMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder