com.google.cloud.aiplatform.v1beta1

Interface RagCorpusOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RagCorpus, RagCorpus.Builder

public interface RagCorpusOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
RagCorpus.BackendConfigCase	getBackendConfigCase()
CorpusStatus	getCorpusStatus() Output only.
CorpusStatusOrBuilder	getCorpusStatusOrBuilder() Output only.
RagCorpus.CorpusTypeConfig	getCorpusTypeConfig() Optional.
RagCorpus.CorpusTypeConfigOrBuilder	getCorpusTypeConfigOrBuilder() Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
EncryptionSpec	getEncryptionSpec() Optional.
EncryptionSpecOrBuilder	getEncryptionSpecOrBuilder() Optional.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
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
RagEmbeddingModelConfigOrBuilder	getRagEmbeddingModelConfigOrBuilder() Deprecated.
int	getRagFilesCount() Output only.
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
RagVectorDbConfigOrBuilder	getRagVectorDbConfigOrBuilder() Deprecated.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
RagVectorDbConfig	getVectorDbConfig() Optional.
RagVectorDbConfigOrBuilder	getVectorDbConfigOrBuilder() Optional.
VertexAiSearchConfig	getVertexAiSearchConfig() Optional.
VertexAiSearchConfigOrBuilder	getVertexAiSearchConfigOrBuilder() Optional.
boolean	hasCorpusStatus() Output only.
boolean	hasCorpusTypeConfig() Optional.
boolean	hasCreateTime() Output only.
boolean	hasEncryptionSpec() Optional.
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
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
boolean	hasUpdateTime() Output only.
boolean	hasVectorDbConfig() Optional.
boolean	hasVertexAiSearchConfig() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasVectorDbConfig

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:

Whether the vectorDbConfig field is set.

getVectorDbConfig

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:

The vectorDbConfig.

getVectorDbConfigOrBuilder

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

hasVertexAiSearchConfig

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:

Whether the vertexAiSearchConfig field is set.

getVertexAiSearchConfig

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:

The vertexAiSearchConfig.

getVertexAiSearchConfigOrBuilder

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

getName

String getName()

 Output only. The resource name of the RagCorpus.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of the RagCorpus.
 

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

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

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

Returns:

The bytes for displayName.

getDescription

String getDescription()

 Optional. The description of the RagCorpus.
 

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

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Optional. The description of the RagCorpus.
 

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

Returns:

The bytes for description.

hasRagEmbeddingModelConfig

@Deprecated
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:

Whether the ragEmbeddingModelConfig field is set.

getRagEmbeddingModelConfig

@Deprecated
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:

The ragEmbeddingModelConfig.

getRagEmbeddingModelConfigOrBuilder

@Deprecated
RagEmbeddingModelConfigOrBuilder getRagEmbeddingModelConfigOrBuilder()

Deprecated.

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

hasRagVectorDbConfig

@Deprecated
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:

Whether the ragVectorDbConfig field is set.

getRagVectorDbConfig

@Deprecated
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:

The ragVectorDbConfig.

getRagVectorDbConfigOrBuilder

@Deprecated
RagVectorDbConfigOrBuilder getRagVectorDbConfigOrBuilder()

Deprecated.

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

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this RagCorpus was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

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

Returns:

The createTime.

getCreateTimeOrBuilder

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

hasUpdateTime

boolean hasUpdateTime()

 Output only. Timestamp when this RagCorpus was last updated.
 

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

Returns:

Whether the updateTime field is set.

getUpdateTime

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

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

hasCorpusStatus

boolean hasCorpusStatus()

 Output only. RagCorpus state.
 

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

Returns:

Whether the corpusStatus field is set.

getCorpusStatus

CorpusStatus getCorpusStatus()

 Output only. RagCorpus state.
 

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

Returns:

The corpusStatus.

getCorpusStatusOrBuilder

CorpusStatusOrBuilder getCorpusStatusOrBuilder()

 Output only. RagCorpus state.
 

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

getRagFilesCount

int getRagFilesCount()

 Output only. Number of RagFiles in the RagCorpus.
 

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

Returns:

The ragFilesCount.

hasEncryptionSpec

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:

Whether the encryptionSpec field is set.

getEncryptionSpec

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:

The encryptionSpec.

getEncryptionSpecOrBuilder

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

hasCorpusTypeConfig

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:

Whether the corpusTypeConfig field is set.

getCorpusTypeConfig

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:

The corpusTypeConfig.

getCorpusTypeConfigOrBuilder

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

getBackendConfigCase

RagCorpus.BackendConfigCase getBackendConfigCase()