Class RagDataSchema (3.89.0)

public final class RagDataSchema extends GeneratedMessage implements RagDataSchemaOrBuilder

The schema of the user specified metadata.

Protobuf type google.cloud.aiplatform.v1beta1.RagDataSchema

Static Fields

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_DETAILS_FIELD_NUMBER

public static final int SCHEMA_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RagDataSchema getDefaultInstance()
Returns
Type Description
RagDataSchema

getDescriptor()

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

newBuilder()

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

newBuilder(RagDataSchema prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RagDataSchema getDefaultInstanceForType()
Returns
Type Description
RagDataSchema

getKey()

public String getKey()

Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.

string key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.

string key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for key.

getName()

public String getName()

Identifier. Resource name of the data schema in the form of: projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema} where the {rag_data_schema} part should be the same as the key field below.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name of the data schema in the form of: projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema} where the {rag_data_schema} part should be the same as the key field below.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSchemaDetails()

public RagMetadataSchemaDetails getSchemaDetails()

The schema details mapping to the key.

.google.cloud.aiplatform.v1beta1.RagMetadataSchemaDetails schema_details = 3;

Returns
Type Description
RagMetadataSchemaDetails

The schemaDetails.

getSchemaDetailsOrBuilder()

public RagMetadataSchemaDetailsOrBuilder getSchemaDetailsOrBuilder()

The schema details mapping to the key.

.google.cloud.aiplatform.v1beta1.RagMetadataSchemaDetails schema_details = 3;

Returns
Type Description
RagMetadataSchemaDetailsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasSchemaDetails()

public boolean hasSchemaDetails()

The schema details mapping to the key.

.google.cloud.aiplatform.v1beta1.RagMetadataSchemaDetails schema_details = 3;

Returns
Type Description
boolean

Whether the schemaDetails field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RagDataSchema.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RagDataSchema.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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