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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DIRECT_UPLOAD_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FILE_STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GCS_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GOOGLE_DRIVE_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int JIRA_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RAG_FILE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SHARE_POINT_SOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SIZE_BYTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SLACK_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static RagFile getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static RagFile.Builder newBuilder()
public static RagFile.Builder newBuilder(RagFile prototype)
| Parameter |
| Name |
Description |
prototype |
RagFile
|
public static RagFile parseDelimitedFrom(InputStream input)
public static RagFile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RagFile parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static RagFile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RagFile parseFrom(ByteString data)
public static RagFile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RagFile parseFrom(CodedInputStream input)
public static RagFile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RagFile parseFrom(InputStream input)
public static RagFile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RagFile parseFrom(ByteBuffer data)
public static RagFile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<RagFile> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this RagFile was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public RagFile getDefaultInstanceForType()
public String getDescription()
Optional. The description of the RagFile.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
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.
|
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];
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];
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.
|
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.
|
public FileStatus getFileStatus()
Output only. State of the RagFile.
.google.cloud.aiplatform.v1beta1.FileStatus file_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
FileStatus |
The fileStatus.
|
public FileStatusOrBuilder getFileStatusOrBuilder()
Output only. State of the RagFile.
.google.cloud.aiplatform.v1beta1.FileStatus file_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
|
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];
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];
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];
public JiraSource getJiraSource()
The RagFile is imported from a Jira query.
.google.cloud.aiplatform.v1beta1.JiraSource jira_source = 12;
| Returns |
| Type |
Description |
JiraSource |
The jiraSource.
|
public JiraSourceOrBuilder getJiraSourceOrBuilder()
The RagFile is imported from a Jira query.
.google.cloud.aiplatform.v1beta1.JiraSource jira_source = 12;
Output only. The resource name of the RagFile.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
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.
|
public Parser<RagFile> getParserForType()
Overrides
public RagFile.RagFileSourceCase getRagFileSourceCase()
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];
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.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public SharePointSources getSharePointSources()
The RagFile is imported from a SharePoint source.
.google.cloud.aiplatform.v1beta1.SharePointSources share_point_sources = 14;
public SharePointSourcesOrBuilder getSharePointSourcesOrBuilder()
The RagFile is imported from a SharePoint source.
.google.cloud.aiplatform.v1beta1.SharePointSources share_point_sources = 14;
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.
|
public SlackSource getSlackSource()
The RagFile is imported from a Slack channel.
.google.cloud.aiplatform.v1beta1.SlackSource slack_source = 11;
public SlackSourceOrBuilder getSlackSourceOrBuilder()
The RagFile is imported from a Slack channel.
.google.cloud.aiplatform.v1beta1.SlackSource slack_source = 11;
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.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this RagFile was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
|
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.
|
public boolean hasFileStatus()
Output only. State of the RagFile.
.google.cloud.aiplatform.v1beta1.FileStatus file_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the fileStatus field is set.
|
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.
|
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.
|
public boolean hasJiraSource()
The RagFile is imported from a Jira query.
.google.cloud.aiplatform.v1beta1.JiraSource jira_source = 12;
| Returns |
| Type |
Description |
boolean |
Whether the jiraSource field is set.
|
public boolean hasSharePointSources()
The RagFile is imported from a SharePoint source.
.google.cloud.aiplatform.v1beta1.SharePointSources share_point_sources = 14;
| Returns |
| Type |
Description |
boolean |
Whether the sharePointSources field is set.
|
public boolean hasSlackSource()
The RagFile is imported from a Slack channel.
.google.cloud.aiplatform.v1beta1.SlackSource slack_source = 11;
| Returns |
| Type |
Description |
boolean |
Whether the slackSource field is set.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public RagFile.Builder newBuilderForType()
protected RagFile.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public RagFile.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
