Interface RagCorpusOrBuilder (3.68.0)

public interface RagCorpusOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBackendConfigCase()

public abstract RagCorpus.BackendConfigCase getBackendConfigCase()
Returns
Type Description
RagCorpus.BackendConfigCase

getCorpusStatus()

public abstract CorpusStatus getCorpusStatus()

Output only. RagCorpus state.

.google.cloud.aiplatform.v1beta1.CorpusStatus corpus_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CorpusStatus

The corpusStatus.

getCorpusStatusOrBuilder()

public abstract CorpusStatusOrBuilder getCorpusStatusOrBuilder()

Output only. RagCorpus state.

.google.cloud.aiplatform.v1beta1.CorpusStatus corpus_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CorpusStatusOrBuilder

getCorpusTypeConfig()

public abstract RagCorpus.CorpusTypeConfig getCorpusTypeConfig()

Optional. The corpus type config of the RagCorpus.

.google.cloud.aiplatform.v1beta1.RagCorpus.CorpusTypeConfig corpus_type_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagCorpus.CorpusTypeConfig

The corpusTypeConfig.

getCorpusTypeConfigOrBuilder()

public abstract RagCorpus.CorpusTypeConfigOrBuilder getCorpusTypeConfigOrBuilder()

Optional. The corpus type config of the RagCorpus.

.google.cloud.aiplatform.v1beta1.RagCorpus.CorpusTypeConfig corpus_type_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagCorpus.CorpusTypeConfigOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp when this RagCorpus was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this RagCorpus was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. The description of the RagCorpus.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The description of the RagCorpus.

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

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

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

Returns
Type Description
ByteString

The bytes for displayName.

getEncryptionSpec()

public abstract 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.v1beta1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionSpec

The encryptionSpec.

getEncryptionSpecOrBuilder()

public abstract 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.v1beta1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionSpecOrBuilder

getName()

public abstract String getName()

Output only. The resource name of the RagCorpus.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The resource name of the RagCorpus.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getRagEmbeddingModelConfig() (deprecated)

public abstract RagEmbeddingModelConfig getRagEmbeddingModelConfig()

Deprecated. google.cloud.aiplatform.v1beta1.RagCorpus.rag_embedding_model_config is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=348

Optional. Immutable. The embedding model config of the RagCorpus.

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig rag_embedding_model_config = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
RagEmbeddingModelConfig

The ragEmbeddingModelConfig.

getRagEmbeddingModelConfigOrBuilder() (deprecated)

public abstract RagEmbeddingModelConfigOrBuilder getRagEmbeddingModelConfigOrBuilder()

Optional. Immutable. The embedding model config of the RagCorpus.

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig rag_embedding_model_config = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
RagEmbeddingModelConfigOrBuilder

getRagFilesCount()

public abstract int getRagFilesCount()

Output only. Number of RagFiles in the RagCorpus.

int32 rag_files_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The ragFilesCount.

getRagVectorDbConfig() (deprecated)

public abstract RagVectorDbConfig getRagVectorDbConfig()

Deprecated. google.cloud.aiplatform.v1beta1.RagCorpus.rag_vector_db_config is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=355

Optional. Immutable. The Vector DB config of the RagCorpus.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig rag_vector_db_config = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
RagVectorDbConfig

The ragVectorDbConfig.

getRagVectorDbConfigOrBuilder() (deprecated)

public abstract RagVectorDbConfigOrBuilder getRagVectorDbConfigOrBuilder()

Optional. Immutable. The Vector DB config of the RagCorpus.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig rag_vector_db_config = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
RagVectorDbConfigOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Timestamp when this RagCorpus was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this RagCorpus was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVectorDbConfig()

public abstract RagVectorDbConfig getVectorDbConfig()

Optional. Immutable. The config for the Vector DBs.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig vector_db_config = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
RagVectorDbConfig

The vectorDbConfig.

getVectorDbConfigOrBuilder()

public abstract RagVectorDbConfigOrBuilder getVectorDbConfigOrBuilder()

Optional. Immutable. The config for the Vector DBs.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig vector_db_config = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
RagVectorDbConfigOrBuilder

getVertexAiSearchConfig()

public abstract VertexAiSearchConfig getVertexAiSearchConfig()

Optional. Immutable. The config for the Vertex AI Search.

.google.cloud.aiplatform.v1beta1.VertexAiSearchConfig vertex_ai_search_config = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
VertexAiSearchConfig

The vertexAiSearchConfig.

getVertexAiSearchConfigOrBuilder()

public abstract VertexAiSearchConfigOrBuilder getVertexAiSearchConfigOrBuilder()

Optional. Immutable. The config for the Vertex AI Search.

.google.cloud.aiplatform.v1beta1.VertexAiSearchConfig vertex_ai_search_config = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
VertexAiSearchConfigOrBuilder

hasCorpusStatus()

public abstract boolean hasCorpusStatus()

Output only. RagCorpus state.

.google.cloud.aiplatform.v1beta1.CorpusStatus corpus_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the corpusStatus field is set.

hasCorpusTypeConfig()

public abstract boolean hasCorpusTypeConfig()

Optional. The corpus type config of the RagCorpus.

.google.cloud.aiplatform.v1beta1.RagCorpus.CorpusTypeConfig corpus_type_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the corpusTypeConfig field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp when this RagCorpus was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEncryptionSpec()

public abstract 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.v1beta1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionSpec field is set.

hasRagEmbeddingModelConfig() (deprecated)

public abstract boolean hasRagEmbeddingModelConfig()

Deprecated. google.cloud.aiplatform.v1beta1.RagCorpus.rag_embedding_model_config is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=348

Optional. Immutable. The embedding model config of the RagCorpus.

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig rag_embedding_model_config = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the ragEmbeddingModelConfig field is set.

hasRagVectorDbConfig() (deprecated)

public abstract boolean hasRagVectorDbConfig()

Deprecated. google.cloud.aiplatform.v1beta1.RagCorpus.rag_vector_db_config is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=355

Optional. Immutable. The Vector DB config of the RagCorpus.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig rag_vector_db_config = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the ragVectorDbConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Timestamp when this RagCorpus was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasVectorDbConfig()

public abstract boolean hasVectorDbConfig()

Optional. Immutable. The config for the Vector DBs.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig vector_db_config = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the vectorDbConfig field is set.

hasVertexAiSearchConfig()

public abstract boolean hasVertexAiSearchConfig()

Optional. Immutable. The config for the Vertex AI Search.

.google.cloud.aiplatform.v1beta1.VertexAiSearchConfig vertex_ai_search_config = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the vertexAiSearchConfig field is set.