Class Recognizer.Builder (4.38.0) 

public static final class Recognizer.Builder extends GeneratedMessageV3.Builder<Recognizer.Builder> implements RecognizerOrBuilder

A Recognizer message. Stores recognition configuration and metadata.

Protobuf type google.cloud.speech.v2.Recognizer

Inheritance

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

Implements

RecognizerOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllLanguageCodes(Iterable<String> values) (deprecated)

public Recognizer.Builder addAllLanguageCodes(Iterable<String> values)

Deprecated. google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=622

Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The languageCodes to add.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

addLanguageCodes(String value) (deprecated)

public Recognizer.Builder addLanguageCodes(String value)

Deprecated. google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=622

Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The languageCodes to add.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

addLanguageCodesBytes(ByteString value) (deprecated)

public Recognizer.Builder addLanguageCodesBytes(ByteString value)

Deprecated. google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=622

Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the languageCodes to add.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Recognizer build()
Returns
Type Description
Recognizer

buildPartial()

public Recognizer buildPartial()
Returns
Type Description
Recognizer

clear()

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

clearAnnotations()

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

clearCreateTime()

public Recognizer.Builder clearCreateTime()

Output only. Creation time.

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

Returns
Type Description
Recognizer.Builder

clearDefaultRecognitionConfig()

public Recognizer.Builder clearDefaultRecognitionConfig()

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Returns
Type Description
Recognizer.Builder

clearDeleteTime()

public Recognizer.Builder clearDeleteTime()

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

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

Returns
Type Description
Recognizer.Builder

clearDisplayName()

public Recognizer.Builder clearDisplayName()

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

string display_name = 3;

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearEtag()

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

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearExpireTime()

public Recognizer.Builder clearExpireTime()

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

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

Returns
Type Description
Recognizer.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearKmsKeyName()

public Recognizer.Builder clearKmsKeyName()

Output only. The KMS key name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

string kms_key_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearKmsKeyVersionName()

public Recognizer.Builder clearKmsKeyVersionName()

Output only. The KMS key version name with which the Recognizer 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 = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearLanguageCodes() (deprecated)

public Recognizer.Builder clearLanguageCodes()

Deprecated. google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=622

Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearModel() (deprecated)

public Recognizer.Builder clearModel()

Deprecated. google.cloud.speech.v2.Recognizer.model is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=603

Optional. This field is now deprecated. Prefer the model field in the RecognitionConfig message.

Which model to use for recognition requests. Select the model best suited to your domain to get best results.

Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.

string model = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearName()

public Recognizer.Builder clearName()

Output only. Identifier. The resource name of the Recognizer. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearReconciling()

public Recognizer.Builder clearReconciling()

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

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

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearState()

public Recognizer.Builder clearState()

Output only. The Recognizer lifecycle state.

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

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearUid()

public Recognizer.Builder clearUid()

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

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

Returns
Type Description
Recognizer.Builder

This builder for chaining.

clearUpdateTime()

public Recognizer.Builder clearUpdateTime()

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

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

Returns
Type Description
Recognizer.Builder

clone()

public Recognizer.Builder clone()
Returns
Type Description
Recognizer.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 = 7;

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

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

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

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

Parameter
Name Description
key String
Returns
Type Description
String

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation time.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Recognizer getDefaultInstanceForType()
Returns
Type Description
Recognizer

getDefaultRecognitionConfig()

public RecognitionConfig getDefaultRecognitionConfig()

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Returns
Type Description
RecognitionConfig

The defaultRecognitionConfig.

getDefaultRecognitionConfigBuilder()

public RecognitionConfig.Builder getDefaultRecognitionConfigBuilder()

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Returns
Type Description
RecognitionConfig.Builder

getDefaultRecognitionConfigOrBuilder()

public RecognitionConfigOrBuilder getDefaultRecognitionConfigOrBuilder()

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Returns
Type Description
RecognitionConfigOrBuilder

getDeleteTime()

public Timestamp getDeleteTime()

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

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

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

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

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

Returns
Type Description
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

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

.google.protobuf.Timestamp delete_time = 11 [(.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 Recognizer. Must be 63 characters or less.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 3;

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 = 12 [(.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 = 12 [(.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 Recognizer will be purged.

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

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

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

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

Returns
Type Description
Builder

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getKmsKeyName()

public String getKmsKeyName()

Output only. The KMS key name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

string kms_key_name = 15 [(.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 Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

string kms_key_name = 15 [(.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 Recognizer 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 = 16 [(.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 Recognizer 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 = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKeyVersionName.

getLanguageCodes(int index) (deprecated)

public String getLanguageCodes(int index)

Deprecated. google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=622

Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The languageCodes at the given index.

getLanguageCodesBytes(int index) (deprecated)

public ByteString getLanguageCodesBytes(int index)

Deprecated. google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=622

Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the languageCodes at the given index.

getLanguageCodesCount() (deprecated)

public int getLanguageCodesCount()

Deprecated. google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=622

Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of languageCodes.

getLanguageCodesList() (deprecated)

public ProtocolStringList getLanguageCodesList()

Deprecated. google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=622

Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the languageCodes.

getModel() (deprecated)

public String getModel()

Deprecated. google.cloud.speech.v2.Recognizer.model is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=603

Optional. This field is now deprecated. Prefer the model field in the RecognitionConfig message.

Which model to use for recognition requests. Select the model best suited to your domain to get best results.

Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.

string model = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The model.

getModelBytes() (deprecated)

public ByteString getModelBytes()

Deprecated. google.cloud.speech.v2.Recognizer.model is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=603

Optional. This field is now deprecated. Prefer the model field in the RecognitionConfig message.

Which model to use for recognition requests. Select the model best suited to your domain to get best results.

Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.

string model = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for model.

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 Recognizer. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.

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 Recognizer. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getReconciling()

public boolean getReconciling()

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

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

Returns
Type Description
boolean

The reconciling.

getState()

public Recognizer.State getState()

Output only. The Recognizer lifecycle state.

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

Returns
Type Description
Recognizer.State

The state.

getStateValue()

public int getStateValue()

Output only. The Recognizer lifecycle state.

.google.cloud.speech.v2.Recognizer.State state = 8 [(.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 Recognizer.

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

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 Recognizer was modified.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation time.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDefaultRecognitionConfig()

public boolean hasDefaultRecognitionConfig()

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Returns
Type Description
boolean

Whether the defaultRecognitionConfig field is set.

hasDeleteTime()

public boolean hasDeleteTime()

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

.google.protobuf.Timestamp delete_time = 11 [(.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 Recognizer will be purged.

.google.protobuf.Timestamp expire_time = 14 [(.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 Recognizer was modified.

.google.protobuf.Timestamp update_time = 10 [(.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 Recognizer.Builder mergeCreateTime(Timestamp value)

Output only. Creation time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Recognizer.Builder

mergeDefaultRecognitionConfig(RecognitionConfig value)

public Recognizer.Builder mergeDefaultRecognitionConfig(RecognitionConfig value)

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Parameter
Name Description
value RecognitionConfig
Returns
Type Description
Recognizer.Builder

mergeDeleteTime(Timestamp value)

public Recognizer.Builder mergeDeleteTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Recognizer.Builder

mergeExpireTime(Timestamp value)

public Recognizer.Builder mergeExpireTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Recognizer.Builder

mergeFrom(Recognizer other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public Recognizer.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Recognizer.Builder

putAllAnnotations(Map<String,String> values)

public Recognizer.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 = 7;

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

putAnnotations(String key, String value)

public Recognizer.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 = 7;

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

removeAnnotations(String key)

public Recognizer.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 = 7;

Parameter
Name Description
key String
Returns
Type Description
Recognizer.Builder

setCreateTime(Timestamp value)

public Recognizer.Builder setCreateTime(Timestamp value)

Output only. Creation time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Recognizer.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Recognizer.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Creation time.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Recognizer.Builder

setDefaultRecognitionConfig(RecognitionConfig value)

public Recognizer.Builder setDefaultRecognitionConfig(RecognitionConfig value)

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Parameter
Name Description
value RecognitionConfig
Returns
Type Description
Recognizer.Builder

setDefaultRecognitionConfig(RecognitionConfig.Builder builderForValue)

public Recognizer.Builder setDefaultRecognitionConfig(RecognitionConfig.Builder builderForValue)

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Parameter
Name Description
builderForValue RecognitionConfig.Builder
Returns
Type Description
Recognizer.Builder

setDeleteTime(Timestamp value)

public Recognizer.Builder setDeleteTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Recognizer.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Recognizer.Builder setDeleteTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Recognizer.Builder

setDisplayName(String value)

public Recognizer.Builder setDisplayName(String value)

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

string display_name = 3;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Recognizer.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 3;

Parameter
Name Description
value ByteString

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

This builder for chaining.

setEtag(String value)

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

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

setEtagBytes(ByteString value)

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

setExpireTime(Timestamp value)

public Recognizer.Builder setExpireTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Recognizer.Builder

setExpireTime(Timestamp.Builder builderForValue)

public Recognizer.Builder setExpireTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Recognizer.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setKmsKeyName(String value)

public Recognizer.Builder setKmsKeyName(String value)

Output only. The KMS key name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

string kms_key_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The kmsKeyName to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public Recognizer.Builder setKmsKeyNameBytes(ByteString value)

Output only. The KMS key name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

string kms_key_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

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

This builder for chaining.

setKmsKeyVersionName(String value)

public Recognizer.Builder setKmsKeyVersionName(String value)

Output only. The KMS key version name with which the Recognizer 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 = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The kmsKeyVersionName to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

setKmsKeyVersionNameBytes(ByteString value)

public Recognizer.Builder setKmsKeyVersionNameBytes(ByteString value)

Output only. The KMS key version name with which the Recognizer 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 = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

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

This builder for chaining.

setLanguageCodes(int index, String value) (deprecated)

public Recognizer.Builder setLanguageCodes(int index, String value)

Deprecated. google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=622

Optional. This field is now deprecated. Prefer the language_codes field in the RecognitionConfig message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value String

The languageCodes to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

setModel(String value) (deprecated)

public Recognizer.Builder setModel(String value)

Deprecated. google.cloud.speech.v2.Recognizer.model is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=603

Optional. This field is now deprecated. Prefer the model field in the RecognitionConfig message.

Which model to use for recognition requests. Select the model best suited to your domain to get best results.

Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.

string model = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The model to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

setModelBytes(ByteString value) (deprecated)

public Recognizer.Builder setModelBytes(ByteString value)

Deprecated. google.cloud.speech.v2.Recognizer.model is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=603

Optional. This field is now deprecated. Prefer the model field in the RecognitionConfig message.

Which model to use for recognition requests. Select the model best suited to your domain to get best results.

Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.

string model = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for model to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

setName(String value)

public Recognizer.Builder setName(String value)

Output only. Identifier. The resource name of the Recognizer. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.

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
Recognizer.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Recognizer.Builder setNameBytes(ByteString value)

Output only. Identifier. The resource name of the Recognizer. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.

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
Recognizer.Builder

This builder for chaining.

setReconciling(boolean value)

public Recognizer.Builder setReconciling(boolean value)

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

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

Parameter
Name Description
value boolean

The reconciling to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

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

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

setState(Recognizer.State value)

public Recognizer.Builder setState(Recognizer.State value)

Output only. The Recognizer lifecycle state.

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

Parameter
Name Description
value Recognizer.State

The state to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

setStateValue(int value)

public Recognizer.Builder setStateValue(int value)

Output only. The Recognizer lifecycle state.

.google.cloud.speech.v2.Recognizer.State state = 8 [(.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
Recognizer.Builder

This builder for chaining.

setUid(String value)

public Recognizer.Builder setUid(String value)

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

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

Parameter
Name Description
value String

The uid to set.
Returns
Type Description
Recognizer.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Recognizer.Builder setUidBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public Recognizer.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Recognizer.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Recognizer.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Recognizer.Builder