REST Resource: files

Recurso: Archivo

Un archivo subido a la API.

Representación 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

Inmutable. Identificador. El nombre del recurso File. El ID (nombre sin el prefijo "files/") puede contener hasta 40 caracteres alfanuméricos en minúscula o guiones (-). No puede comenzar ni terminar con un guion. Si el nombre está vacío en la creación, se generará un nombre único. Ejemplo: files/123-456

displayName

string

Opcional. Es el nombre visible legible para el File. El nombre visible no debe superar los 512 caracteres, incluidos los espacios. Ejemplo: "Imagen de bienvenida"

mimeType

string

Solo salida. Es el tipo MIME del archivo.

sizeBytes

string (int64 format)

Solo salida. Tamaño del archivo expresado en bytes.

createTime

string (Timestamp format)

Solo salida. La marca de tiempo del momento en que se creó el File.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo salida. La marca de tiempo de la última actualización de File.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

expirationTime

string (Timestamp format)

Solo salida. La marca de tiempo de cuándo se borrará File. Solo se establece si el File está programado para vencer.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

sha256Hash

string (bytes format)

Solo salida. Hash SHA-256 de los bytes subidos.

String codificada en base64.

uri

string

Solo salida. El URI de File.

state

enum (State)

Solo salida. Estado de procesamiento del archivo.

error

object (Status)

Solo salida. Estado de error si falló el procesamiento del archivo.

Campo de unión metadata. Metadatos del archivo. Las direcciones (metadata) solo pueden ser una de las siguientes opciones:
videoMetadata

object (VideoMetadata)

Solo salida. Son los metadatos de un video.

VideoMetadata

Metadatos de un video File.

Representación JSON
{
  "videoDuration": string
}
Campos
videoDuration

string (Duration format)

Duración del video

Una duración en segundos con hasta nueve dígitos decimales que terminen en "s". Ejemplo: "3.5s".

Estado

Estados para el ciclo de vida de un archivo.

Enumeradores
STATE_UNSPECIFIED Es el valor predeterminado. Este valor se usa si se omite el estado.
PROCESSING El archivo se está procesando y aún no se puede usar para inferencias.
ACTIVE El archivo se procesa y está disponible para inferencia.
FAILED No se pudo procesar el archivo.

Métodos

delete

Borra el File.

get

Obtiene los metadatos de la File especificada.

list

Enumera los metadatos de los File que pertenecen al proyecto solicitante.