REST Resource: files

Ressource: Fichier

Un fichier importé dans l'API

Représentation 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.
}
Champs
name

string

Immuable. Identifiant. Nom de la ressource File. L'ID (nom sans le préfixe "files/") peut contenir jusqu'à 40 caractères alphanumériques en minuscules ou des tirets (-). L'ID ne peut pas commencer ni se terminer par un tiret. Si vous ne renseignez pas de nom lors de la création, un nom unique sera généré. Exemple : files/123-456

displayName

string

Facultatif. Nom lisible à afficher pour File. Le nom à afficher ne doit pas dépasser 512 caractères, espaces compris. Exemple: "Image de bienvenue"

mimeType

string

Uniquement en sortie. Type MIME du fichier.

sizeBytes

string (int64 format)

Uniquement en sortie. Taille du fichier en octets.

createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la création de File.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la dernière mise à jour de File.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

expirationTime

string (Timestamp format)

Uniquement en sortie. Code temporel correspondant au moment où File sera supprimé. Défini uniquement si l'expiration de File est planifiée.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

sha256Hash

string (bytes format)

Uniquement en sortie. Hachage SHA-256 des octets importés.

Chaîne encodée en base64.

uri

string

Uniquement en sortie. URI de File.

state

enum (State)

Uniquement en sortie. État de traitement du fichier.

error

object (Status)

Uniquement en sortie. État d'erreur si le traitement du fichier a échoué.

Champ d'union metadata. Métadonnées du fichier. metadata ne peut être qu'un des éléments suivants :
videoMetadata

object (VideoMetadata)

Uniquement en sortie. Métadonnées d'une vidéo.

VideoMetadata

Métadonnées d'une vidéo File.

Représentation JSON
{
  "videoDuration": string
}
Champs
videoDuration

string (Duration format)

Durée de la vidéo.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

État

États pour le cycle de vie d'un fichier.

Enums
STATE_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si l'état est omis.
PROCESSING Le fichier est en cours de traitement et ne peut pas encore être utilisé pour l'inférence.
ACTIVE Le fichier est traité et disponible pour l'inférence.
FAILED Échec du traitement du fichier.

Méthodes

delete

Supprime File.

get

Récupère les métadonnées du File donné.

list

Répertorie les métadonnées des File appartenant au projet demandeur.