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 资源名称。ID(不含“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

仅限输出。File 的 URI。

state

enum (State)

仅限输出。文件的处理状态。

error

object (Status)

仅限输出。文件处理失败时显示的错误状态。

联合字段 metadata。文件的元数据。metadata 只能是下列其中一项:
videoMetadata

object (VideoMetadata)

仅限输出。视频的元数据。

VideoMetadata

视频 File 的元数据。

JSON 表示法
{
  "videoDuration": string
}
字段
videoDuration

string (Duration format)

视频的持续时间。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

状态

文件生命周期的状态。

枚举
STATE_UNSPECIFIED 默认值。如果省略状态,则使用此值。
PROCESSING 文件正在处理中,还不能用于推断。
ACTIVE 文件已处理,可供推断。
FAILED 文件处理失败。

方法

delete

删除 File

get

获取指定 File 的元数据。

list

列出发出请求的项目所拥有的 File 的元数据。