REST Resource: files

Recurso: arquivo

Um arquivo enviado para a API.

Representação JSON
{
  "name": string,
  "displayName": string,
  "mimeType": string,
  "sizeBytes": string,
  "createTime": string,
  "updateTime": string,
  "expirationTime": string,
  "sha256Hash": string,
  "uri": string,
  "state": enum (State),
  "error": {
    object (Status)
  },

  // Union field metadata can be only one of the following:
  "videoMetadata": {
    object (VideoMetadata)
  }
  // End of list of possible types for union field metadata.
}
Campos
name

string

Imutável. Identificador. O nome do recurso File. O ID (nome que exclui o prefixo "files/") pode conter até 40 caracteres alfanuméricos em letras minúsculas ou traços (-). Ele não pode começar nem terminar com um traço. Se o nome estiver vazio na criação, um nome exclusivo será gerado. Exemplo: files/123-456

displayName

string

Opcional. O nome de exibição legível para o File. O nome de exibição não pode ter mais de 512 caracteres, incluindo espaços. Exemplo: "Imagem de boas-vindas".

mimeType

string

Apenas saída. Tipo MIME do arquivo.

sizeBytes

string (int64 format)

Apenas saída. Tamanho do arquivo em bytes.

createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando a File foi criada.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando o File foi atualizado pela última vez.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

expirationTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando o File será excluído. Definido apenas se o File estiver programado para expirar.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

sha256Hash

string (bytes format)

Apenas saída. O hash SHA-256 dos bytes enviados por upload.

Uma string codificada em base64.

uri

string

Apenas saída. O URI de File.

state

enum (State)

Apenas saída. Estado de processamento do arquivo.

error

object (Status)

Apenas saída. Status de erro se o processamento do arquivo falhar.

Campo de união metadata. Metadados do arquivo. metadata pode ser apenas de um dos tipos a seguir:
videoMetadata

object (VideoMetadata)

Apenas saída. Metadados de um vídeo.

VideoMetadata

Metadados de um vídeo File.

Representação JSON
{
  "videoDuration": string
}
Campos
videoDuration

string (Duration format)

Duração do vídeo.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

Estado

Estados para o ciclo de vida de um arquivo.

Enums
STATE_UNSPECIFIED O valor padrão. Esse valor será usado se o estado for omitido.
PROCESSING O arquivo está sendo processado e ainda não pode ser usado para inferência.
ACTIVE O arquivo é processado e fica disponível para inferência.
FAILED Falha ao processar o arquivo.

Métodos

delete

Exclui o File.

get

Recebe os metadados do File especificado.

list

Lista os metadados de Files de propriedade do projeto solicitante.