Package com.google.cloud.speech.v2

Class CustomClass

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated public final class CustomClass extends com.google.protobuf.GeneratedMessage 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:

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Output only. Identifier. The resource name of the CustomClass.
 Format:
 `projects/{project}/locations/{location}/customClasses/{custom_class}`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface CustomClassOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Identifier. The resource name of the CustomClass.
 Format:
 `projects/{project}/locations/{location}/customClasses/{custom_class}`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      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()
       Optional. User-settable, human-readable name for the CustomClass. Must be
 63 characters or less.
      string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayName in interface CustomClassOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. User-settable, human-readable name for the CustomClass. Must be
 63 characters or less.
      string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
      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

    • getAnnotationsCount

      public int getAnnotationsCount()
      Description copied from interface: CustomClassOrBuilder
       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.
      map<string, string> annotations = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsCount in interface CustomClassOrBuilder

    • containsAnnotations

      public boolean containsAnnotations(String key)
       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.
      map<string, string> annotations = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsAnnotations in interface CustomClassOrBuilder

    • getAnnotations

      @Deprecated public Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.
      Specified by:
      getAnnotations in interface CustomClassOrBuilder

    • getAnnotationsMap

      public Map<String,String> getAnnotationsMap()
       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.
      map<string, string> annotations = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsMap in interface CustomClassOrBuilder

    • getAnnotationsOrDefault

      public String getAnnotationsOrDefault(String key, String defaultValue)
       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.
      map<string, string> annotations = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsOrDefault in interface CustomClassOrBuilder

    • getAnnotationsOrThrow

      public String getAnnotationsOrThrow(String key)
       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.
      map<string, string> annotations = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsOrThrow in interface CustomClassOrBuilder

    • getEtag

      public String 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.
      string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEtag in interface CustomClassOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       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.
      string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEtagBytes in interface CustomClassOrBuilder
      Returns:
      The bytes for etag.

    • getReconciling

      public boolean getReconciling()
       Output only. Whether or not this CustomClass is in the process of being
 updated.
      bool reconciling = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReconciling in interface CustomClassOrBuilder
      Returns:
      The reconciling.

    • getKmsKeyName

      public String getKmsKeyName()
       Output only. The [KMS key
 name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which
 the CustomClass is encrypted. The expected format is
 `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
      string kms_key_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyName in interface CustomClassOrBuilder
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      public com.google.protobuf.ByteString getKmsKeyNameBytes()
       Output only. The [KMS key
 name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which
 the CustomClass is encrypted. The expected format is
 `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
      string kms_key_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyNameBytes in interface CustomClassOrBuilder
      Returns:
      The bytes for kmsKeyName.

    • getKmsKeyVersionName

      public String getKmsKeyVersionName()
       Output only. The [KMS key version
 name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
 with which the CustomClass is encrypted. The expected format is
 `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
      string kms_key_version_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyVersionName in interface CustomClassOrBuilder
      Returns:
      The kmsKeyVersionName.

    • getKmsKeyVersionNameBytes

      public com.google.protobuf.ByteString getKmsKeyVersionNameBytes()
       Output only. The [KMS key version
 name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
 with which the CustomClass is encrypted. The expected format is
 `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
      string kms_key_version_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyVersionNameBytes in interface CustomClassOrBuilder
      Returns:
      The bytes for kmsKeyVersionName.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CustomClass parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomClass parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomClass parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomClass parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomClass parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomClass parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomClass parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomClass parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CustomClass parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CustomClass parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomClass parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomClass parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CustomClass.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CustomClass.Builder newBuilder()

    • newBuilder

      public static CustomClass.Builder newBuilder(CustomClass prototype)

    • toBuilder

      public CustomClass.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CustomClass.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CustomClass getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CustomClass> parser()

    • getParserForType

      public com.google.protobuf.Parser<CustomClass> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public CustomClass getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder