Package com.google.cloud.speech.v2

Class PhraseSet

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.speech.v2.PhraseSet
All Implemented Interfaces:
PhraseSetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PhraseSet extends com.google.protobuf.GeneratedMessage implements PhraseSetOrBuilder
 PhraseSet for biasing in speech recognition. A PhraseSet is used to provide
 "hints" to the speech recognizer to favor specific words and phrases in the
 results.
Protobuf type google.cloud.speech.v2.PhraseSet
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 PhraseSet.
 Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface PhraseSetOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Identifier. The resource name of the PhraseSet.
 Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface PhraseSetOrBuilder
      Returns:
      The bytes for name.

    • getUid

      public String getUid()
       Output only. System-assigned unique identifier for the PhraseSet.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUid in interface PhraseSetOrBuilder
      Returns:
      The uid.

    • getUidBytes

      public com.google.protobuf.ByteString getUidBytes()
       Output only. System-assigned unique identifier for the PhraseSet.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUidBytes in interface PhraseSetOrBuilder
      Returns:
      The bytes for uid.

    • getPhrasesList

      public List<PhraseSet.Phrase> getPhrasesList()
       A list of word and phrases.
      repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
      Specified by:
      getPhrasesList in interface PhraseSetOrBuilder

    • getPhrasesOrBuilderList

      public List<? extends PhraseSet.PhraseOrBuilder> getPhrasesOrBuilderList()
       A list of word and phrases.
      repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
      Specified by:
      getPhrasesOrBuilderList in interface PhraseSetOrBuilder

    • getPhrasesCount

      public int getPhrasesCount()
       A list of word and phrases.
      repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
      Specified by:
      getPhrasesCount in interface PhraseSetOrBuilder

    • getPhrases

      public PhraseSet.Phrase getPhrases(int index)
       A list of word and phrases.
      repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
      Specified by:
      getPhrases in interface PhraseSetOrBuilder

    • getPhrasesOrBuilder

      public PhraseSet.PhraseOrBuilder getPhrasesOrBuilder(int index)
       A list of word and phrases.
      repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;
      Specified by:
      getPhrasesOrBuilder in interface PhraseSetOrBuilder

    • getBoost

      public float getBoost()
       Hint Boost. Positive value will increase the probability that a specific
 phrase will be recognized over other similar sounding phrases. The higher
 the boost, the higher the chance of false positive recognition as well.
 Valid `boost` values are between 0 (exclusive) and 20. We recommend using a
 binary search approach to finding the optimal value for your use case as
 well as adding phrases both with and without boost to your requests.
      float boost = 4;
      Specified by:
      getBoost in interface PhraseSetOrBuilder
      Returns:
      The boost.

    • getDisplayName

      public String getDisplayName()
       User-settable, human-readable name for the PhraseSet. Must be 63
 characters or less.
      string display_name = 5;
      Specified by:
      getDisplayName in interface PhraseSetOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       User-settable, human-readable name for the PhraseSet. Must be 63
 characters or less.
      string display_name = 5;
      Specified by:
      getDisplayNameBytes in interface PhraseSetOrBuilder
      Returns:
      The bytes for displayName.

    • getStateValue

      public int getStateValue()
       Output only. The PhraseSet lifecycle state.
      .google.cloud.speech.v2.PhraseSet.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface PhraseSetOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public PhraseSet.State getState()
       Output only. The PhraseSet lifecycle state.
      .google.cloud.speech.v2.PhraseSet.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface PhraseSetOrBuilder
      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 PhraseSetOrBuilder
      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 PhraseSetOrBuilder
      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 PhraseSetOrBuilder

    • 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 PhraseSetOrBuilder
      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 PhraseSetOrBuilder
      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 PhraseSetOrBuilder

    • 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 PhraseSetOrBuilder
      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 PhraseSetOrBuilder
      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 PhraseSetOrBuilder

    • 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 PhraseSetOrBuilder
      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 PhraseSetOrBuilder
      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 PhraseSetOrBuilder

    • getAnnotationsCount

      public int getAnnotationsCount()
      Description copied from interface: PhraseSetOrBuilder
       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;
      Specified by:
      getAnnotationsCount in interface PhraseSetOrBuilder

    • containsAnnotations

      public boolean containsAnnotations(String key)
       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;
      Specified by:
      containsAnnotations in interface PhraseSetOrBuilder

    • getAnnotations

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

    • getAnnotationsMap

      public Map<String,String> getAnnotationsMap()
       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;
      Specified by:
      getAnnotationsMap in interface PhraseSetOrBuilder

    • getAnnotationsOrDefault

      public String getAnnotationsOrDefault(String key, String defaultValue)
       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;
      Specified by:
      getAnnotationsOrDefault in interface PhraseSetOrBuilder

    • getAnnotationsOrThrow

      public String getAnnotationsOrThrow(String key)
       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;
      Specified by:
      getAnnotationsOrThrow in interface PhraseSetOrBuilder

    • 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 PhraseSetOrBuilder
      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 PhraseSetOrBuilder
      Returns:
      The bytes for etag.

    • getReconciling

      public boolean getReconciling()
       Output only. Whether or not this PhraseSet is in the process of being
 updated.
      bool reconciling = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReconciling in interface PhraseSetOrBuilder
      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 PhraseSet 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 PhraseSetOrBuilder
      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 PhraseSet 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 PhraseSetOrBuilder
      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 PhraseSet 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 PhraseSetOrBuilder
      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 PhraseSet 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 PhraseSetOrBuilder
      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 PhraseSet parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PhraseSet.Builder newBuilder()

    • newBuilder

      public static PhraseSet.Builder newBuilder(PhraseSet prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PhraseSet getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<PhraseSet> 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 PhraseSet getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder