Class RagCorpus (3.47.0)

public final class RagCorpus extends GeneratedMessageV3 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 Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RAG_EMBEDDING_MODEL_CONFIG_FIELD_NUMBER

public static final int RAG_EMBEDDING_MODEL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RagCorpus getDefaultInstance()
Returns
Type Description
RagCorpus

getDescriptor()

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

newBuilder()

public static RagCorpus.Builder newBuilder()
Returns
Type Description
RagCorpus.Builder

newBuilder(RagCorpus prototype)

public static RagCorpus.Builder newBuilder(RagCorpus prototype)
Parameter
Name Description
prototype RagCorpus
Returns
Type Description
RagCorpus.Builder

parseDelimitedFrom(InputStream input)

public static RagCorpus parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagCorpus
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagCorpus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagCorpus
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RagCorpus parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RagCorpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RagCorpus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagCorpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RagCorpus parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RagCorpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RagCorpus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagCorpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RagCorpus parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RagCorpus
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RagCorpus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagCorpus
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RagCorpus parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagCorpus
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagCorpus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagCorpus
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RagCorpus parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RagCorpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RagCorpus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagCorpus
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RagCorpus> parser()
Returns
Type Description
Parser<RagCorpus>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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.

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.

getParserForType()

public Parser<RagCorpus> getParserForType()
Returns
Type Description
Parser<RagCorpus>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RagCorpus.Builder newBuilderForType()
Returns
Type Description
RagCorpus.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagCorpus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RagCorpus.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RagCorpus.Builder toBuilder()
Returns
Type Description
RagCorpus.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException