REST Resource: projects.locations.customClasses

Resource: CustomClass

A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.

JSON representation 
{
  "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
}
Fields
name

string

The resource name of the custom class.
customClassId

string

If this custom class is a resource, the customClassId is the resource id of the CustomClass. Case sensitive.
items[]

object (ClassItem)

A collection of class items.
kmsKeyName

string

Output only. The KMS key name with which the content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
kmsKeyVersionName

string

Output only. The KMS key version name with which content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
uid

string

Output only. System-assigned unique identifier for the CustomClass. This field is not used.
displayName

string

Output only. User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
state

enum (State)

Output only. The CustomClass lifecycle state. This field is not used.
deleteTime

string (Timestamp format)

Output only. The time at which this resource was requested for deletion. This field is not used.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
expireTime

string (Timestamp format)

Output only. The time at which this resource will be purged. This field is not used.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
annotations

map (key: string, value: string)

Output only. Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
etag

string

Output only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
reconciling

boolean

Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.

ClassItem

An item of the class.

JSON representation 
{
  "value": string
}
Fields
value

string

The class item's value.

State

Set of states that define the lifecycle of a CustomClass.

Enums
STATE_UNSPECIFIED Unspecified state. This is only used/useful for distinguishing unset values.
ACTIVE The normal and active state.
DELETED This CustomClass has been deleted.

Methods

create

 Create a custom class.

delete

 Delete a custom class.

get

 Get a custom class.

list

 List custom classes.

patch

 Update a custom class.