Struct google_api_proto::google::ai::generativelanguage::v1beta::File

pub struct File {
    pub name: String,
    pub display_name: String,
    pub mime_type: String,
    pub size_bytes: i64,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub expiration_time: Option<Timestamp>,
    pub sha256_hash: Bytes,
    pub uri: String,
    pub state: i32,
    pub error: Option<Status>,
    pub metadata: Option<Metadata>,
}

A file uploaded to the API.

Fields

name: String

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

display_name: String

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”

mime_type: String

Output only. MIME type of the file.

size_bytes: i64

Output only. Size of the file in bytes.

create_time: Option<Timestamp>

Output only. The timestamp of when the File was created.

update_time: Option<Timestamp>

Output only. The timestamp of when the File was last updated.

expiration_time: Option<Timestamp>

Output only. The timestamp of when the File will be deleted. Only set if the File is scheduled to expire.

sha256_hash: Bytes

Output only. SHA-256 hash of the uploaded bytes.

uri: String

Output only. The uri of the File.

state: i32

Output only. Processing state of the File.

error: Option<Status>

Output only. Error status if File processing failed.

metadata: Option<Metadata>

Metadata for the File.

Implementations

impl File

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for File

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for File

fn default() -> Self

Returns the “default value” for a type.

impl Message for File

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for File

fn eq(&self, other: &File) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for File