Package com.google.cloud.aiplatform.v1

Class RagCorpus

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.RagCorpus
All Implemented Interfaces:
RagCorpusOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RagCorpus extends com.google.protobuf.GeneratedMessage implements RagCorpusOrBuilder
 A RagCorpus is a RagFile container and a project can have multiple
 RagCorpora.
Protobuf type google.cloud.aiplatform.v1.RagCorpus
See Also:

  • Field Details

    • VECTOR_DB_CONFIG_FIELD_NUMBER

      public static final int VECTOR_DB_CONFIG_FIELD_NUMBER
      See Also:

    • VERTEX_AI_SEARCH_CONFIG_FIELD_NUMBER

      public static final int VERTEX_AI_SEARCH_CONFIG_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • CORPUS_STATUS_FIELD_NUMBER

      public static final int CORPUS_STATUS_FIELD_NUMBER
      See Also:

    • ENCRYPTION_SPEC_FIELD_NUMBER

      public static final int ENCRYPTION_SPEC_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

    • getBackendConfigCase

      public RagCorpus.BackendConfigCase getBackendConfigCase()
      Specified by:
      getBackendConfigCase in interface RagCorpusOrBuilder

    • hasVectorDbConfig

      public boolean hasVectorDbConfig()
       Optional. Immutable. The config for the Vector DBs.
      .google.cloud.aiplatform.v1.RagVectorDbConfig vector_db_config = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasVectorDbConfig in interface RagCorpusOrBuilder
      Returns:
      Whether the vectorDbConfig field is set.

    • getVectorDbConfig

      public RagVectorDbConfig getVectorDbConfig()
       Optional. Immutable. The config for the Vector DBs.
      .google.cloud.aiplatform.v1.RagVectorDbConfig vector_db_config = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getVectorDbConfig in interface RagCorpusOrBuilder
      Returns:
      The vectorDbConfig.

    • getVectorDbConfigOrBuilder

      public RagVectorDbConfigOrBuilder getVectorDbConfigOrBuilder()
       Optional. Immutable. The config for the Vector DBs.
      .google.cloud.aiplatform.v1.RagVectorDbConfig vector_db_config = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getVectorDbConfigOrBuilder in interface RagCorpusOrBuilder

    • hasVertexAiSearchConfig

      public boolean hasVertexAiSearchConfig()
       Optional. Immutable. The config for the Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAiSearchConfig vertex_ai_search_config = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasVertexAiSearchConfig in interface RagCorpusOrBuilder
      Returns:
      Whether the vertexAiSearchConfig field is set.

    • getVertexAiSearchConfig

      public VertexAiSearchConfig getVertexAiSearchConfig()
       Optional. Immutable. The config for the Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAiSearchConfig vertex_ai_search_config = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getVertexAiSearchConfig in interface RagCorpusOrBuilder
      Returns:
      The vertexAiSearchConfig.

    • getVertexAiSearchConfigOrBuilder

      public VertexAiSearchConfigOrBuilder getVertexAiSearchConfigOrBuilder()
       Optional. Immutable. The config for the Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAiSearchConfig vertex_ai_search_config = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getVertexAiSearchConfigOrBuilder in interface RagCorpusOrBuilder

    • getName

      public String getName()
       Output only. The resource name of the RagCorpus.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface RagCorpusOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The resource name of the RagCorpus.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface RagCorpusOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. The display name of the RagCorpus.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface RagCorpusOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the RagCorpus.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface RagCorpusOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Optional. The description of the RagCorpus.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface RagCorpusOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The description of the RagCorpus.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface RagCorpusOrBuilder
      Returns:
      The bytes for description.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when this RagCorpus was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface RagCorpusOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when this RagCorpus was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface RagCorpusOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when this RagCorpus was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface RagCorpusOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. Timestamp when this RagCorpus was last updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface RagCorpusOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp when this RagCorpus was last updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface RagCorpusOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when this RagCorpus was last updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface RagCorpusOrBuilder

    • hasCorpusStatus

      public boolean hasCorpusStatus()
       Output only. RagCorpus state.
      .google.cloud.aiplatform.v1.CorpusStatus corpus_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCorpusStatus in interface RagCorpusOrBuilder
      Returns:
      Whether the corpusStatus field is set.

    • getCorpusStatus

      public CorpusStatus getCorpusStatus()
       Output only. RagCorpus state.
      .google.cloud.aiplatform.v1.CorpusStatus corpus_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCorpusStatus in interface RagCorpusOrBuilder
      Returns:
      The corpusStatus.

    • getCorpusStatusOrBuilder

      public CorpusStatusOrBuilder getCorpusStatusOrBuilder()
       Output only. RagCorpus state.
      .google.cloud.aiplatform.v1.CorpusStatus corpus_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCorpusStatusOrBuilder in interface RagCorpusOrBuilder

    • hasEncryptionSpec

      public boolean hasEncryptionSpec()
       Optional. Immutable. The CMEK key name used to encrypt at-rest data related
 to this Corpus. Only applicable to RagManagedDb option for Vector DB. This
 field can only be set at corpus creation time, and cannot be updated or
 deleted.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEncryptionSpec in interface RagCorpusOrBuilder
      Returns:
      Whether the encryptionSpec field is set.

    • getEncryptionSpec

      public EncryptionSpec getEncryptionSpec()
       Optional. Immutable. The CMEK key name used to encrypt at-rest data related
 to this Corpus. Only applicable to RagManagedDb option for Vector DB. This
 field can only be set at corpus creation time, and cannot be updated or
 deleted.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEncryptionSpec in interface RagCorpusOrBuilder
      Returns:
      The encryptionSpec.

    • getEncryptionSpecOrBuilder

      public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
       Optional. Immutable. The CMEK key name used to encrypt at-rest data related
 to this Corpus. Only applicable to RagManagedDb option for Vector DB. This
 field can only be set at corpus creation time, and cannot be updated or
 deleted.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEncryptionSpecOrBuilder in interface RagCorpusOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RagCorpus parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RagCorpus parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RagCorpus.Builder newBuilder()

    • newBuilder

      public static RagCorpus.Builder newBuilder(RagCorpus prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RagCorpus getDefaultInstance()

    • parser

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

    • getParserForType

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