Class RagFile (3.47.0)

public final class RagFile extends GeneratedMessageV3 implements RagFileOrBuilder

A RagFile contains user data for chunking, embedding and indexing.

Protobuf type google.cloud.aiplatform.v1beta1.RagFile

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RagFile

Implements

RagFileOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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`

DIRECT_UPLOAD_SOURCE_FIELD_NUMBER

public static final int DIRECT_UPLOAD_SOURCE_FIELD_NUMBER

Field Value
Type	Description
`int`

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER

Field Value
Type	Description
`int`

GOOGLE_DRIVE_SOURCE_FIELD_NUMBER

public static final int GOOGLE_DRIVE_SOURCE_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

RAG_FILE_TYPE_FIELD_NUMBER

public static final int RAG_FILE_TYPE_FIELD_NUMBER

Field Value
Type	Description
`int`

SIZE_BYTES_FIELD_NUMBER

public static final int SIZE_BYTES_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 RagFile getDefaultInstance()

Returns
Type	Description
`RagFile`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static RagFile.Builder newBuilder()

Returns
Type	Description
`RagFile.Builder`

newBuilder(RagFile prototype)

public static RagFile.Builder newBuilder(RagFile prototype)

Parameter
Name	Description
`prototype`	`RagFile`

Returns
Type	Description
`RagFile.Builder`

parseDelimitedFrom(InputStream input)

public static RagFile parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagFile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static RagFile parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RagFile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static RagFile parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RagFile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static RagFile parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RagFile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static RagFile parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagFile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static RagFile parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RagFile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RagFile`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<RagFile> parser()

Returns
Type	Description
`Parser<RagFile>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this RagFile was created.

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

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this RagFile was created.

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

Returns
Type	Description
`TimestampOrBuilder`

getDefaultInstanceForType()

public RagFile getDefaultInstanceForType()

Returns
Type	Description
`RagFile`

getDescription()

public String getDescription()

Optional. The description of the RagFile.

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

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the RagFile.

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

Returns
Type	Description
`ByteString`	The bytes for description.

getDirectUploadSource()

public DirectUploadSource getDirectUploadSource()

Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.

.google.cloud.aiplatform.v1beta1.DirectUploadSource direct_upload_source = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`DirectUploadSource`	The directUploadSource.

getDirectUploadSourceOrBuilder()

public DirectUploadSourceOrBuilder getDirectUploadSourceOrBuilder()

Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.

.google.cloud.aiplatform.v1beta1.DirectUploadSource direct_upload_source = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`DirectUploadSourceOrBuilder`

getDisplayName()

public String getDisplayName()

Required. The display name of the RagFile. 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 RagFile. 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.

getGcsSource()

public GcsSource getGcsSource()

Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`GcsSource`	The gcsSource.

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`GcsSourceOrBuilder`

getGoogleDriveSource()

public GoogleDriveSource getGoogleDriveSource()

Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.

.google.cloud.aiplatform.v1beta1.GoogleDriveSource google_drive_source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`GoogleDriveSource`	The googleDriveSource.

getGoogleDriveSourceOrBuilder()

public GoogleDriveSourceOrBuilder getGoogleDriveSourceOrBuilder()

Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.

.google.cloud.aiplatform.v1beta1.GoogleDriveSource google_drive_source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`GoogleDriveSourceOrBuilder`

getName()

public String getName()

Output only. The resource name of the RagFile.

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

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

Returns
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<RagFile> getParserForType()

Returns
Type	Description
`Parser<RagFile>`

Overrides

GeneratedMessageV3.getParserForType()

getRagFileSourceCase()

public RagFile.RagFileSourceCase getRagFileSourceCase()

Returns
Type	Description
`RagFile.RagFileSourceCase`

getRagFileType()

public RagFile.RagFileType getRagFileType()

Output only. The type of the RagFile.

.google.cloud.aiplatform.v1beta1.RagFile.RagFileType rag_file_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`RagFile.RagFileType`	The ragFileType.

getRagFileTypeValue()

public int getRagFileTypeValue()

Output only. The type of the RagFile.

.google.cloud.aiplatform.v1beta1.RagFile.RagFileType rag_file_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for ragFileType.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getSizeBytes()

public long getSizeBytes()

Output only. The size of the RagFile in bytes.

int64 size_bytes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The sizeBytes.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this RagFile was last updated.

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

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this RagFile was last updated.

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

Returns
Type	Description
`TimestampOrBuilder`

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this RagFile was created.

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

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasDirectUploadSource()

public boolean hasDirectUploadSource()

Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.

.google.cloud.aiplatform.v1beta1.DirectUploadSource direct_upload_source = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the directUploadSource field is set.

hasGcsSource()

public boolean hasGcsSource()

Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the gcsSource field is set.

hasGoogleDriveSource()

public boolean hasGoogleDriveSource()

Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.

.google.cloud.aiplatform.v1beta1.GoogleDriveSource google_drive_source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the googleDriveSource field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this RagFile was last updated.

.google.protobuf.Timestamp update_time = 7 [(.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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public RagFile.Builder newBuilderForType()

Returns
Type	Description
`RagFile.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagFile.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`RagFile.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public RagFile.Builder toBuilder()

Returns
Type	Description
`RagFile.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`