Represents a File.
Package
@google-ai/generativelanguageConstructors
(constructor)(properties)
constructor(properties?: google.ai.generativelanguage.v1beta.IFile);Constructs a new File.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFile
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);File createTime.
displayName
public displayName: string;File displayName.
error
public error?: (google.rpc.IStatus|null);File error.
expirationTime
public expirationTime?: (google.protobuf.ITimestamp|null);File expirationTime.
metadata
public metadata?: "videoMetadata";File metadata.
mimeType
public mimeType: string;File mimeType.
name
public name: string;File name.
sha256Hash
public sha256Hash: (Uint8Array|string);File sha256Hash.
sizeBytes
public sizeBytes: (number|Long|string);File sizeBytes.
state
public state: (google.ai.generativelanguage.v1beta.File.State|keyof typeof google.ai.generativelanguage.v1beta.File.State);File state.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);File updateTime.
uri
public uri: string;File uri.
videoMetadata
public videoMetadata?: (google.ai.generativelanguage.v1beta.IVideoMetadata|null);File videoMetadata.
Methods
create(properties)
public static create(properties?: google.ai.generativelanguage.v1beta.IFile): google.ai.generativelanguage.v1beta.File;Creates a new File instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFile
Properties to set |
| Returns | |
|---|---|
| Type | Description |
File |
File instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ai.generativelanguage.v1beta.File;Decodes a File 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 |
File |
File |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ai.generativelanguage.v1beta.File;Decodes a File message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
File |
File |
encode(message, writer)
public static encode(message: google.ai.generativelanguage.v1beta.IFile, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified File message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFile
File 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.ai.generativelanguage.v1beta.IFile, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified File message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFile
File 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.ai.generativelanguage.v1beta.File;Creates a File 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 |
File |
File |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for File
| 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 File to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ai.generativelanguage.v1beta.File, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a File message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
File
File |
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 File message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|