Package com.google.cloud.aiplatform.v1

Class VertexAISearch.DataStoreSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec
All Implemented Interfaces:
VertexAISearch.DataStoreSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
VertexAISearch
public static final class VertexAISearch.DataStoreSpec extends com.google.protobuf.GeneratedMessage implements VertexAISearch.DataStoreSpecOrBuilder
 Define data stores within engine to filter on in a search call and
 configurations for those data stores. For more information, see
 https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
Protobuf type google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    VertexAISearch.DataStoreSpec.Builder
    Define data stores within engine to filter on in a search call and configurations for those data stores.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATA_STORE_FIELD_NUMBER
     
    static final int
    FILTER_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    String
    getDataStore()
    Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
    com.google.protobuf.ByteString
    getDataStoreBytes()
    Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
    static VertexAISearch.DataStoreSpec
    getDefaultInstance()
     
    VertexAISearch.DataStoreSpec
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    com.google.protobuf.Parser<VertexAISearch.DataStoreSpec>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static VertexAISearch.DataStoreSpec.Builder
    newBuilder()
     
    static VertexAISearch.DataStoreSpec.Builder
    newBuilder(VertexAISearch.DataStoreSpec prototype)
     
    VertexAISearch.DataStoreSpec.Builder
    newBuilderForType()
     
    protected VertexAISearch.DataStoreSpec.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static VertexAISearch.DataStoreSpec
    parseDelimitedFrom(InputStream input)
     
    static VertexAISearch.DataStoreSpec
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(byte[] data)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(com.google.protobuf.ByteString data)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(InputStream input)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(ByteBuffer data)
     
    static VertexAISearch.DataStoreSpec
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<VertexAISearch.DataStoreSpec>
    parser()
     
    VertexAISearch.DataStoreSpec.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • 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

    • getDataStore

      public String getDataStore()
       Full resource name of DataStore, such as
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
      string data_store = 1;
      Specified by:
      getDataStore in interface VertexAISearch.DataStoreSpecOrBuilder
      Returns:
      The dataStore.

    • getDataStoreBytes

      public com.google.protobuf.ByteString getDataStoreBytes()
       Full resource name of DataStore, such as
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
      string data_store = 1;
      Specified by:
      getDataStoreBytes in interface VertexAISearch.DataStoreSpecOrBuilder
      Returns:
      The bytes for dataStore.

    • getFilter

      public String getFilter()
       Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface VertexAISearch.DataStoreSpecOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface VertexAISearch.DataStoreSpecOrBuilder
      Returns:
      The bytes for filter.

    • 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 VertexAISearch.DataStoreSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexAISearch.DataStoreSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexAISearch.DataStoreSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexAISearch.DataStoreSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexAISearch.DataStoreSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexAISearch.DataStoreSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexAISearch.DataStoreSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VertexAISearch.DataStoreSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VertexAISearch.DataStoreSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VertexAISearch.DataStoreSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VertexAISearch.DataStoreSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VertexAISearch.DataStoreSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public VertexAISearch.DataStoreSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static VertexAISearch.DataStoreSpec.Builder newBuilder()

    • newBuilder

      public static VertexAISearch.DataStoreSpec.Builder newBuilder(VertexAISearch.DataStoreSpec prototype)

    • toBuilder

      public VertexAISearch.DataStoreSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected VertexAISearch.DataStoreSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static VertexAISearch.DataStoreSpec getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<VertexAISearch.DataStoreSpec> 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 VertexAISearch.DataStoreSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder