# Cloud Speech-to-Text V1p1beta1 API - Class Google::Cloud::Speech::V1p1beta1::CustomClass (v0.30.0)

0.30.0 (latest) 0.29.1 0.28.0 0.27.1 0.26.0 0.25.0 0.24.1 0.23.0 0.22.0 0.21.1 0.20.2 0.19.0 0.18.1 0.17.1 0.16.0 0.15.3 0.14.0 0.13.0 0.12.4 Reference documentation and code samples for the Cloud Speech-to-Text V1p1beta1 API class Google::Cloud::Speech::V1p1beta1::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.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #annotations

    def annotations() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::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.

### #custom_class_id

    def custom_class_id() -> ::String

**Returns**

- (::String) --- If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.

### #custom_class_id=

    def custom_class_id=(value) -> ::String

**Parameter**

- **value** (::String) --- If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
**Returns**

- (::String) --- If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.

### #delete_time

    def delete_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1p1beta1/latest/Google-Protobuf-Timestamp)) --- Output only. The time at which this resource was requested for deletion. This field is not used.

### #display_name

    def display_name() -> ::String

**Returns**

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

### #etag

    def etag() -> ::String

**Returns**

- (::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.

### #expire_time

    def expire_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1p1beta1/latest/Google-Protobuf-Timestamp)) --- Output only. The time at which this resource will be purged. This field is not used.

### #items

    def items() -> ::Array<::Google::Cloud::Speech::V1p1beta1::CustomClass::ClassItem>

**Returns**

- (::Array\<[::Google::Cloud::Speech::V1p1beta1::CustomClass::ClassItem](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1p1beta1/latest/Google-Cloud-Speech-V1p1beta1-CustomClass-ClassItem)\>) --- A collection of class items.

### #items=

    def items=(value) -> ::Array<::Google::Cloud::Speech::V1p1beta1::CustomClass::ClassItem>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Speech::V1p1beta1::CustomClass::ClassItem](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1p1beta1/latest/Google-Cloud-Speech-V1p1beta1-CustomClass-ClassItem)\>) --- A collection of class items.
**Returns**

- (::Array\<[::Google::Cloud::Speech::V1p1beta1::CustomClass::ClassItem](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1p1beta1/latest/Google-Cloud-Speech-V1p1beta1-CustomClass-ClassItem)\>) --- A collection of class items.

### #kms_key_name

    def kms_key_name() -> ::String

**Returns**

- (::String) --- Output only. The [KMS key
  name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

### #kms_key_version_name

    def kms_key_version_name() -> ::String

**Returns**

- (::String) --- Output only. The [KMS key version
  name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) 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}`.

### #name

    def name() -> ::String

**Returns**

- (::String) --- The resource name of the custom class.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- The resource name of the custom class.
**Returns**

- (::String) --- The resource name of the custom class.

### #reconciling

    def reconciling() -> ::Boolean

**Returns**

- (::Boolean) --- Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.

### #state

    def state() -> ::Google::Cloud::Speech::V1p1beta1::CustomClass::State

**Returns**

- ([::Google::Cloud::Speech::V1p1beta1::CustomClass::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v1p1beta1/latest/Google-Cloud-Speech-V1p1beta1-CustomClass-State)) --- Output only. The CustomClass lifecycle state. This field is not used.

### #uid

    def uid() -> ::String

**Returns**

- (::String) --- Output only. System-assigned unique identifier for the CustomClass. This field is not used.