REST Resource: files

Zasób: Plik

Plik przesłany do interfejsu API.

Zapis 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.
}
Pola
name

string

Stałe. Identyfikator. Nazwa zasobu File. Identyfikator (nazwa z wyłączeniem prefiksu „files/”) może zawierać maksymalnie 40 znaków, w tym małe znaki alfanumeryczne i myślniki (-). Identyfikator nie może zaczynać się ani kończyć myślnikiem. Jeśli nazwa jest pusta podczas tworzenia, zostanie wygenerowana unikalna nazwa. Przykład: files/123-456

displayName

string

Opcjonalnie. Czytelna dla człowieka wyświetlana nazwa elementu File. Wyświetlana nazwa może mieć maksymalnie 512 znaków łącznie ze spacjami. Przykład: „Obraz powitalny”

mimeType

string

Tylko dane wyjściowe. Typ pliku.

sizeBytes

string (int64 format)

Tylko dane wyjściowe. Rozmiar pliku w bajtach.

createTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia elementu File.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji elementu File.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

expirationTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa usunięcia elementu File. Ustaw ją tylko wtedy, gdy według harmonogramu File wygaśnie.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

sha256Hash

string (bytes format)

Tylko dane wyjściowe. Skrót SHA-256 przesłanych bajtów.

Ciąg zakodowany w standardzie base64.

uri

string

Tylko dane wyjściowe. Identyfikator URI obiektu w domenie File.

state

enum (State)

Tylko dane wyjściowe. Stan przetwarzania pliku.

error

object (Status)

Tylko dane wyjściowe. Stan błędu, jeśli nie udało się przetworzyć pliku.

Pole sumy metadata. Metadane pliku. metadata może być tylko jedną z tych wartości:
videoMetadata

object (VideoMetadata)

Tylko dane wyjściowe. Metadane filmu.

VideoMetadata

Metadane filmu File.

Zapis JSON
{
  "videoDuration": string
}
Pola
videoDuration

string (Duration format)

Czas trwania filmu.

Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „s”. Przykład: "3.5s".

Stan

Stany cyklu życia pliku.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna. Ta wartość jest używana, jeśli stan zostanie pominięty.
PROCESSING Trwa przetwarzanie pliku i nie można go jeszcze używać do wnioskowania.
ACTIVE Plik jest przetwarzany i dostępny do wnioskowania.
FAILED Nie udało się przetworzyć pliku.

Metody

delete

Usuwa File.

get

Pobiera metadane dla podanego elementu File.

list

Zawiera listę metadanych File należących do projektu, który wysłał żądanie.