REST Resource: files

Ressource: Datei

Eine Datei, die in die API hochgeladen wurde.

JSON-Darstellung
{
  "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.
}
Felder
name

string

Nicht veränderbar. Kennung. Der Name der File-Ressource. Die ID (Name ohne das Präfix „files/“) kann bis zu 40 Zeichen (in Kleinbuchstaben) oder Bindestriche (-) enthalten. Die ID darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird ein eindeutiger Name generiert. Beispiel: files/123-456

displayName

string

Optional. Der visuell lesbare Anzeigename für File. Der Anzeigename darf maximal 512 Zeichen (einschließlich Leerzeichen) lang sein. Beispiel: „Willkommensbild“

mimeType

string

Nur Ausgabe. Der MIME-Typ der Datei.

sizeBytes

string (int64 format)

Nur Ausgabe. Größe der Datei in Byte.

createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für die Erstellung des File.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für die letzte Aktualisierung von File.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

expirationTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für den Zeitpunkt, zu dem das File gelöscht wird. Wird nur festgelegt, wenn File ablaufen soll.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

sha256Hash

string (bytes format)

Nur Ausgabe. SHA-256-Hash der hochgeladenen Byte.

Ein base64-codierter String.

uri

string

Nur Ausgabe. Der URI von File.

state

enum (State)

Nur Ausgabe. Verarbeitungsstatus der Datei.

error

object (Status)

Nur Ausgabe. Fehlerstatus, wenn Dateiverarbeitung fehlgeschlagen ist.

Union-Feld metadata. Metadaten für die Datei. Für metadata ist nur einer der folgenden Werte zulässig:
videoMetadata

object (VideoMetadata)

Nur Ausgabe. Metadaten für ein Video.

VideoMetadata

Metadaten für ein Video File.

JSON-Darstellung
{
  "videoDuration": string
}
Felder
videoDuration

string (Duration format)

Dauer des Videos.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

Status

Status für den Lebenszyklus einer Datei.

Enums
STATE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Status ausgelassen wird.
PROCESSING Die Datei wird gerade verarbeitet und kann noch nicht für eine Inferenz verwendet werden.
ACTIVE Die Datei wurde verarbeitet und ist für die Inferenz verfügbar.
FAILED Verarbeitung der Datei fehlgeschlagen.

Methoden

delete

Löscht die File.

get

Ruft die Metadaten für die angegebene File ab.

list

Listet die Metadaten für Files auf, die dem anfragenden Projekt gehören.