@Generated public final class PhraseSet extends com.google.protobuf.GeneratedMessage implements PhraseSetOrBuilder
Provides "hints" to the speech recognizer to favor specific words and phrases in the results.Protobuf type
google.cloud.speech.v1p1beta1.PhraseSet| Modifier and Type | Class and Description |
|---|---|
static class |
PhraseSet.Builder
Provides "hints" to the speech recognizer to favor specific words and phrases
in the results.
|
static class |
PhraseSet.Phrase
A phrases containing words and phrase "hints" so that
the speech recognition is more likely to recognize them.
|
static interface |
PhraseSet.PhraseOrBuilder |
static class |
PhraseSet.State
Set of states that define the lifecycle of a CustomClass.
|
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ANNOTATIONS_FIELD_NUMBER |
static int |
BOOST_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 |
KMS_KEY_NAME_FIELD_NUMBER |
static int |
KMS_KEY_VERSION_NAME_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PHRASES_FIELD_NUMBER |
static int |
RECONCILING_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
static int |
UID_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsAnnotations(String key)
Output only.
|
boolean |
equals(Object obj) |
Map<String,String> |
getAnnotations()
Deprecated.
|
int |
getAnnotationsCount()
Output only.
|
Map<String,String> |
getAnnotationsMap()
Output only.
|
String |
getAnnotationsOrDefault(String key,
String defaultValue)
Output only.
|
String |
getAnnotationsOrThrow(String key)
Output only.
|
float |
getBoost()
Hint Boost.
|
static PhraseSet |
getDefaultInstance() |
PhraseSet |
getDefaultInstanceForType() |
com.google.protobuf.Timestamp |
getDeleteTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getDeleteTimeOrBuilder()
Output only.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Output only.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Output only.
|
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.
|
String |
getKmsKeyName()
Output only.
|
com.google.protobuf.ByteString |
getKmsKeyNameBytes()
Output only.
|
String |
getKmsKeyVersionName()
Output only.
|
com.google.protobuf.ByteString |
getKmsKeyVersionNameBytes()
Output only.
|
String |
getName()
The resource name of the phrase set.
|
com.google.protobuf.ByteString |
getNameBytes()
The resource name of the phrase set.
|
com.google.protobuf.Parser<PhraseSet> |
getParserForType() |
PhraseSet.Phrase |
getPhrases(int index)
A list of word and phrases.
|
int |
getPhrasesCount()
A list of word and phrases.
|
List<PhraseSet.Phrase> |
getPhrasesList()
A list of word and phrases.
|
PhraseSet.PhraseOrBuilder |
getPhrasesOrBuilder(int index)
A list of word and phrases.
|
List<? extends PhraseSet.PhraseOrBuilder> |
getPhrasesOrBuilderList()
A list of word and phrases.
|
boolean |
getReconciling()
Output only.
|
int |
getSerializedSize() |
PhraseSet.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
String |
getUid()
Output only.
|
com.google.protobuf.ByteString |
getUidBytes()
Output only.
|
boolean |
hasDeleteTime()
Output only.
|
boolean |
hasExpireTime()
Output only.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static PhraseSet.Builder |
newBuilder() |
static PhraseSet.Builder |
newBuilder(PhraseSet prototype) |
PhraseSet.Builder |
newBuilderForType() |
protected PhraseSet.Builder |
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) |
static PhraseSet |
parseDelimitedFrom(InputStream input) |
static PhraseSet |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PhraseSet |
parseFrom(byte[] data) |
static PhraseSet |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PhraseSet |
parseFrom(ByteBuffer data) |
static PhraseSet |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PhraseSet |
parseFrom(com.google.protobuf.ByteString data) |
static PhraseSet |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PhraseSet |
parseFrom(com.google.protobuf.CodedInputStream input) |
static PhraseSet |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PhraseSet |
parseFrom(InputStream input) |
static PhraseSet |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<PhraseSet> |
parser() |
PhraseSet.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashFields, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int PHRASES_FIELD_NUMBER
public static final int BOOST_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageprotected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessagepublic String getName()
The resource name of the phrase set.
string name = 1;getName in interface PhraseSetOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The resource name of the phrase set.
string name = 1;getNameBytes in interface PhraseSetOrBuilderpublic List<PhraseSet.Phrase> getPhrasesList()
A list of word and phrases.
repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;getPhrasesList in interface PhraseSetOrBuilderpublic List<? extends PhraseSet.PhraseOrBuilder> getPhrasesOrBuilderList()
A list of word and phrases.
repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;getPhrasesOrBuilderList in interface PhraseSetOrBuilderpublic int getPhrasesCount()
A list of word and phrases.
repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;getPhrasesCount in interface PhraseSetOrBuilderpublic PhraseSet.Phrase getPhrases(int index)
A list of word and phrases.
repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;getPhrases in interface PhraseSetOrBuilderpublic PhraseSet.PhraseOrBuilder getPhrasesOrBuilder(int index)
A list of word and phrases.
repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;getPhrasesOrBuilder in interface PhraseSetOrBuilderpublic 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. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values 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;getBoost in interface PhraseSetOrBuilderpublic String getKmsKeyName()
Output only. The [KMS key
name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which
the content of the PhraseSet is encrypted. The expected format is
`projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
string kms_key_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getKmsKeyName in interface PhraseSetOrBuilderpublic com.google.protobuf.ByteString getKmsKeyNameBytes()
Output only. The [KMS key
name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which
the content of the PhraseSet is encrypted. The expected format is
`projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
string kms_key_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getKmsKeyNameBytes in interface PhraseSetOrBuilderpublic String getKmsKeyVersionName()
Output only. The [KMS key version
name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
with which content of 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 = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getKmsKeyVersionName in interface PhraseSetOrBuilderpublic com.google.protobuf.ByteString getKmsKeyVersionNameBytes()
Output only. The [KMS key version
name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
with which content of 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 = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getKmsKeyVersionNameBytes in interface PhraseSetOrBuilderpublic String getUid()
Output only. System-assigned unique identifier for the PhraseSet. This field is not used.
string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];getUid in interface PhraseSetOrBuilderpublic com.google.protobuf.ByteString getUidBytes()
Output only. System-assigned unique identifier for the PhraseSet. This field is not used.
string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];getUidBytes in interface PhraseSetOrBuilderpublic String getDisplayName()
Output only. User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
string display_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getDisplayName in interface PhraseSetOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Output only. User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
string display_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getDisplayNameBytes in interface PhraseSetOrBuilderpublic int getStateValue()
Output only. The CustomClass lifecycle state. This field is not used.
.google.cloud.speech.v1p1beta1.PhraseSet.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface PhraseSetOrBuilderpublic PhraseSet.State getState()
Output only. The CustomClass lifecycle state. This field is not used.
.google.cloud.speech.v1p1beta1.PhraseSet.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface PhraseSetOrBuilderpublic boolean hasDeleteTime()
Output only. The time at which this resource was requested for deletion. This field is not used.
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasDeleteTime in interface PhraseSetOrBuilderpublic com.google.protobuf.Timestamp getDeleteTime()
Output only. The time at which this resource was requested for deletion. This field is not used.
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeleteTime in interface PhraseSetOrBuilderpublic com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. The time at which this resource was requested for deletion. This field is not used.
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeleteTimeOrBuilder in interface PhraseSetOrBuilderpublic boolean hasExpireTime()
Output only. The time at which this resource will be purged. This field is not used.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasExpireTime in interface PhraseSetOrBuilderpublic com.google.protobuf.Timestamp getExpireTime()
Output only. The time at which this resource will be purged. This field is not used.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getExpireTime in interface PhraseSetOrBuilderpublic com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
Output only. The time at which this resource will be purged. This field is not used.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getExpireTimeOrBuilder in interface PhraseSetOrBuilderpublic int getAnnotationsCount()
PhraseSetOrBuilderOutput 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.
map<string, string> annotations = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAnnotationsCount in interface PhraseSetOrBuilderpublic boolean containsAnnotations(String key)
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.
map<string, string> annotations = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
containsAnnotations in interface PhraseSetOrBuilder@Deprecated public Map<String,String> getAnnotations()
getAnnotationsMap() instead.getAnnotations in interface PhraseSetOrBuilderpublic Map<String,String> getAnnotationsMap()
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.
map<string, string> annotations = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAnnotationsMap in interface PhraseSetOrBuilderpublic String getAnnotationsOrDefault(String key, String defaultValue)
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.
map<string, string> annotations = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAnnotationsOrDefault in interface PhraseSetOrBuilderpublic String getAnnotationsOrThrow(String key)
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.
map<string, string> annotations = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAnnotationsOrThrow in interface PhraseSetOrBuilderpublic 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. This field is not used.
string etag = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];getEtag in interface PhraseSetOrBuilderpublic 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. This field is not used.
string etag = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];getEtagBytes in interface PhraseSetOrBuilderpublic boolean getReconciling()
Output only. Whether or not this PhraseSet is in the process of being updated. This field is not used.
bool reconciling = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];getReconciling in interface PhraseSetOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessagepublic void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageIOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessagepublic boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static PhraseSet parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PhraseSet parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PhraseSet parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PhraseSet parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PhraseSet parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PhraseSet parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PhraseSet parseFrom(InputStream input) throws IOException
IOExceptionpublic static PhraseSet parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static PhraseSet parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static PhraseSet parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static PhraseSet parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static PhraseSet parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic PhraseSet.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static PhraseSet.Builder newBuilder()
public static PhraseSet.Builder newBuilder(PhraseSet prototype)
public PhraseSet.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected PhraseSet.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
newBuilderForType in class com.google.protobuf.AbstractMessagepublic static PhraseSet getDefaultInstance()
public static com.google.protobuf.Parser<PhraseSet> parser()
public com.google.protobuf.Parser<PhraseSet> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessagepublic PhraseSet getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2026 Google LLC. All rights reserved.