Package com.google.cloud.speech.v2

Class RecognizeRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.speech.v2.RecognizeRequest
All Implemented Interfaces:
RecognizeRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RecognizeRequest extends com.google.protobuf.GeneratedMessage implements RecognizeRequestOrBuilder
 Request message for the
 [Recognize][google.cloud.speech.v2.Speech.Recognize] method. Either
 `content` or `uri` must be supplied. Supplying both or neither returns
 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. See [content
 limits](https://cloud.google.com/speech-to-text/quotas#content).
Protobuf type google.cloud.speech.v2.RecognizeRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    RecognizeRequest.AudioSourceCase
     
    static final class 
    RecognizeRequest.Builder
    Request message for the [Recognize][google.cloud.speech.v2.Speech.Recognize] method.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONFIG_FIELD_NUMBER
     
    static final int
    CONFIG_MASK_FIELD_NUMBER
     
    static final int
    CONTENT_FIELD_NUMBER
     
    static final int
    RECOGNIZER_FIELD_NUMBER
     
    static final int
    URI_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    RecognizeRequest.AudioSourceCase
    getAudioSourceCase()
     
    RecognitionConfig
    getConfig()
    Features and audio metadata to use for the Automatic Speech Recognition.
    com.google.protobuf.FieldMask
    getConfigMask()
    The list of fields in [config][google.cloud.speech.v2.RecognizeRequest.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request.
    com.google.protobuf.FieldMaskOrBuilder
    getConfigMaskOrBuilder()
    The list of fields in [config][google.cloud.speech.v2.RecognizeRequest.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request.
    RecognitionConfigOrBuilder
    getConfigOrBuilder()
    Features and audio metadata to use for the Automatic Speech Recognition.
    com.google.protobuf.ByteString
    getContent()
    The audio data bytes encoded as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig].
    static RecognizeRequest
    getDefaultInstance()
     
    RecognizeRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<RecognizeRequest>
    getParserForType()
     
    String
    getRecognizer()
    Required.
    com.google.protobuf.ByteString
    getRecognizerBytes()
    Required.
    int
    getSerializedSize()
     
    String
    getUri()
    URI that points to a file that contains audio data bytes as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig].
    com.google.protobuf.ByteString
    getUriBytes()
    URI that points to a file that contains audio data bytes as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig].
    boolean
    hasConfig()
    Features and audio metadata to use for the Automatic Speech Recognition.
    boolean
    hasConfigMask()
    The list of fields in [config][google.cloud.speech.v2.RecognizeRequest.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request.
    boolean
    hasContent()
    The audio data bytes encoded as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig].
    int
    hashCode()
     
    boolean
    hasUri()
    URI that points to a file that contains audio data bytes as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig].
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RecognizeRequest.Builder
    newBuilder()
     
    static RecognizeRequest.Builder
    newBuilder(RecognizeRequest prototype)
     
    RecognizeRequest.Builder
    newBuilderForType()
     
    protected RecognizeRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static RecognizeRequest
    parseDelimitedFrom(InputStream input)
     
    static RecognizeRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RecognizeRequest
    parseFrom(byte[] data)
     
    static RecognizeRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RecognizeRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static RecognizeRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RecognizeRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RecognizeRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RecognizeRequest
    parseFrom(InputStream input)
     
    static RecognizeRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RecognizeRequest
    parseFrom(ByteBuffer data)
     
    static RecognizeRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RecognizeRequest>
    parser()
     
    RecognizeRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getAudioSourceCase

      public RecognizeRequest.AudioSourceCase getAudioSourceCase()
      Specified by:
      getAudioSourceCase in interface RecognizeRequestOrBuilder

    • getRecognizer

      public String getRecognizer()
       Required. The name of the Recognizer to use during recognition. The
 expected format is
 `projects/{project}/locations/{location}/recognizers/{recognizer}`. The
 {recognizer} segment may be set to `_` to use an empty implicit Recognizer.
      string recognizer = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getRecognizer in interface RecognizeRequestOrBuilder
      Returns:
      The recognizer.

    • getRecognizerBytes

      public com.google.protobuf.ByteString getRecognizerBytes()
       Required. The name of the Recognizer to use during recognition. The
 expected format is
 `projects/{project}/locations/{location}/recognizers/{recognizer}`. The
 {recognizer} segment may be set to `_` to use an empty implicit Recognizer.
      string recognizer = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getRecognizerBytes in interface RecognizeRequestOrBuilder
      Returns:
      The bytes for recognizer.

    • hasConfig

      public boolean hasConfig()
       Features and audio metadata to use for the Automatic Speech Recognition.
 This field in combination with the
 [config_mask][google.cloud.speech.v2.RecognizeRequest.config_mask] field
 can be used to override parts of the
 [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config]
 of the Recognizer resource.
      .google.cloud.speech.v2.RecognitionConfig config = 1;
      Specified by:
      hasConfig in interface RecognizeRequestOrBuilder
      Returns:
      Whether the config field is set.

    • getConfig

      public RecognitionConfig getConfig()
       Features and audio metadata to use for the Automatic Speech Recognition.
 This field in combination with the
 [config_mask][google.cloud.speech.v2.RecognizeRequest.config_mask] field
 can be used to override parts of the
 [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config]
 of the Recognizer resource.
      .google.cloud.speech.v2.RecognitionConfig config = 1;
      Specified by:
      getConfig in interface RecognizeRequestOrBuilder
      Returns:
      The config.

    • getConfigOrBuilder

      public RecognitionConfigOrBuilder getConfigOrBuilder()
       Features and audio metadata to use for the Automatic Speech Recognition.
 This field in combination with the
 [config_mask][google.cloud.speech.v2.RecognizeRequest.config_mask] field
 can be used to override parts of the
 [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config]
 of the Recognizer resource.
      .google.cloud.speech.v2.RecognitionConfig config = 1;
      Specified by:
      getConfigOrBuilder in interface RecognizeRequestOrBuilder

    • hasConfigMask

      public boolean hasConfigMask()
       The list of fields in
 [config][google.cloud.speech.v2.RecognizeRequest.config] that override the
 values in the
 [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config]
 of the recognizer during this recognition request. If no mask is provided,
 all non-default valued fields in
 [config][google.cloud.speech.v2.RecognizeRequest.config] override the
 values in the recognizer for this recognition request. If a mask is
 provided, only the fields listed in the mask override the config in the
 recognizer for this recognition request. If a wildcard (`*`) is provided,
 [config][google.cloud.speech.v2.RecognizeRequest.config] completely
 overrides and replaces the config in the recognizer for this recognition
 request.
      .google.protobuf.FieldMask config_mask = 8;
      Specified by:
      hasConfigMask in interface RecognizeRequestOrBuilder
      Returns:
      Whether the configMask field is set.

    • getConfigMask

      public com.google.protobuf.FieldMask getConfigMask()
       The list of fields in
 [config][google.cloud.speech.v2.RecognizeRequest.config] that override the
 values in the
 [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config]
 of the recognizer during this recognition request. If no mask is provided,
 all non-default valued fields in
 [config][google.cloud.speech.v2.RecognizeRequest.config] override the
 values in the recognizer for this recognition request. If a mask is
 provided, only the fields listed in the mask override the config in the
 recognizer for this recognition request. If a wildcard (`*`) is provided,
 [config][google.cloud.speech.v2.RecognizeRequest.config] completely
 overrides and replaces the config in the recognizer for this recognition
 request.
      .google.protobuf.FieldMask config_mask = 8;
      Specified by:
      getConfigMask in interface RecognizeRequestOrBuilder
      Returns:
      The configMask.

    • getConfigMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getConfigMaskOrBuilder()
       The list of fields in
 [config][google.cloud.speech.v2.RecognizeRequest.config] that override the
 values in the
 [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config]
 of the recognizer during this recognition request. If no mask is provided,
 all non-default valued fields in
 [config][google.cloud.speech.v2.RecognizeRequest.config] override the
 values in the recognizer for this recognition request. If a mask is
 provided, only the fields listed in the mask override the config in the
 recognizer for this recognition request. If a wildcard (`*`) is provided,
 [config][google.cloud.speech.v2.RecognizeRequest.config] completely
 overrides and replaces the config in the recognizer for this recognition
 request.
      .google.protobuf.FieldMask config_mask = 8;
      Specified by:
      getConfigMaskOrBuilder in interface RecognizeRequestOrBuilder

    • hasContent

      public boolean hasContent()
       The audio data bytes encoded as specified in
 [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. As
 with all bytes fields, proto buffers use a pure binary representation,
 whereas JSON representations use base64.
      bytes content = 5;
      Specified by:
      hasContent in interface RecognizeRequestOrBuilder
      Returns:
      Whether the content field is set.

    • getContent

      public com.google.protobuf.ByteString getContent()
       The audio data bytes encoded as specified in
 [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. As
 with all bytes fields, proto buffers use a pure binary representation,
 whereas JSON representations use base64.
      bytes content = 5;
      Specified by:
      getContent in interface RecognizeRequestOrBuilder
      Returns:
      The content.

    • hasUri

      public boolean hasUri()
       URI that points to a file that contains audio data bytes as specified in
 [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. The file
 must not be compressed (for example, gzip). Currently, only Google Cloud
 Storage URIs are supported, which must be specified in the following
 format: `gs://bucket_name/object_name` (other URI formats return
 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more
 information, see [Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).
      string uri = 6;
      Specified by:
      hasUri in interface RecognizeRequestOrBuilder
      Returns:
      Whether the uri field is set.

    • getUri

      public String getUri()
       URI that points to a file that contains audio data bytes as specified in
 [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. The file
 must not be compressed (for example, gzip). Currently, only Google Cloud
 Storage URIs are supported, which must be specified in the following
 format: `gs://bucket_name/object_name` (other URI formats return
 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more
 information, see [Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).
      string uri = 6;
      Specified by:
      getUri in interface RecognizeRequestOrBuilder
      Returns:
      The uri.

    • getUriBytes

      public com.google.protobuf.ByteString getUriBytes()
       URI that points to a file that contains audio data bytes as specified in
 [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. The file
 must not be compressed (for example, gzip). Currently, only Google Cloud
 Storage URIs are supported, which must be specified in the following
 format: `gs://bucket_name/object_name` (other URI formats return
 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more
 information, see [Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).
      string uri = 6;
      Specified by:
      getUriBytes in interface RecognizeRequestOrBuilder
      Returns:
      The bytes for uri.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RecognizeRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RecognizeRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RecognizeRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RecognizeRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RecognizeRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RecognizeRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RecognizeRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RecognizeRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RecognizeRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RecognizeRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RecognizeRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RecognizeRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RecognizeRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RecognizeRequest.Builder newBuilder()

    • newBuilder

      public static RecognizeRequest.Builder newBuilder(RecognizeRequest prototype)

    • toBuilder

      public RecognizeRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RecognizeRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RecognizeRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RecognizeRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<RecognizeRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public RecognizeRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder