Represents a RagFile.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1.IRagFile);Constructs a new RagFile.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRagFile
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);RagFile createTime.
description
public description: string;RagFile description.
directUploadSource
public directUploadSource?: (google.cloud.aiplatform.v1.IDirectUploadSource|null);RagFile directUploadSource.
displayName
public displayName: string;RagFile displayName.
fileStatus
public fileStatus?: (google.cloud.aiplatform.v1.IFileStatus|null);RagFile fileStatus.
gcsSource
public gcsSource?: (google.cloud.aiplatform.v1.IGcsSource|null);RagFile gcsSource.
googleDriveSource
public googleDriveSource?: (google.cloud.aiplatform.v1.IGoogleDriveSource|null);RagFile googleDriveSource.
jiraSource
public jiraSource?: (google.cloud.aiplatform.v1.IJiraSource|null);RagFile jiraSource.
name
public name: string;RagFile name.
ragFileSource
public ragFileSource?: ("gcsSource"|"googleDriveSource"|"directUploadSource"|"slackSource"|"jiraSource"|"sharePointSources");RagFile ragFileSource.
sharePointSources
public sharePointSources?: (google.cloud.aiplatform.v1.ISharePointSources|null);RagFile sharePointSources.
slackSource
public slackSource?: (google.cloud.aiplatform.v1.ISlackSource|null);RagFile slackSource.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);RagFile updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.aiplatform.v1.IRagFile): google.cloud.aiplatform.v1.RagFile;Creates a new RagFile instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRagFile
Properties to set |
| Returns | |
|---|---|
| Type | Description |
RagFile |
RagFile instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.RagFile;Decodes a RagFile message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
RagFile |
RagFile |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.RagFile;Decodes a RagFile message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
RagFile |
RagFile |
encode(message, writer)
public static encode(message: google.cloud.aiplatform.v1.IRagFile, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RagFile message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRagFile
RagFile message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.aiplatform.v1.IRagFile, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RagFile message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRagFile
RagFile message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.RagFile;Creates a RagFile message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
RagFile |
RagFile |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for RagFile
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this RagFile to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.aiplatform.v1.RagFile, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a RagFile message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
RagFile
RagFile |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a RagFile message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|