Class PhraseSet.Builder (4.47.0) 

public static final class PhraseSet.Builder extends GeneratedMessageV3.Builder<PhraseSet.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PhraseSet.Builder

Implements

PhraseSetOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllPhrases(Iterable<? extends PhraseSet.Phrase> values)

public PhraseSet.Builder addAllPhrases(Iterable<? extends PhraseSet.Phrase> values)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.speech.v2.PhraseSet.Phrase>
Returns
Type Description
PhraseSet.Builder

addPhrases(PhraseSet.Phrase value)

public PhraseSet.Builder addPhrases(PhraseSet.Phrase value)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameter
Name Description
value PhraseSet.Phrase
Returns
Type Description
PhraseSet.Builder

addPhrases(PhraseSet.Phrase.Builder builderForValue)

public PhraseSet.Builder addPhrases(PhraseSet.Phrase.Builder builderForValue)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameter
Name Description
builderForValue PhraseSet.Phrase.Builder
Returns
Type Description
PhraseSet.Builder

addPhrases(int index, PhraseSet.Phrase value)

public PhraseSet.Builder addPhrases(int index, PhraseSet.Phrase value)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameters
Name Description
index int
value PhraseSet.Phrase
Returns
Type Description
PhraseSet.Builder

addPhrases(int index, PhraseSet.Phrase.Builder builderForValue)

public PhraseSet.Builder addPhrases(int index, PhraseSet.Phrase.Builder builderForValue)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameters
Name Description
index int
builderForValue PhraseSet.Phrase.Builder
Returns
Type Description
PhraseSet.Builder

addPhrasesBuilder()

public PhraseSet.Phrase.Builder addPhrasesBuilder()

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Returns
Type Description
PhraseSet.Phrase.Builder

addPhrasesBuilder(int index)

public PhraseSet.Phrase.Builder addPhrasesBuilder(int index)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameter
Name Description
index int
Returns
Type Description
PhraseSet.Phrase.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PhraseSet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PhraseSet.Builder
Overrides

build()

public PhraseSet build()
Returns
Type Description
PhraseSet

buildPartial()

public PhraseSet buildPartial()
Returns
Type Description
PhraseSet

clear()

public PhraseSet.Builder clear()
Returns
Type Description
PhraseSet.Builder
Overrides

clearAnnotations()

public PhraseSet.Builder clearAnnotations()
Returns
Type Description
PhraseSet.Builder

clearBoost()

public PhraseSet.Builder clearBoost()

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
Type Description
PhraseSet.Builder

This builder for chaining.

clearCreateTime()

public PhraseSet.Builder clearCreateTime()

Output only. Creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PhraseSet.Builder

clearDeleteTime()

public PhraseSet.Builder clearDeleteTime()

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
Type Description
PhraseSet.Builder

clearDisplayName()

public PhraseSet.Builder clearDisplayName()

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

string display_name = 5;

Returns
Type Description
PhraseSet.Builder

This builder for chaining.

clearEtag()

public PhraseSet.Builder clearEtag()

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
Type Description
PhraseSet.Builder

This builder for chaining.

clearExpireTime()

public PhraseSet.Builder clearExpireTime()

Output only. The time at which this resource will be purged.

.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PhraseSet.Builder

clearField(Descriptors.FieldDescriptor field)

public PhraseSet.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PhraseSet.Builder
Overrides

clearKmsKeyName()

public PhraseSet.Builder clearKmsKeyName()

Output only. The KMS key name 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
Type Description
PhraseSet.Builder

This builder for chaining.

clearKmsKeyVersionName()

public PhraseSet.Builder clearKmsKeyVersionName()

Output only. The KMS key version name 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
Type Description
PhraseSet.Builder

This builder for chaining.

clearName()

public PhraseSet.Builder clearName()

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

Returns
Type Description
PhraseSet.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PhraseSet.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PhraseSet.Builder
Overrides

clearPhrases()

public PhraseSet.Builder clearPhrases()

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Returns
Type Description
PhraseSet.Builder

clearReconciling()

public PhraseSet.Builder clearReconciling()

Output only. Whether or not this PhraseSet is in the process of being updated.

bool reconciling = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PhraseSet.Builder

This builder for chaining.

clearState()

public PhraseSet.Builder clearState()

Output only. The PhraseSet lifecycle state.

.google.cloud.speech.v2.PhraseSet.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PhraseSet.Builder

This builder for chaining.

clearUid()

public PhraseSet.Builder clearUid()

Output only. System-assigned unique identifier for the PhraseSet.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PhraseSet.Builder

This builder for chaining.

clearUpdateTime()

public PhraseSet.Builder clearUpdateTime()

Output only. The most recent time this resource was modified.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PhraseSet.Builder

clone()

public PhraseSet.Builder clone()
Returns
Type Description
PhraseSet.Builder
Overrides

containsAnnotations(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

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

Returns
Type Description
int

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;

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
String

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;

Returns
Type Description
float

The boost.

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public PhraseSet getDefaultInstanceForType()
Returns
Type Description
PhraseSet

getDeleteTime()

public 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
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

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
Type Description
Builder

getDeleteTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

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

string display_name = 5;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 5;

Returns
Type Description
ByteString

The bytes for displayName.

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

Returns
Type Description
String

The etag.

getEtagBytes()

public 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
Type Description
ByteString

The bytes for etag.

getExpireTime()

public 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
Type Description
Timestamp

The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

Output only. The time at which this resource will be purged.

.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getExpireTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getKmsKeyName()

public String getKmsKeyName()

Output only. The KMS key name 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
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Output only. The KMS key name 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
Type Description
ByteString

The bytes for kmsKeyName.

getKmsKeyVersionName()

public String getKmsKeyVersionName()

Output only. The KMS key version name 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
Type Description
String

The kmsKeyVersionName.

getKmsKeyVersionNameBytes()

public ByteString getKmsKeyVersionNameBytes()

Output only. The KMS key version name 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
Type Description
ByteString

The bytes for kmsKeyVersionName.

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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

Returns
Type Description
String

The name.

getNameBytes()

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

Returns
Type Description
ByteString

The bytes for name.

getPhrases(int index)

public PhraseSet.Phrase getPhrases(int index)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameter
Name Description
index int
Returns
Type Description
PhraseSet.Phrase

getPhrasesBuilder(int index)

public PhraseSet.Phrase.Builder getPhrasesBuilder(int index)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameter
Name Description
index int
Returns
Type Description
PhraseSet.Phrase.Builder

getPhrasesBuilderList()

public List<PhraseSet.Phrase.Builder> getPhrasesBuilderList()

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Returns
Type Description
List<Builder>

getPhrasesCount()

public int getPhrasesCount()

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Returns
Type Description
int

getPhrasesList()

public List<PhraseSet.Phrase> getPhrasesList()

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Returns
Type Description
List<Phrase>

getPhrasesOrBuilder(int index)

public PhraseSet.PhraseOrBuilder getPhrasesOrBuilder(int index)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameter
Name Description
index int
Returns
Type Description
PhraseSet.PhraseOrBuilder

getPhrasesOrBuilderList()

public List<? extends PhraseSet.PhraseOrBuilder> getPhrasesOrBuilderList()

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Returns
Type Description
List<? extends com.google.cloud.speech.v2.PhraseSet.PhraseOrBuilder>

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

Returns
Type Description
boolean

The reconciling.

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

Returns
Type Description
PhraseSet.State

The state.

getStateValue()

public int getStateValue()

Output only. The PhraseSet lifecycle state.

.google.cloud.speech.v2.PhraseSet.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

Output only. System-assigned unique identifier for the PhraseSet.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. System-assigned unique identifier for the PhraseSet.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public 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
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The most recent time this resource was modified.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The most recent time this resource was modified.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

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

Returns
Type Description
boolean

Whether the deleteTime field is set.

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

Returns
Type Description
boolean

Whether the expireTime field is set.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public PhraseSet.Builder mergeCreateTime(Timestamp value)

Output only. Creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
PhraseSet.Builder

mergeDeleteTime(Timestamp value)

public PhraseSet.Builder mergeDeleteTime(Timestamp value)

Output only. The time at which this resource was requested for deletion.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
PhraseSet.Builder

mergeExpireTime(Timestamp value)

public PhraseSet.Builder mergeExpireTime(Timestamp value)

Output only. The time at which this resource will be purged.

.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
PhraseSet.Builder

mergeFrom(PhraseSet other)

public PhraseSet.Builder mergeFrom(PhraseSet other)
Parameter
Name Description
other PhraseSet
Returns
Type Description
PhraseSet.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PhraseSet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhraseSet.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PhraseSet.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PhraseSet.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PhraseSet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PhraseSet.Builder
Overrides

mergeUpdateTime(Timestamp value)

public PhraseSet.Builder mergeUpdateTime(Timestamp value)

Output only. The most recent time this resource was modified.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
PhraseSet.Builder

putAllAnnotations(Map<String,String> values)

public PhraseSet.Builder putAllAnnotations(Map<String,String> values)

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;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
PhraseSet.Builder

putAnnotations(String key, String value)

public PhraseSet.Builder putAnnotations(String key, String value)

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;

Parameters
Name Description
key String
value String
Returns
Type Description
PhraseSet.Builder

removeAnnotations(String key)

public PhraseSet.Builder removeAnnotations(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;

Parameter
Name Description
key String
Returns
Type Description
PhraseSet.Builder

removePhrases(int index)

public PhraseSet.Builder removePhrases(int index)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameter
Name Description
index int
Returns
Type Description
PhraseSet.Builder

setBoost(float value)

public PhraseSet.Builder setBoost(float value)

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;

Parameter
Name Description
value float

The boost to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public PhraseSet.Builder setCreateTime(Timestamp value)

Output only. Creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
PhraseSet.Builder

setCreateTime(Timestamp.Builder builderForValue)

public PhraseSet.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Creation time.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PhraseSet.Builder

setDeleteTime(Timestamp value)

public PhraseSet.Builder setDeleteTime(Timestamp value)

Output only. The time at which this resource was requested for deletion.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
PhraseSet.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public PhraseSet.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. The time at which this resource was requested for deletion.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PhraseSet.Builder

setDisplayName(String value)

public PhraseSet.Builder setDisplayName(String value)

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

string display_name = 5;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public PhraseSet.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 5;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setEtag(String value)

public PhraseSet.Builder setEtag(String value)

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

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public PhraseSet.Builder setEtagBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setExpireTime(Timestamp value)

public PhraseSet.Builder setExpireTime(Timestamp value)

Output only. The time at which this resource will be purged.

.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
PhraseSet.Builder

setExpireTime(Timestamp.Builder builderForValue)

public PhraseSet.Builder setExpireTime(Timestamp.Builder builderForValue)

Output only. The time at which this resource will be purged.

.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PhraseSet.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PhraseSet.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PhraseSet.Builder
Overrides

setKmsKeyName(String value)

public PhraseSet.Builder setKmsKeyName(String value)

Output only. The KMS key name 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) = { ... }

Parameter
Name Description
value String

The kmsKeyName to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public PhraseSet.Builder setKmsKeyNameBytes(ByteString value)

Output only. The KMS key name 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) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKeyName to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setKmsKeyVersionName(String value)

public PhraseSet.Builder setKmsKeyVersionName(String value)

Output only. The KMS key version name 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) = { ... }

Parameter
Name Description
value String

The kmsKeyVersionName to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setKmsKeyVersionNameBytes(ByteString value)

public PhraseSet.Builder setKmsKeyVersionNameBytes(ByteString value)

Output only. The KMS key version name 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) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKeyVersionName to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setName(String value)

public PhraseSet.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setNameBytes(ByteString value)

public PhraseSet.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setPhrases(int index, PhraseSet.Phrase value)

public PhraseSet.Builder setPhrases(int index, PhraseSet.Phrase value)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameters
Name Description
index int
value PhraseSet.Phrase
Returns
Type Description
PhraseSet.Builder

setPhrases(int index, PhraseSet.Phrase.Builder builderForValue)

public PhraseSet.Builder setPhrases(int index, PhraseSet.Phrase.Builder builderForValue)

A list of word and phrases.

repeated .google.cloud.speech.v2.PhraseSet.Phrase phrases = 3;

Parameters
Name Description
index int
builderForValue PhraseSet.Phrase.Builder
Returns
Type Description
PhraseSet.Builder

setReconciling(boolean value)

public PhraseSet.Builder setReconciling(boolean value)

Output only. Whether or not this PhraseSet is in the process of being updated.

bool reconciling = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The reconciling to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PhraseSet.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PhraseSet.Builder
Overrides

setState(PhraseSet.State value)

public PhraseSet.Builder setState(PhraseSet.State value)

Output only. The PhraseSet lifecycle state.

.google.cloud.speech.v2.PhraseSet.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value PhraseSet.State

The state to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setStateValue(int value)

public PhraseSet.Builder setStateValue(int value)

Output only. The PhraseSet lifecycle state.

.google.cloud.speech.v2.PhraseSet.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setUid(String value)

public PhraseSet.Builder setUid(String value)

Output only. System-assigned unique identifier for the PhraseSet.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The uid to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setUidBytes(ByteString value)

public PhraseSet.Builder setUidBytes(ByteString value)

Output only. System-assigned unique identifier for the PhraseSet.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for uid to set.
Returns
Type Description
PhraseSet.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PhraseSet.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PhraseSet.Builder
Overrides

setUpdateTime(Timestamp value)

public PhraseSet.Builder setUpdateTime(Timestamp value)

Output only. The most recent time this resource was modified.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
PhraseSet.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public PhraseSet.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The most recent time this resource was modified.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PhraseSet.Builder