com.google.cloud.speech.v1p1beta1

Interface PhraseSetOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PhraseSet, PhraseSet.Builder

@Generated
public interface PhraseSetOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsAnnotations(String key) Output only.
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.
com.google.protobuf.Timestamp	getDeleteTime() Output only.
com.google.protobuf.TimestampOrBuilder	getDeleteTimeOrBuilder() Output only.
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.
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.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 The resource name of the phrase set.
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The resource name of the phrase set.
 

string name = 1;

Returns:

The bytes for name.

getPhrasesList

List<PhraseSet.Phrase> getPhrasesList()

 A list of word and phrases.
 

repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;

getPhrases

PhraseSet.Phrase getPhrases(int index)

 A list of word and phrases.
 

repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;

getPhrasesCount

int getPhrasesCount()

 A list of word and phrases.
 

repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;

getPhrasesOrBuilderList

List<? extends PhraseSet.PhraseOrBuilder> getPhrasesOrBuilderList()

 A list of word and phrases.
 

repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;

getPhrasesOrBuilder

PhraseSet.PhraseOrBuilder getPhrasesOrBuilder(int index)

 A list of word and phrases.
 

repeated .google.cloud.speech.v1p1beta1.PhraseSet.Phrase phrases = 2;

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.
 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:

The boost.

getKmsKeyName

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) = { ... }

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 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) = { ... }

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 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) = { ... }

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 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) = { ... }

Returns:

The bytes for kmsKeyVersionName.

getUid

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

Returns:

The uid.

getUidBytes

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

Returns:

The bytes for uid.

getDisplayName

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

Returns:

The displayName.

getDisplayNameBytes

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

Returns:

The bytes for displayName.

getStateValue

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

Returns:

The enum numeric value on the wire for state.

getState

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

Returns:

The state.

hasDeleteTime

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

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.
 This field is not used.
 

.google.protobuf.Timestamp delete_time = 12 [(.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.
 This field is not used.
 

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

hasExpireTime

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

Returns:

Whether the expireTime field is set.

getExpireTime

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

Returns:

The expireTime.

getExpireTimeOrBuilder

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

getAnnotationsCount

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 [(.google.api.field_behavior) = OUTPUT_ONLY];

containsAnnotations

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

getAnnotations

@Deprecated
Map<String,String> getAnnotations()

Deprecated.

Use getAnnotationsMap() instead.

getAnnotationsMap

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

getAnnotationsOrDefault

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

getAnnotationsOrThrow

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

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. This field is
 not used.
 

string etag = 15 [(.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. This field is
 not used.
 

string etag = 15 [(.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. This field is not used.
 

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

Returns:

The reconciling.