REST Resource: projects.locations.customClasses

资源:CustomClass

一组表示音频中可能出现的常见概念的字词或短语,例如客船名称列表。您可以将 CustomClass 项替换为在 PhraseSet 短语中设置的占位符。

JSON 表示法
{
  "name": string,
  "customClassId": string,
  "items": [
    {
      object (ClassItem)
    }
  ],
  "kmsKeyName": string,
  "kmsKeyVersionName": string,
  "uid": string,
  "displayName": string,
  "state": enum (State),
  "deleteTime": string,
  "expireTime": string,
  "annotations": {
    string: string,
    ...
  },
  "etag": string,
  "reconciling": boolean
}
字段
name

string

自定义类的资源名称。

customClassId

string

如果此自定义类是资源,则 customClassId 是 CustomClass 的资源 ID。区分大小写。

items[]

object (ClassItem)

类项的集合。

kmsKeyName

string

仅限输出。用于加密 ClassItem 内容的 KMS 密钥名称。格式应为 projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}

kmsKeyVersionName

string

仅限输出。用于加密 ClassItem 内容的 KMS 密钥版本名称。格式应为 projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}

uid

string

仅限输出。系统为 CustomClass 分配的唯一标识符。此字段未使用。

displayName

string

仅限输出。用户可设置的 CustomClass 的人类可读名称。不得超过 63 个字符。此字段未使用。

state

enum (State)

仅限输出。CustomClass 生命周期状态。此字段未使用。

deleteTime

string (Timestamp format)

仅限输出。请求删除相应资源的时间。此字段未使用。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

expireTime

string (Timestamp format)

仅限输出。相应资源将被清除的时间。此字段未使用。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

annotations

map (key: string, value: string)

仅限输出。允许用户存储少量任意数据。键和值都不得超过 63 个字符。最多 100 条注释。此字段未使用。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

etag

string

仅限输出。此校验和由服务器根据其他字段的值计算得出。可在更新、取消删除和删除请求中发送,以确保客户端在继续操作之前具有最新值。此字段未使用。

reconciling

boolean

仅限输出。相应 CustomClass 是否正在更新。此字段未使用。

ClassItem

相应类别的商品。

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

string

类商品的值。

定义了 CustomClass 生命周期的一系列状态。

枚举
STATE_UNSPECIFIED 未指定状态。此值仅用于区分未设置的值。
ACTIVE 正常且有效状态。
DELETED 此 CustomClass 已被删除。

方法

create

创建自定义类。

delete

删除自定义类。

get

获取自定义类。

list

列出自定义类。

patch

更新自定义类。