REST Resource: files

Ресурс: Файл

Файл, загруженный в API.

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.
}
Поля
name

string

Неизменный. Идентификатор. Имя File ресурса. Идентификатор (имя, исключая префикс «files/») может содержать до 40 символов, состоящих из строчных букв, цифр или дефисов (-). Идентификатор не может начинаться или заканчиваться тире. Если при создании имя пусто, будет создано уникальное имя. Пример: files/123-456

displayName

string

Необязательный. Удобочитаемое отображаемое имя File . Отображаемое имя должно содержать не более 512 символов, включая пробелы. Пример: «Приветственное изображение».

mimeType

string

Только вывод. MIME-тип файла.

sizeBytes

string ( int64 format)

Только вывод. Размер файла в байтах.

createTime

string ( Timestamp format)

Только вывод. Временная метка создания File .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Только вывод. Временная метка последнего обновления File .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

expirationTime

string ( Timestamp format)

Только вывод. Временная метка, когда File будет удален. Устанавливается только в том случае, если срок действия File истекает.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

sha256Hash

string ( bytes format)

Только вывод. SHA-256 хеш загруженных байтов.

Строка в кодировке Base64.

uri

string

Только вывод. URI File .

state

enum ( State )

Только вывод. Состояние обработки файла.

error

object ( Status )

Только вывод. Статус ошибки, если обработка файла не удалась.

metadata поля объединения. Метаданные для файла. metadata могут быть только одним из следующих:
videoMetadata

object ( VideoMetadata )

Только вывод. Метаданные для видео.

ВидеоМетаданные

Метаданные для File .

JSON-представление
{
  "videoDuration": string
}
Поля
videoDuration

string ( Duration format)

Продолжительность видео.

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

Состояние

Состояния жизненного цикла файла.

Перечисления
STATE_UNSPECIFIED Значение по умолчанию. Это значение используется, если состояние опущено.
PROCESSING Файл обрабатывается и пока не может быть использован для вывода.
ACTIVE Файл обработан и доступен для вывода.
FAILED Не удалось обработать файл.

Методы

delete

Удаляет File .

get

Получает метаданные для данного File .

list

Перечисляет метаданные для File , принадлежащих запрашивающему проекту.