CustomClass (proto-google-cloud-speech-v2 4.28.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.speech.v2.CustomClass

All Implemented Interfaces:: CustomClassOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CustomClass
extends com.google.protobuf.GeneratedMessageV3
implements CustomClassOrBuilder

 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.

Protobuf type google.cloud.speech.v2.CustomClass

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CustomClass.Builder` CustomClass for biasing in speech recognition.
`static class`	`CustomClass.ClassItem` An item of the class.
`static interface`	`CustomClass.ClassItemOrBuilder`
`static class`	`CustomClass.State` Set of states that define the lifecycle of a CustomClass.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANNOTATIONS_FIELD_NUMBER`
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`DELETE_TIME_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`ETAG_FIELD_NUMBER`
`static int`	`EXPIRE_TIME_FIELD_NUMBER`
`static int`	`ITEMS_FIELD_NUMBER`
`static int`	`KMS_KEY_NAME_FIELD_NUMBER`
`static int`	`KMS_KEY_VERSION_NAME_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`RECONCILING_FIELD_NUMBER`
`static int`	`STATE_FIELD_NUMBER`
`static int`	`UID_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsAnnotations(String key)` Allows users to store small amounts of arbitrary data.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAnnotations()` Deprecated.
`int`	`getAnnotationsCount()` Allows users to store small amounts of arbitrary data.
`Map<String,String>`	`getAnnotationsMap()` Allows users to store small amounts of arbitrary data.
`String`	`getAnnotationsOrDefault(String key, String defaultValue)` Allows users to store small amounts of arbitrary data.
`String`	`getAnnotationsOrThrow(String key)` Allows users to store small amounts of arbitrary data.
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`static CustomClass`	`getDefaultInstance()`
`CustomClass`	`getDefaultInstanceForType()`
`com.google.protobuf.Timestamp`	`getDeleteTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getDeleteTimeOrBuilder()` Output only.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` User-settable, human-readable name for the CustomClass.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` User-settable, human-readable name for the CustomClass.
`String`	`getEtag()` Output only.
`com.google.protobuf.ByteString`	`getEtagBytes()` Output only.
`com.google.protobuf.Timestamp`	`getExpireTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getExpireTimeOrBuilder()` Output only.
`CustomClass.ClassItem`	`getItems(int index)` A collection of class items.
`int`	`getItemsCount()` A collection of class items.
`List<CustomClass.ClassItem>`	`getItemsList()` A collection of class items.
`CustomClass.ClassItemOrBuilder`	`getItemsOrBuilder(int index)` A collection of class items.
`List<? extends CustomClass.ClassItemOrBuilder>`	`getItemsOrBuilderList()` A collection of class items.
`String`	`getKmsKeyName()` Output only.
`com.google.protobuf.ByteString`	`getKmsKeyNameBytes()` Output only.
`String`	`getKmsKeyVersionName()` Output only.
`com.google.protobuf.ByteString`	`getKmsKeyVersionNameBytes()` Output only.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`com.google.protobuf.Parser<CustomClass>`	`getParserForType()`
`boolean`	`getReconciling()` Output only.
`int`	`getSerializedSize()`
`CustomClass.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`String`	`getUid()` Output only.
`com.google.protobuf.ByteString`	`getUidBytes()` Output only.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasDeleteTime()` Output only.
`boolean`	`hasExpireTime()` Output only.
`int`	`hashCode()`
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static CustomClass.Builder`	`newBuilder()`
`static CustomClass.Builder`	`newBuilder(CustomClass prototype)`
`CustomClass.Builder`	`newBuilderForType()`
`protected CustomClass.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static CustomClass`	`parseDelimitedFrom(InputStream input)`
`static CustomClass`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomClass`	`parseFrom(byte[] data)`
`static CustomClass`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomClass`	`parseFrom(ByteBuffer data)`
`static CustomClass`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomClass`	`parseFrom(com.google.protobuf.ByteString data)`
`static CustomClass`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomClass`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static CustomClass`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomClass`	`parseFrom(InputStream input)`
`static CustomClass`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<CustomClass>`	`parser()`
`CustomClass.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UID_FIELD_NUMBER
```
public static final int UID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ITEMS_FIELD_NUMBER
```
public static final int ITEMS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATE_FIELD_NUMBER
```
public static final int STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DELETE_TIME_FIELD_NUMBER
```
public static final int DELETE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXPIRE_TIME_FIELD_NUMBER
```
public static final int EXPIRE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ANNOTATIONS_FIELD_NUMBER
```
public static final int ANNOTATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ETAG_FIELD_NUMBER
```
public static final int ETAG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RECONCILING_FIELD_NUMBER
```
public static final int RECONCILING_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- KMS_KEY_NAME_FIELD_NUMBER
```
public static final int KMS_KEY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- KMS_KEY_VERSION_NAME_FIELD_NUMBER
```
public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Output only. The resource name of the CustomClass.
 Format:
 `projects/{project}/locations/{location}/customClasses/{custom_class}`.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getName in interface CustomClassOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of the CustomClass.
 Format:
 `projects/{project}/locations/{location}/customClasses/{custom_class}`.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getNameBytes in interface CustomClassOrBuilder
Returns:: The bytes for name.

getUid
```
public String getUid()
```
```
 Output only. System-assigned unique identifier for the CustomClass.
 
```
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUid in interface CustomClassOrBuilder

Returns:

The uid.

getUidBytes
```
public com.google.protobuf.ByteString getUidBytes()
```
```
 Output only. System-assigned unique identifier for the CustomClass.
 
```
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUidBytes in interface CustomClassOrBuilder

Returns:

The bytes for uid.

getDisplayName

public String getDisplayName()

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

string display_name = 4;

Specified by:: getDisplayName in interface CustomClassOrBuilder
Returns:: The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

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

string display_name = 4;

Specified by:: getDisplayNameBytes in interface CustomClassOrBuilder
Returns:: The bytes for displayName.

getItemsList
```
public List<CustomClass.ClassItem> getItemsList()
```
```
 A collection of class items.
 
```
repeated .google.cloud.speech.v2.CustomClass.ClassItem items = 5;
Specified by:

getItemsList in interface CustomClassOrBuilder

getItemsOrBuilderList
```
public List<? extends CustomClass.ClassItemOrBuilder> getItemsOrBuilderList()
```
```
 A collection of class items.
 
```
repeated .google.cloud.speech.v2.CustomClass.ClassItem items = 5;
Specified by:

getItemsOrBuilderList in interface CustomClassOrBuilder

getItemsCount
```
public int getItemsCount()
```
```
 A collection of class items.
 
```
repeated .google.cloud.speech.v2.CustomClass.ClassItem items = 5;
Specified by:

getItemsCount in interface CustomClassOrBuilder

getItems
```
public CustomClass.ClassItem getItems(int index)
```
```
 A collection of class items.
 
```
repeated .google.cloud.speech.v2.CustomClass.ClassItem items = 5;
Specified by:

getItems in interface CustomClassOrBuilder

getItemsOrBuilder
```
public CustomClass.ClassItemOrBuilder getItemsOrBuilder(int index)
```
```
 A collection of class items.
 
```
repeated .google.cloud.speech.v2.CustomClass.ClassItem items = 5;
Specified by:

getItemsOrBuilder in interface CustomClassOrBuilder

getStateValue
```
public int getStateValue()
```
```
 Output only. The CustomClass lifecycle state.
 
```
.google.cloud.speech.v2.CustomClass.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getStateValue in interface CustomClassOrBuilder

Returns:

The enum numeric value on the wire for state.

getState
```
public CustomClass.State getState()
```
```
 Output only. The CustomClass lifecycle state.
 
```
.google.cloud.speech.v2.CustomClass.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getState in interface CustomClassOrBuilder

Returns:

The state.

hasCreateTime
```
public boolean hasCreateTime()
```
```
 Output only. Creation time.
 
```
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasCreateTime in interface CustomClassOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime
```
public com.google.protobuf.Timestamp getCreateTime()
```
```
 Output only. Creation time.
 
```
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTime in interface CustomClassOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
```
```
 Output only. Creation time.
 
```
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTimeOrBuilder in interface CustomClassOrBuilder

hasUpdateTime
```
public boolean hasUpdateTime()
```
```
 Output only. The most recent time this resource was modified.
 
```
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasUpdateTime in interface CustomClassOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime
```
public com.google.protobuf.Timestamp getUpdateTime()
```
```
 Output only. The most recent time this resource was modified.
 
```
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTime in interface CustomClassOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
```
```
 Output only. The most recent time this resource was modified.
 
```
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTimeOrBuilder in interface CustomClassOrBuilder

hasDeleteTime
```
public boolean hasDeleteTime()
```
```
 Output only. The time at which this resource was requested for deletion.
 
```
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasDeleteTime in interface CustomClassOrBuilder

Returns:

Whether the deleteTime field is set.

getDeleteTime
```
public com.google.protobuf.Timestamp getDeleteTime()
```
```
 Output only. The time at which this resource was requested for deletion.
 
```
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getDeleteTime in interface CustomClassOrBuilder

Returns:

The deleteTime.

getDeleteTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
```
```
 Output only. The time at which this resource was requested for deletion.
 
```
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getDeleteTimeOrBuilder in interface CustomClassOrBuilder

hasExpireTime
```
public boolean hasExpireTime()
```
```
 Output only. The time at which this resource will be purged.
 
```
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasExpireTime in interface CustomClassOrBuilder

Returns:

Whether the expireTime field is set.

getExpireTime
```
public com.google.protobuf.Timestamp getExpireTime()
```
```
 Output only. The time at which this resource will be purged.
 
```
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getExpireTime in interface CustomClassOrBuilder

Returns:

The expireTime.

getExpireTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
```
```
 Output only. The time at which this resource will be purged.
 
```
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getExpireTimeOrBuilder in interface CustomClassOrBuilder