Table of Contents

Class RemoteFile

Namespace
GenerativeAI.Types
Assembly
GenerativeAI.dll

A file uploaded to the API.

public class RemoteFile
Inheritance
RemoteFile
Inherited Members
Extension Methods

Properties

CreateTime

Output only. The timestamp of when the File was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

[JsonPropertyName("createTime")]
public Timestamp? CreateTime { get; set; }

Property Value

Timestamp

DisplayName

Optional. The human-readable display name for the File. The display name must be no more than 512 characters in length, including spaces. Example: "Welcome Image"

[JsonPropertyName("displayName")]
public string? DisplayName { get; set; }

Property Value

string

DownloadUri

Output only. The download uri of the File.

[JsonPropertyName("downloadUri")]
public string? DownloadUri { get; set; }

Property Value

string

Error

Output only. Error status if File processing failed.

[JsonPropertyName("error")]
public Status? Error { get; set; }

Property Value

Status

ExpirationTime

Output only. The timestamp of when the File will be deleted. Only set if the File is scheduled to expire. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

[JsonPropertyName("expirationTime")]
public Timestamp? ExpirationTime { get; set; }

Property Value

Timestamp

MimeType

Output only. MIME type of the file.

[JsonPropertyName("mimeType")]
public string? MimeType { get; set; }

Property Value

string

Name

Immutable. Identifier. The File resource name. The ID (name excluding the "files/" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a unique name will be generated. Example: files/123-456

[JsonPropertyName("name")]
public string? Name { get; set; }

Property Value

string

Sha256Hash

Output only. SHA-256 hash of the uploaded bytes. A base64-encoded string.

[JsonPropertyName("sha256Hash")]
public string? Sha256Hash { get; set; }

Property Value

string

SizeBytes

Output only. Size of the file in bytes.

[JsonPropertyName("sizeBytes")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long? SizeBytes { get; set; }

Property Value

long?

Source

Source of the File.

[JsonPropertyName("source")]
public Source? Source { get; set; }

Property Value

Source?

State

Output only. Processing state of the File.

[JsonPropertyName("state")]
public FileState? State { get; set; }

Property Value

FileState?

UpdateTime

Output only. The timestamp of when the File was last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

[JsonPropertyName("updateTime")]
public Timestamp? UpdateTime { get; set; }

Property Value

Timestamp

Uri

Output only. The uri of the File.

[JsonPropertyName("uri")]
public string? Uri { get; set; }

Property Value

string

VideoMetadata

Output only. Metadata for a video.

[JsonPropertyName("videoMetadata")]
public VideoMetadata? VideoMetadata { get; set; }

Property Value

VideoMetadata

See Also