Class RagCorpus.Builder (3.53.0)

public static final class RagCorpus.Builder extends GeneratedMessageV3.Builder<RagCorpus.Builder> implements RagCorpusOrBuilder

A RagCorpus is a RagFile container and a project can have multiple RagCorpora.

Protobuf type google.cloud.aiplatform.v1beta1.RagCorpus

Implements

RagCorpusOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RagCorpus.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RagCorpus.Builder
Overrides

build()

public RagCorpus build()
Returns
Type Description
RagCorpus

buildPartial()

public RagCorpus buildPartial()
Returns
Type Description
RagCorpus

clear()

public RagCorpus.Builder clear()
Returns
Type Description
RagCorpus.Builder
Overrides

clearCorpusStatus()

public RagCorpus.Builder clearCorpusStatus()

Output only. RagCorpus state.

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

Returns
Type Description
RagCorpus.Builder

clearCreateTime()

public RagCorpus.Builder clearCreateTime()

Output only. Timestamp when this RagCorpus was created.

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

Returns
Type Description
RagCorpus.Builder

clearDescription()

public RagCorpus.Builder clearDescription()

Optional. The description of the RagCorpus.

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

Returns
Type Description
RagCorpus.Builder

This builder for chaining.

clearDisplayName()

public RagCorpus.Builder clearDisplayName()

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
RagCorpus.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RagCorpus.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RagCorpus.Builder
Overrides

clearName()

public RagCorpus.Builder clearName()

Output only. The resource name of the RagCorpus.

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

Returns
Type Description
RagCorpus.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RagCorpus.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RagCorpus.Builder
Overrides

clearRagEmbeddingModelConfig()

public RagCorpus.Builder clearRagEmbeddingModelConfig()

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

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

Returns
Type Description
RagCorpus.Builder

clearRagVectorDbConfig()

public RagCorpus.Builder clearRagVectorDbConfig()

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

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

Returns
Type Description
RagCorpus.Builder

clearUpdateTime()

public RagCorpus.Builder clearUpdateTime()

Output only. Timestamp when this RagCorpus was last updated.

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

Returns
Type Description
RagCorpus.Builder

clone()

public RagCorpus.Builder clone()
Returns
Type Description
RagCorpus.Builder
Overrides

getCorpusStatus()

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

getCorpusStatusBuilder()

public CorpusStatus.Builder getCorpusStatusBuilder()

Output only. RagCorpus state.

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

Returns
Type Description
CorpusStatus.Builder

getCorpusStatusOrBuilder()

public CorpusStatusOrBuilder getCorpusStatusOrBuilder()

Output only. RagCorpus state.

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

Returns
Type Description
CorpusStatusOrBuilder

getCreateTime()

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

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this RagCorpus was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public RagCorpus getDefaultInstanceForType()
Returns
Type Description
RagCorpus

getDescription()

public String getDescription()

Optional. The description of the RagCorpus.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the RagCorpus.

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

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

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

getName()

public 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 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()

public RagEmbeddingModelConfig getRagEmbeddingModelConfig()

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

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

Returns
Type Description
RagEmbeddingModelConfig

The ragEmbeddingModelConfig.

getRagEmbeddingModelConfigBuilder()

public RagEmbeddingModelConfig.Builder getRagEmbeddingModelConfigBuilder()

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

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

Returns
Type Description
RagEmbeddingModelConfig.Builder

getRagEmbeddingModelConfigOrBuilder()

public RagEmbeddingModelConfigOrBuilder getRagEmbeddingModelConfigOrBuilder()

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

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

Returns
Type Description
RagEmbeddingModelConfigOrBuilder

getRagVectorDbConfig()

public RagVectorDbConfig getRagVectorDbConfig()

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

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

Returns
Type Description
RagVectorDbConfig

The ragVectorDbConfig.

getRagVectorDbConfigBuilder()

public RagVectorDbConfig.Builder getRagVectorDbConfigBuilder()

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

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

Returns
Type Description
RagVectorDbConfig.Builder

getRagVectorDbConfigOrBuilder()

public RagVectorDbConfigOrBuilder getRagVectorDbConfigOrBuilder()

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

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

Returns
Type Description
RagVectorDbConfigOrBuilder

getUpdateTime()

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

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this RagCorpus was last updated.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public 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

hasCorpusStatus()

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

hasCreateTime()

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

hasRagEmbeddingModelConfig()

public boolean hasRagEmbeddingModelConfig()

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

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

Returns
Type Description
boolean

Whether the ragEmbeddingModelConfig field is set.

hasRagVectorDbConfig()

public boolean hasRagVectorDbConfig()

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

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

Returns
Type Description
boolean

Whether the ragVectorDbConfig field is set.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCorpusStatus(CorpusStatus value)

public RagCorpus.Builder mergeCorpusStatus(CorpusStatus value)

Output only. RagCorpus state.

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

Parameter
Name Description
value CorpusStatus
Returns
Type Description
RagCorpus.Builder

mergeCreateTime(Timestamp value)

public RagCorpus.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this RagCorpus was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RagCorpus.Builder

mergeFrom(RagCorpus other)

public RagCorpus.Builder mergeFrom(RagCorpus other)
Parameter
Name Description
other RagCorpus
Returns
Type Description
RagCorpus.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagCorpus.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagCorpus.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RagCorpus.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RagCorpus.Builder
Overrides

mergeRagEmbeddingModelConfig(RagEmbeddingModelConfig value)

public RagCorpus.Builder mergeRagEmbeddingModelConfig(RagEmbeddingModelConfig value)

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

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

Parameter
Name Description
value RagEmbeddingModelConfig
Returns
Type Description
RagCorpus.Builder

mergeRagVectorDbConfig(RagVectorDbConfig value)

public RagCorpus.Builder mergeRagVectorDbConfig(RagVectorDbConfig value)

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

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

Parameter
Name Description
value RagVectorDbConfig
Returns
Type Description
RagCorpus.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagCorpus.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagCorpus.Builder
Overrides

mergeUpdateTime(Timestamp value)

public RagCorpus.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this RagCorpus was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RagCorpus.Builder

setCorpusStatus(CorpusStatus value)

public RagCorpus.Builder setCorpusStatus(CorpusStatus value)

Output only. RagCorpus state.

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

Parameter
Name Description
value CorpusStatus
Returns
Type Description
RagCorpus.Builder

setCorpusStatus(CorpusStatus.Builder builderForValue)

public RagCorpus.Builder setCorpusStatus(CorpusStatus.Builder builderForValue)

Output only. RagCorpus state.

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

Parameter
Name Description
builderForValue CorpusStatus.Builder
Returns
Type Description
RagCorpus.Builder

setCreateTime(Timestamp value)

public RagCorpus.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this RagCorpus was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RagCorpus.Builder

setCreateTime(Timestamp.Builder builderForValue)

public RagCorpus.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this RagCorpus was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RagCorpus.Builder

setDescription(String value)

public RagCorpus.Builder setDescription(String value)

Optional. The description of the RagCorpus.

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
RagCorpus.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public RagCorpus.Builder setDescriptionBytes(ByteString value)

Optional. The description of the RagCorpus.

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
RagCorpus.Builder

This builder for chaining.

setDisplayName(String value)

public RagCorpus.Builder setDisplayName(String value)

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
RagCorpus.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public RagCorpus.Builder setDisplayNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
RagCorpus.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RagCorpus.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RagCorpus.Builder
Overrides

setName(String value)

public RagCorpus.Builder setName(String value)

Output only. The resource name of the RagCorpus.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RagCorpus.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RagCorpus.Builder setNameBytes(ByteString value)

Output only. The resource name of the RagCorpus.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RagCorpus.Builder

This builder for chaining.

setRagEmbeddingModelConfig(RagEmbeddingModelConfig value)

public RagCorpus.Builder setRagEmbeddingModelConfig(RagEmbeddingModelConfig value)

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

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

Parameter
Name Description
value RagEmbeddingModelConfig
Returns
Type Description
RagCorpus.Builder

setRagEmbeddingModelConfig(RagEmbeddingModelConfig.Builder builderForValue)

public RagCorpus.Builder setRagEmbeddingModelConfig(RagEmbeddingModelConfig.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue RagEmbeddingModelConfig.Builder
Returns
Type Description
RagCorpus.Builder

setRagVectorDbConfig(RagVectorDbConfig value)

public RagCorpus.Builder setRagVectorDbConfig(RagVectorDbConfig value)

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

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

Parameter
Name Description
value RagVectorDbConfig
Returns
Type Description
RagCorpus.Builder

setRagVectorDbConfig(RagVectorDbConfig.Builder builderForValue)

public RagCorpus.Builder setRagVectorDbConfig(RagVectorDbConfig.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue RagVectorDbConfig.Builder
Returns
Type Description
RagCorpus.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RagCorpus.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RagCorpus.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RagCorpus.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagCorpus.Builder
Overrides

setUpdateTime(Timestamp value)

public RagCorpus.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this RagCorpus was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RagCorpus.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public RagCorpus.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this RagCorpus was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RagCorpus.Builder