Package com.google.cloud.aiplatform.v1

Class GroundingMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.GroundingMetadata
All Implemented Interfaces:
GroundingMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class GroundingMetadata extends com.google.protobuf.GeneratedMessage implements GroundingMetadataOrBuilder
 Metadata returned to client when grounding is enabled.
Protobuf type google.cloud.aiplatform.v1.GroundingMetadata
See Also:

  • Field Details

    • WEB_SEARCH_QUERIES_FIELD_NUMBER

      public static final int WEB_SEARCH_QUERIES_FIELD_NUMBER
      See Also:

    • SEARCH_ENTRY_POINT_FIELD_NUMBER

      public static final int SEARCH_ENTRY_POINT_FIELD_NUMBER
      See Also:

    • GROUNDING_CHUNKS_FIELD_NUMBER

      public static final int GROUNDING_CHUNKS_FIELD_NUMBER
      See Also:

    • GROUNDING_SUPPORTS_FIELD_NUMBER

      public static final int GROUNDING_SUPPORTS_FIELD_NUMBER
      See Also:

    • RETRIEVAL_METADATA_FIELD_NUMBER

      public static final int RETRIEVAL_METADATA_FIELD_NUMBER
      See Also:

    • GOOGLE_MAPS_WIDGET_CONTEXT_TOKEN_FIELD_NUMBER

      public static final int GOOGLE_MAPS_WIDGET_CONTEXT_TOKEN_FIELD_NUMBER
      See Also:

    • SOURCE_FLAGGING_URIS_FIELD_NUMBER

      public static final int SOURCE_FLAGGING_URIS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.v1.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.v1.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.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchEntryPointOrBuilder in interface GroundingMetadataOrBuilder

    • getGroundingChunksList

      public List<GroundingChunk> getGroundingChunksList()
       List of supporting references retrieved from specified grounding source.
      repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
      Specified by:
      getGroundingChunksList in interface GroundingMetadataOrBuilder

    • getGroundingChunksOrBuilderList

      public List<? extends GroundingChunkOrBuilder> getGroundingChunksOrBuilderList()
       List of supporting references retrieved from specified grounding source.
      repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
      Specified by:
      getGroundingChunksOrBuilderList in interface GroundingMetadataOrBuilder

    • getGroundingChunksCount

      public int getGroundingChunksCount()
       List of supporting references retrieved from specified grounding source.
      repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
      Specified by:
      getGroundingChunksCount in interface GroundingMetadataOrBuilder

    • getGroundingChunks

      public GroundingChunk getGroundingChunks(int index)
       List of supporting references retrieved from specified grounding source.
      repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
      Specified by:
      getGroundingChunks in interface GroundingMetadataOrBuilder

    • getGroundingChunksOrBuilder

      public GroundingChunkOrBuilder getGroundingChunksOrBuilder(int index)
       List of supporting references retrieved from specified grounding source.
      repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
      Specified by:
      getGroundingChunksOrBuilder in interface GroundingMetadataOrBuilder

    • getGroundingSupportsList

      public List<GroundingSupport> getGroundingSupportsList()
       Optional. List of grounding support.
      repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGroundingSupportsList in interface GroundingMetadataOrBuilder

    • getGroundingSupportsOrBuilderList

      public List<? extends GroundingSupportOrBuilder> getGroundingSupportsOrBuilderList()
       Optional. List of grounding support.
      repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGroundingSupportsOrBuilderList in interface GroundingMetadataOrBuilder

    • getGroundingSupportsCount

      public int getGroundingSupportsCount()
       Optional. List of grounding support.
      repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGroundingSupportsCount in interface GroundingMetadataOrBuilder

    • getGroundingSupports

      public GroundingSupport getGroundingSupports(int index)
       Optional. List of grounding support.
      repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGroundingSupports in interface GroundingMetadataOrBuilder

    • getGroundingSupportsOrBuilder

      public GroundingSupportOrBuilder getGroundingSupportsOrBuilder(int index)
       Optional. List of grounding support.
      repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGroundingSupportsOrBuilder in interface GroundingMetadataOrBuilder

    • hasRetrievalMetadata

      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];
      Specified by:
      hasRetrievalMetadata in interface GroundingMetadataOrBuilder
      Returns:
      Whether the retrievalMetadata field is set.

    • getRetrievalMetadata

      public 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];
      Specified by:
      getRetrievalMetadata in interface GroundingMetadataOrBuilder
      Returns:
      The retrievalMetadata.

    • getRetrievalMetadataOrBuilder

      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];
      Specified by:
      getRetrievalMetadataOrBuilder in interface GroundingMetadataOrBuilder

    • hasGoogleMapsWidgetContextToken

      public boolean hasGoogleMapsWidgetContextToken()
       Optional. Output only. Resource name of the Google Maps widget context
 token to be used with the PlacesContextElement widget to render contextual
 data. This is populated only for Google Maps grounding.
      optional string google_maps_widget_context_token = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasGoogleMapsWidgetContextToken in interface GroundingMetadataOrBuilder
      Returns:
      Whether the googleMapsWidgetContextToken field is set.

    • getGoogleMapsWidgetContextToken

      public String getGoogleMapsWidgetContextToken()
       Optional. Output only. Resource name of the Google Maps widget context
 token to be used with the PlacesContextElement widget to render contextual
 data. This is populated only for Google Maps grounding.
      optional string google_maps_widget_context_token = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoogleMapsWidgetContextToken in interface GroundingMetadataOrBuilder
      Returns:
      The googleMapsWidgetContextToken.

    • getGoogleMapsWidgetContextTokenBytes

      public com.google.protobuf.ByteString getGoogleMapsWidgetContextTokenBytes()
       Optional. Output only. Resource name of the Google Maps widget context
 token to be used with the PlacesContextElement widget to render contextual
 data. This is populated only for Google Maps grounding.
      optional string google_maps_widget_context_token = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoogleMapsWidgetContextTokenBytes in interface GroundingMetadataOrBuilder
      Returns:
      The bytes for googleMapsWidgetContextToken.

    • getSourceFlaggingUrisList

      public List<GroundingMetadata.SourceFlaggingUri> getSourceFlaggingUrisList()
       List of source flagging uris. This is currently populated only for Google
 Maps grounding.
      repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
      Specified by:
      getSourceFlaggingUrisList in interface GroundingMetadataOrBuilder

    • getSourceFlaggingUrisOrBuilderList

      public List<? extends GroundingMetadata.SourceFlaggingUriOrBuilder> getSourceFlaggingUrisOrBuilderList()
       List of source flagging uris. This is currently populated only for Google
 Maps grounding.
      repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
      Specified by:
      getSourceFlaggingUrisOrBuilderList in interface GroundingMetadataOrBuilder

    • getSourceFlaggingUrisCount

      public int getSourceFlaggingUrisCount()
       List of source flagging uris. This is currently populated only for Google
 Maps grounding.
      repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
      Specified by:
      getSourceFlaggingUrisCount in interface GroundingMetadataOrBuilder

    • getSourceFlaggingUris

      public GroundingMetadata.SourceFlaggingUri getSourceFlaggingUris(int index)
       List of source flagging uris. This is currently populated only for Google
 Maps grounding.
      repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
      Specified by:
      getSourceFlaggingUris in interface GroundingMetadataOrBuilder

    • getSourceFlaggingUrisOrBuilder

      public GroundingMetadata.SourceFlaggingUriOrBuilder getSourceFlaggingUrisOrBuilder(int index)
       List of source flagging uris. This is currently populated only for Google
 Maps grounding.
      repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;
      Specified by:
      getSourceFlaggingUrisOrBuilder in interface GroundingMetadataOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public GroundingMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder