Interface PhraseSetOrBuilder (0.15.0)

public interface PhraseSetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

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;

Returns
Type Description
int

getAnnotationsMap()

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

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

getBoost()

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

Returns
Type Description
float

The boost.

getDeleteTime()

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

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getDisplayName()

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

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

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

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

Returns
Type Description
String

The etag.

getEtagBytes()

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

Returns
Type Description
ByteString

The bytes for etag.

getExpireTime()

public abstract Timestamp getExpireTime()

Output only. The time at which this resource will be purged. This field is not used.

.google.protobuf.Timestamp expire_time = 13;

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public abstract TimestampOrBuilder getExpireTimeOrBuilder()

Output only. The time at which this resource will be purged. This field is not used.

.google.protobuf.Timestamp expire_time = 13;

Returns
Type Description
TimestampOrBuilder

getKmsKeyName()

public abstract String getKmsKeyName()

Output only. The KMS key name 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;

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public abstract ByteString getKmsKeyNameBytes()

Output only. The KMS key name 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;

Returns
Type Description
ByteString

The bytes for kmsKeyName.

getKmsKeyVersionName()

public abstract String getKmsKeyVersionName()

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

Returns
Type Description
String

The kmsKeyVersionName.

getKmsKeyVersionNameBytes()

public abstract ByteString getKmsKeyVersionNameBytes()

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

Returns
Type Description
ByteString

The bytes for kmsKeyVersionName.

getName()

public abstract String getName()

The resource name of the phrase set.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the phrase set.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPhrases(int index)

public abstract PhraseSet.Phrase getPhrases(int index)

A list of word and phrases.

repeated .google.events.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter
Name Description
index int
Returns
Type Description
PhraseSet.Phrase

getPhrasesCount()

public abstract int getPhrasesCount()

A list of word and phrases.

repeated .google.events.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Returns
Type Description
int

getPhrasesList()

public abstract List<PhraseSet.Phrase> getPhrasesList()

A list of word and phrases.

repeated .google.events.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Returns
Type Description
List<Phrase>

getPhrasesOrBuilder(int index)

public abstract PhraseSet.PhraseOrBuilder getPhrasesOrBuilder(int index)

A list of word and phrases.

repeated .google.events.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

Parameter
Name Description
index int
Returns
Type Description
PhraseSet.PhraseOrBuilder

getPhrasesOrBuilderList()

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

A list of word and phrases.

repeated .google.events.cloud.speech.v1.PhraseSet.Phrase phrases = 2;

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

getReconciling()

public abstract boolean getReconciling()

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

bool reconciling = 16;

Returns
Type Description
boolean

The reconciling.

getState()

public abstract PhraseSet.State getState()

Output only. The CustomClass lifecycle state. This field is not used.

.google.events.cloud.speech.v1.PhraseSet.State state = 11;

Returns
Type Description
PhraseSet.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The CustomClass lifecycle state. This field is not used.

.google.events.cloud.speech.v1.PhraseSet.State state = 11;

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public abstract String getUid()

Output only. System-assigned unique identifier for the PhraseSet. This field is not used.

string uid = 9;

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. System-assigned unique identifier for the PhraseSet. This field is not used.

string uid = 9;

Returns
Type Description
ByteString

The bytes for uid.

hasDeleteTime()

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

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasExpireTime()

public abstract boolean hasExpireTime()

Output only. The time at which this resource will be purged. This field is not used.

.google.protobuf.Timestamp expire_time = 13;

Returns
Type Description
boolean

Whether the expireTime field is set.