Package com.google.cloud.speech.v2

Interface PhraseSetOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PhraseSet, PhraseSet.Builder
    public interface PhraseSetOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. The resource name of the PhraseSet.
 Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

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

      • getUid

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

      • getUidBytes

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

      • getPhrasesList

        List<PhraseSet.Phrase> getPhrasesList()
         A list of word and phrases.
        repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

      • getPhrases

        PhraseSet.Phrase getPhrases​(int index)
         A list of word and phrases.
        repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

      • getPhrasesCount

        int getPhrasesCount()
         A list of word and phrases.
        repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

      • getPhrasesOrBuilderList

        List<? extends PhraseSet.PhraseOrBuilder> getPhrasesOrBuilderList()
         A list of word and phrases.
        repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

      • getPhrasesOrBuilder

        PhraseSet.PhraseOrBuilder getPhrasesOrBuilder​(int index)
         A list of word and phrases.
        repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

      • getBoost

        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;
        Returns:
        The boost.

      • getDisplayName

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

      • getDisplayNameBytes

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

      • getStateValue

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

      • getState

        PhraseSet.State getState()
         Output only. The PhraseSet lifecycle state.
        .google.cloud.speech.v2.PhraseSet.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The most recent time this resource was modified.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        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];

      • hasDeleteTime

        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];
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        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];
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        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];

      • hasExpireTime

        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];
        Returns:
        Whether the expireTime field is set.

      • getExpireTime

        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];
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        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];

      • getAnnotationsCount

        int getAnnotationsCount()
         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;

      • containsAnnotations

        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;

      • getAnnotationsMap

        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;

      • getAnnotationsOrDefault

        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;

      • getAnnotationsOrThrow

        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;

      • getEtag

        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];
        Returns:
        The etag.

      • getEtagBytes

        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];
        Returns:
        The bytes for etag.

      • getReconciling

        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];
        Returns:
        The reconciling.

      • getKmsKeyName

        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) = { ... }
        Returns:
        The kmsKeyName.

      • getKmsKeyNameBytes

        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) = { ... }
        Returns:
        The bytes for kmsKeyName.

      • getKmsKeyVersionName

        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) = { ... }
        Returns:
        The kmsKeyVersionName.

      • getKmsKeyVersionNameBytes

        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) = { ... }
        Returns:
        The bytes for kmsKeyVersionName.