Package com.google.cloud.speech.v2

Interface RecognizerOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Recognizer, Recognizer.Builder
@Generated public interface RecognizerOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

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

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getUid

      String getUid()
       Output only. System-assigned unique identifier for the Recognizer.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The uid.

    • getUidBytes

      com.google.protobuf.ByteString getUidBytes()
       Output only. System-assigned unique identifier for the Recognizer.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for uid.

    • getDisplayName

      String getDisplayName()
       User-settable, human-readable name for the Recognizer. Must be 63
 characters or less.
      string display_name = 3;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       User-settable, human-readable name for the Recognizer. Must be 63
 characters or less.
      string display_name = 3;
      Returns:
      The bytes for displayName.

    • getModel

      @Deprecated String getModel()
      Deprecated.
      google.cloud.speech.v2.Recognizer.model is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=604
       Optional. This field is now deprecated. Prefer the
 [`model`][google.cloud.speech.v2.RecognitionConfig.model] field in the
 [`RecognitionConfig`][google.cloud.speech.v2.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](https://cloud.google.com/speech-to-text/v2/docs/transcription-model)
 and the models supported in each region can be found in the [Table Of
 Supported
 Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).
      string model = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The model.

    • getModelBytes

      @Deprecated com.google.protobuf.ByteString getModelBytes()
      Deprecated.
      google.cloud.speech.v2.Recognizer.model is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=604
       Optional. This field is now deprecated. Prefer the
 [`model`][google.cloud.speech.v2.RecognitionConfig.model] field in the
 [`RecognitionConfig`][google.cloud.speech.v2.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](https://cloud.google.com/speech-to-text/v2/docs/transcription-model)
 and the models supported in each region can be found in the [Table Of
 Supported
 Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).
      string model = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for model.

    • getLanguageCodesList

      @Deprecated List<String> getLanguageCodesList()
      Deprecated.
      google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=623
       Optional. This field is now deprecated. Prefer the
 [`language_codes`][google.cloud.speech.v2.RecognitionConfig.language_codes]
 field in the
 [`RecognitionConfig`][google.cloud.speech.v2.RecognitionConfig] message.

 The language of the supplied audio as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.

 Supported languages for each model are listed in the [Table of Supported
 Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).

 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:
      A list containing the languageCodes.

    • getLanguageCodesCount

      @Deprecated int getLanguageCodesCount()
      Deprecated.
      google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=623
       Optional. This field is now deprecated. Prefer the
 [`language_codes`][google.cloud.speech.v2.RecognitionConfig.language_codes]
 field in the
 [`RecognitionConfig`][google.cloud.speech.v2.RecognitionConfig] message.

 The language of the supplied audio as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.

 Supported languages for each model are listed in the [Table of Supported
 Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).

 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:
      The count of languageCodes.

    • getLanguageCodes

      @Deprecated String getLanguageCodes(int index)
      Deprecated.
      google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=623
       Optional. This field is now deprecated. Prefer the
 [`language_codes`][google.cloud.speech.v2.RecognitionConfig.language_codes]
 field in the
 [`RecognitionConfig`][google.cloud.speech.v2.RecognitionConfig] message.

 The language of the supplied audio as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.

 Supported languages for each model are listed in the [Table of Supported
 Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).

 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:
      index - The index of the element to return.
      Returns:
      The languageCodes at the given index.

    • getLanguageCodesBytes

      @Deprecated com.google.protobuf.ByteString getLanguageCodesBytes(int index)
      Deprecated.
      google.cloud.speech.v2.Recognizer.language_codes is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=623
       Optional. This field is now deprecated. Prefer the
 [`language_codes`][google.cloud.speech.v2.RecognitionConfig.language_codes]
 field in the
 [`RecognitionConfig`][google.cloud.speech.v2.RecognitionConfig] message.

 The language of the supplied audio as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.

 Supported languages for each model are listed in the [Table of Supported
 Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).

 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:
      index - The index of the value to return.
      Returns:
      The bytes of the languageCodes at the given index.

    • hasDefaultRecognitionConfig

      boolean hasDefaultRecognitionConfig()
       Default configuration to use for requests with this Recognizer.
 This can be overwritten by inline configuration in the
 [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config]
 field.
      .google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;
      Returns:
      Whether the defaultRecognitionConfig field is set.

    • getDefaultRecognitionConfig

      RecognitionConfig getDefaultRecognitionConfig()
       Default configuration to use for requests with this Recognizer.
 This can be overwritten by inline configuration in the
 [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config]
 field.
      .google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;
      Returns:
      The defaultRecognitionConfig.

    • getDefaultRecognitionConfigOrBuilder

      RecognitionConfigOrBuilder getDefaultRecognitionConfigOrBuilder()
       Default configuration to use for requests with this Recognizer.
 This can be overwritten by inline configuration in the
 [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config]
 field.
      .google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

    • getAnnotationsCount

      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;

    • containsAnnotations

      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;

    • getAnnotations

      @Deprecated Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.

    • getAnnotationsMap

      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;

    • getAnnotationsOrDefault

      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;

    • getAnnotationsOrThrow

      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;

    • getStateValue

      int getStateValue()
       Output only. The Recognizer lifecycle state.
      .google.cloud.speech.v2.Recognizer.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Recognizer.State getState()
       Output only. The Recognizer lifecycle state.
      .google.cloud.speech.v2.Recognizer.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Creation time.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Creation time.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Creation time.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.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:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The most recent time this Recognizer was modified.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasDeleteTime

      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:
      Whether the deleteTime field is set.

    • getDeleteTime

      com.google.protobuf.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:
      The deleteTime.

    • getDeleteTimeOrBuilder

      com.google.protobuf.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];

    • hasExpireTime

      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:
      Whether the expireTime field is set.

    • getExpireTime

      com.google.protobuf.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:
      The expireTime.

    • getExpireTimeOrBuilder

      com.google.protobuf.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];

    • 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.
      string etag = 12 [(.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.
      string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for etag.

    • getReconciling

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

    • getKmsKeyName

      String getKmsKeyName()
       Output only. The [KMS key
 name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) 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:
      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 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:
      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 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:
      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 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:
      The bytes for kmsKeyVersionName.