Cloud Speech V2 Client - Class CustomClass (1.18.3)

Reference documentation and code samples for the Cloud Speech V2 Client class CustomClass.

CustomClass for biasing in speech recognition. Used to define a set of words or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Generated from protobuf message google.cloud.speech.v2.CustomClass

Namespace

Google \ Cloud \ Speech \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. Identifier. The resource name of the CustomClass. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}`.
`↳ uid`	`string` Output only. System-assigned unique identifier for the CustomClass.
`↳ display_name`	`string` Optional. User-settable, human-readable name for the CustomClass. Must be 63 characters or less.
`↳ items`	`array<Google\Cloud\Speech\V2\CustomClass\ClassItem>` A collection of class items.
`↳ state`	`int` Output only. The CustomClass lifecycle state.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Creation time.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The most recent time this resource was modified.
`↳ delete_time`	`Google\Protobuf\Timestamp` Output only. The time at which this resource was requested for deletion.
`↳ expire_time`	`Google\Protobuf\Timestamp` Output only. The time at which this resource will be purged.
`↳ annotations`	`array\|Google\Protobuf\Internal\MapField` Optional. 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.
`↳ 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.
`↳ reconciling`	`bool` Output only. Whether or not this CustomClass is in the process of being updated.
`↳ kms_key_name`	`string` Output only. The KMS key name with which the CustomClass is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
`↳ kms_key_version_name`	`string` Output only. The KMS key version name with which the CustomClass is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.

getName

Output only. Identifier. The resource name of the CustomClass.

Format: projects/{project}/locations/{location}/customClasses/{custom_class}.

Returns
Type	Description
`string`

setName

Output only. Identifier. The resource name of the CustomClass.

Format: projects/{project}/locations/{location}/customClasses/{custom_class}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. System-assigned unique identifier for the CustomClass.

Returns
Type	Description
`string`

setUid

Output only. System-assigned unique identifier for the CustomClass.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Optional. User-settable, human-readable name for the CustomClass. Must be 63 characters or less.

Returns
Type	Description
`string`

setDisplayName

Optional. User-settable, human-readable name for the CustomClass. Must be 63 characters or less.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getItems

A collection of class items.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setItems

A collection of class items.

Parameter
Name	Description
`var`	`array<Google\Cloud\Speech\V2\CustomClass\ClassItem>`

Returns
Type	Description
`$this`

getState

Output only. The CustomClass lifecycle state.

Returns
Type	Description
`int`

setState

Output only. The CustomClass lifecycle state.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCreateTime

Output only. Creation time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The most recent time this resource was modified.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The most recent time this resource was modified.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDeleteTime

Output only. The time at which this resource was requested for deletion.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The time at which this resource was requested for deletion.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getExpireTime

Output only. The time at which this resource will be purged.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasExpireTime

clearExpireTime

setExpireTime

Output only. The time at which this resource will be purged.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getAnnotations

Optional. 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.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setAnnotations

Optional. 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.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getEtag

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.

Returns
Type	Description
`string`

setEtag

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReconciling

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

Returns
Type	Description
`bool`

setReconciling

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getKmsKeyName

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

Returns
Type	Description
`string`

setKmsKeyName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getKmsKeyVersionName

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

Returns
Type	Description
`string`

setKmsKeyVersionName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`