Class RagFile (1.43.0)

Version latest

• 1.43.0 (latest)
• 1.42.0
• 1.40.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class RagFile extends GeneratedMessage implements RagFileOrBuilder

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

Protobuf type google.cloud.vertexai.v1.RagFile

Inheritance

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

Implements

RagFileOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

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

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

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

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

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

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

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

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

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

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

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

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

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

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

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

FILE_STATUS_FIELD_NUMBER

public static final int FILE_STATUS_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

JIRA_SOURCE_FIELD_NUMBER

public static final int JIRA_SOURCE_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

SHARE_POINT_SOURCES_FIELD_NUMBER

public static final int SHARE_POINT_SOURCES_FIELD_NUMBER

Field Value
Type	Description
int

SLACK_SOURCE_FIELD_NUMBER

public static final int SLACK_SOURCE_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.vertexai.v1.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.vertexai.v1.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.

getFileStatus()

public FileStatus getFileStatus()

Output only. State of the RagFile.

.google.cloud.vertexai.v1.FileStatus file_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
FileStatus	The fileStatus.

getFileStatusOrBuilder()

public FileStatusOrBuilder getFileStatusOrBuilder()

Output only. State of the RagFile.

.google.cloud.vertexai.v1.FileStatus file_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
FileStatusOrBuilder

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.vertexai.v1.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.vertexai.v1.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.vertexai.v1.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.vertexai.v1.GoogleDriveSource google_drive_source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
GoogleDriveSourceOrBuilder

getJiraSource()

public JiraSource getJiraSource()

The RagFile is imported from a Jira query.

.google.cloud.vertexai.v1.JiraSource jira_source = 12;

Returns
Type	Description
JiraSource	The jiraSource.

getJiraSourceOrBuilder()

public JiraSourceOrBuilder getJiraSourceOrBuilder()

The RagFile is imported from a Jira query.

.google.cloud.vertexai.v1.JiraSource jira_source = 12;

Returns
Type	Description
JiraSourceOrBuilder

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

GeneratedMessage.getParserForType()

getRagFileSourceCase()

public RagFile.RagFileSourceCase getRagFileSourceCase()

Returns
Type	Description
RagFile.RagFileSourceCase

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getSharePointSources()

public SharePointSources getSharePointSources()

The RagFile is imported from a SharePoint source.

.google.cloud.vertexai.v1.SharePointSources share_point_sources = 14;

Returns
Type	Description
SharePointSources	The sharePointSources.

getSharePointSourcesOrBuilder()

public SharePointSourcesOrBuilder getSharePointSourcesOrBuilder()

The RagFile is imported from a SharePoint source.

.google.cloud.vertexai.v1.SharePointSources share_point_sources = 14;

Returns
Type	Description
SharePointSourcesOrBuilder

getSlackSource()

public SlackSource getSlackSource()

The RagFile is imported from a Slack channel.

.google.cloud.vertexai.v1.SlackSource slack_source = 11;

Returns
Type	Description
SlackSource	The slackSource.

getSlackSourceOrBuilder()

public SlackSourceOrBuilder getSlackSourceOrBuilder()

The RagFile is imported from a Slack channel.

.google.cloud.vertexai.v1.SlackSource slack_source = 11;

Returns
Type	Description
SlackSourceOrBuilder

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.vertexai.v1.DirectUploadSource direct_upload_source = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the directUploadSource field is set.

hasFileStatus()

public boolean hasFileStatus()

Output only. State of the RagFile.

.google.cloud.vertexai.v1.FileStatus file_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the fileStatus 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.vertexai.v1.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.vertexai.v1.GoogleDriveSource google_drive_source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the googleDriveSource field is set.

hasJiraSource()

public boolean hasJiraSource()

The RagFile is imported from a Jira query.

.google.cloud.vertexai.v1.JiraSource jira_source = 12;

Returns
Type	Description
boolean	Whether the jiraSource field is set.

hasSharePointSources()

public boolean hasSharePointSources()

The RagFile is imported from a SharePoint source.

.google.cloud.vertexai.v1.SharePointSources share_point_sources = 14;

Returns
Type	Description
boolean	Whether the sharePointSources field is set.

hasSlackSource()

public boolean hasSlackSource()

The RagFile is imported from a Slack channel.

.google.cloud.vertexai.v1.SlackSource slack_source = 11;

Returns
Type	Description
boolean	Whether the slackSource 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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public RagFile.Builder newBuilderForType()

Returns
Type	Description
RagFile.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RagFile.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
RagFile.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public RagFile.Builder toBuilder()

Returns
Type	Description
RagFile.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException