google-api-client 0.10.3 → 0.11.0

data/generated/google/apis/speech_v1beta1/classes.rb

@@ -22,6 +22,171 @@ module Google
   module Apis
     module SpeechV1beta1
       
+      # This resource represents a long-running operation that is the result of a
+      # network API call.
+      class Operation
+        include Google::Apis::Core::Hashable
+      
+        # The normal response of the operation in case of success.  If the original
+        # method returns no data on success, such as `Delete`, the response is
+        # `google.protobuf.Empty`.  If the original method is standard
+        # `Get`/`Create`/`Update`, the response should be the resource.  For other
+        # methods, the response should have the type `XxxResponse`, where `Xxx`
+        # is the original method name.  For example, if the original method name
+        # is `TakeSnapshot()`, the inferred response type is
+        # `TakeSnapshotResponse`.
+        # Corresponds to the JSON property `response`
+        # @return [Hash<String,Object>]
+        attr_accessor :response
+      
+        # The server-assigned name, which is only unique within the same service that
+        # originally returns it. If you use the default HTTP mapping, the
+        # `name` should have the format of `operations/some/unique/name`.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # The `Status` type defines a logical error model that is suitable for different
+        # programming environments, including REST APIs and RPC APIs. It is used by
+        # [gRPC](https://github.com/grpc). The error model is designed to be:
+        # - Simple to use and understand for most users
+        # - Flexible enough to meet unexpected needs
+        # # Overview
+        # The `Status` message contains three pieces of data: error code, error message,
+        # and error details. The error code should be an enum value of
+        # google.rpc.Code, but it may accept additional error codes if needed.  The
+        # error message should be a developer-facing English message that helps
+        # developers *understand* and *resolve* the error. If a localized user-facing
+        # error message is needed, put the localized message in the error details or
+        # localize it in the client. The optional error details may contain arbitrary
+        # information about the error. There is a predefined set of error detail types
+        # in the package `google.rpc` which can be used for common error conditions.
+        # # Language mapping
+        # The `Status` message is the logical representation of the error model, but it
+        # is not necessarily the actual wire format. When the `Status` message is
+        # exposed in different client libraries and different wire protocols, it can be
+        # mapped differently. For example, it will likely be mapped to some exceptions
+        # in Java, but more likely mapped to some error codes in C.
+        # # Other uses
+        # The error model and the `Status` message can be used in a variety of
+        # environments, either with or without APIs, to provide a
+        # consistent developer experience across different environments.
+        # Example uses of this error model include:
+        # - Partial errors. If a service needs to return partial errors to the client,
+        # it may embed the `Status` in the normal response to indicate the partial
+        # errors.
+        # - Workflow errors. A typical workflow has multiple steps. Each step may
+        # have a `Status` message for error reporting purpose.
+        # - Batch operations. If a client uses batch request and batch response, the
+        # `Status` message should be used directly inside batch response, one for
+        # each error sub-response.
+        # - Asynchronous operations. If an API call embeds asynchronous operation
+        # results in its response, the status of those operations should be
+        # represented directly using the `Status` message.
+        # - Logging. If some API errors are stored in logs, the message `Status` could
+        # be used directly after any stripping needed for security/privacy reasons.
+        # Corresponds to the JSON property `error`
+        # @return [Google::Apis::SpeechV1beta1::Status]
+        attr_accessor :error
+      
+        # Service-specific metadata associated with the operation.  It typically
+        # contains progress information and common metadata such as create time.
+        # Some services might not provide such metadata.  Any method that returns a
+        # long-running operation should document the metadata type, if any.
+        # Corresponds to the JSON property `metadata`
+        # @return [Hash<String,Object>]
+        attr_accessor :metadata
+      
+        # If the value is `false`, it means the operation is still in progress.
+        # If true, the operation is completed, and either `error` or `response` is
+        # available.
+        # Corresponds to the JSON property `done`
+        # @return [Boolean]
+        attr_accessor :done
+        alias_method :done?, :done
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @response = args[:response] if args.key?(:response)
+          @name = args[:name] if args.key?(:name)
+          @error = args[:error] if args.key?(:error)
+          @metadata = args[:metadata] if args.key?(:metadata)
+          @done = args[:done] if args.key?(:done)
+        end
+      end
+      
+      # Provides information to the recognizer that specifies how to process the
+      # request.
+      class RecognitionConfig
+        include Google::Apis::Core::Hashable
+      
+        # *Optional* Maximum number of recognition hypotheses to be returned.
+        # Specifically, the maximum number of `SpeechRecognitionAlternative` messages
+        # within each `SpeechRecognitionResult`.
+        # The server may return fewer than `max_alternatives`.
+        # Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of
+        # one. If omitted, will return a maximum of one.
+        # Corresponds to the JSON property `maxAlternatives`
+        # @return [Fixnum]
+        attr_accessor :max_alternatives
+      
+        # *Required* Sample rate in Hertz of the audio data sent in all
+        # `RecognitionAudio` messages. Valid values are: 8000-48000.
+        # 16000 is optimal. For best results, set the sampling rate of the audio
+        # source to 16000 Hz. If that's not possible, use the native sample rate of
+        # the audio source (instead of re-sampling).
+        # Corresponds to the JSON property `sampleRate`
+        # @return [Fixnum]
+        attr_accessor :sample_rate
+      
+        # *Optional* The language of the supplied audio as a BCP-47 language tag.
+        # Example: "en-GB"  https://www.rfc-editor.org/rfc/bcp/bcp47.txt
+        # If omitted, defaults to "en-US". See
+        # [Language Support](https://cloud.google.com/speech/docs/languages)
+        # for a list of the currently supported language codes.
+        # Corresponds to the JSON property `languageCode`
+        # @return [String]
+        attr_accessor :language_code
+      
+        # Provides "hints" to the speech recognizer to favor specific words and phrases
+        # in the results.
+        # Corresponds to the JSON property `speechContext`
+        # @return [Google::Apis::SpeechV1beta1::SpeechContext]
+        attr_accessor :speech_context
+      
+        # *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
+        # Corresponds to the JSON property `encoding`
+        # @return [String]
+        attr_accessor :encoding
+      
+        # *Optional* If set to `true`, the server will attempt to filter out
+        # profanities, replacing all but the initial character in each filtered word
+        # with asterisks, e.g. "f***". If set to `false` or omitted, profanities
+        # won't be filtered out.
+        # Corresponds to the JSON property `profanityFilter`
+        # @return [Boolean]
+        attr_accessor :profanity_filter
+        alias_method :profanity_filter?, :profanity_filter
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @max_alternatives = args[:max_alternatives] if args.key?(:max_alternatives)
+          @sample_rate = args[:sample_rate] if args.key?(:sample_rate)
+          @language_code = args[:language_code] if args.key?(:language_code)
+          @speech_context = args[:speech_context] if args.key?(:speech_context)
+          @encoding = args[:encoding] if args.key?(:encoding)
+          @profanity_filter = args[:profanity_filter] if args.key?(:profanity_filter)
+        end
+      end
+      
       # The top-level message sent by the client for the `SyncRecognize` method.
       class SyncRecognizeRequest
         include Google::Apis::Core::Hashable
@@ -115,6 +280,13 @@ module Google
       class Status
         include Google::Apis::Core::Hashable
       
+        # A developer-facing error message, which should be in English. Any
+        # user-facing error message should be localized and sent in the
+        # google.rpc.Status.details field, or localized by the client.
+        # Corresponds to the JSON property `message`
+        # @return [String]
+        attr_accessor :message
+      
         # A list of messages that carry the error details.  There will be a
         # common set of message types for APIs to use.
         # Corresponds to the JSON property `details`
@@ -126,22 +298,15 @@ module Google
         # @return [Fixnum]
         attr_accessor :code
       
-        # A developer-facing error message, which should be in English. Any
-        # user-facing error message should be localized and sent in the
-        # google.rpc.Status.details field, or localized by the client.
-        # Corresponds to the JSON property `message`
-        # @return [String]
-        attr_accessor :message
-      
         def initialize(**args)
            update!(**args)
         end
       
         # Update properties of this object
         def update!(**args)
+          @message = args[:message] if args.key?(:message)
           @details = args[:details] if args.key?(:details)
           @code = args[:code] if args.key?(:code)
-          @message = args[:message] if args.key?(:message)
         end
       end
       
@@ -265,35 +430,6 @@ module Google
         end
       end
       
-      # The top-level message sent by the client for the `AsyncRecognize` method.
-      class AsyncRecognizeRequest
-        include Google::Apis::Core::Hashable
-      
-        # Provides information to the recognizer that specifies how to process the
-        # request.
-        # Corresponds to the JSON property `config`
-        # @return [Google::Apis::SpeechV1beta1::RecognitionConfig]
-        attr_accessor :config
-      
-        # Contains audio data in the encoding specified in the `RecognitionConfig`.
-        # Either `content` or `uri` must be supplied. Supplying both or neither
-        # returns google.rpc.Code.INVALID_ARGUMENT. See
-        # [audio limits](https://cloud.google.com/speech/limits#content).
-        # Corresponds to the JSON property `audio`
-        # @return [Google::Apis::SpeechV1beta1::RecognitionAudio]
-        attr_accessor :audio
-      
-        def initialize(**args)
-           update!(**args)
-        end
-      
-        # Update properties of this object
-        def update!(**args)
-          @config = args[:config] if args.key?(:config)
-          @audio = args[:audio] if args.key?(:audio)
-        end
-      end
-      
       # Contains audio data in the encoding specified in the `RecognitionConfig`.
       # Either `content` or `uri` must be supplied. Supplying both or neither
       # returns google.rpc.Code.INVALID_ARGUMENT. See
@@ -301,14 +437,6 @@ module Google
       class RecognitionAudio
         include Google::Apis::Core::Hashable
       
-        # The audio data bytes encoded as specified in
-        # `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a
-        # pure binary representation, whereas JSON representations use base64.
-        # Corresponds to the JSON property `content`
-        # NOTE: Values are automatically base64 encoded/decoded in the client library.
-        # @return [String]
-        attr_accessor :content
-      
         # URI that points to a file that contains audio data bytes as specified in
         # `RecognitionConfig`. Currently, only Google Cloud Storage URIs are
         # supported, which must be specified in the following format:
@@ -319,99 +447,13 @@ module Google
         # @return [String]
         attr_accessor :uri
       
-        def initialize(**args)
-           update!(**args)
-        end
-      
-        # Update properties of this object
-        def update!(**args)
-          @content = args[:content] if args.key?(:content)
-          @uri = args[:uri] if args.key?(:uri)
-        end
-      end
-      
-      # This resource represents a long-running operation that is the result of a
-      # network API call.
-      class Operation
-        include Google::Apis::Core::Hashable
-      
-        # Service-specific metadata associated with the operation.  It typically
-        # contains progress information and common metadata such as create time.
-        # Some services might not provide such metadata.  Any method that returns a
-        # long-running operation should document the metadata type, if any.
-        # Corresponds to the JSON property `metadata`
-        # @return [Hash<String,Object>]
-        attr_accessor :metadata
-      
-        # If the value is `false`, it means the operation is still in progress.
-        # If true, the operation is completed, and either `error` or `response` is
-        # available.
-        # Corresponds to the JSON property `done`
-        # @return [Boolean]
-        attr_accessor :done
-        alias_method :done?, :done
-      
-        # The normal response of the operation in case of success.  If the original
-        # method returns no data on success, such as `Delete`, the response is
-        # `google.protobuf.Empty`.  If the original method is standard
-        # `Get`/`Create`/`Update`, the response should be the resource.  For other
-        # methods, the response should have the type `XxxResponse`, where `Xxx`
-        # is the original method name.  For example, if the original method name
-        # is `TakeSnapshot()`, the inferred response type is
-        # `TakeSnapshotResponse`.
-        # Corresponds to the JSON property `response`
-        # @return [Hash<String,Object>]
-        attr_accessor :response
-      
-        # The server-assigned name, which is only unique within the same service that
-        # originally returns it. If you use the default HTTP mapping, the
-        # `name` should have the format of `operations/some/unique/name`.
-        # Corresponds to the JSON property `name`
+        # The audio data bytes encoded as specified in
+        # `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a
+        # pure binary representation, whereas JSON representations use base64.
+        # Corresponds to the JSON property `content`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
-        attr_accessor :name
-      
-        # The `Status` type defines a logical error model that is suitable for different
-        # programming environments, including REST APIs and RPC APIs. It is used by
-        # [gRPC](https://github.com/grpc). The error model is designed to be:
-        # - Simple to use and understand for most users
-        # - Flexible enough to meet unexpected needs
-        # # Overview
-        # The `Status` message contains three pieces of data: error code, error message,
-        # and error details. The error code should be an enum value of
-        # google.rpc.Code, but it may accept additional error codes if needed.  The
-        # error message should be a developer-facing English message that helps
-        # developers *understand* and *resolve* the error. If a localized user-facing
-        # error message is needed, put the localized message in the error details or
-        # localize it in the client. The optional error details may contain arbitrary
-        # information about the error. There is a predefined set of error detail types
-        # in the package `google.rpc` which can be used for common error conditions.
-        # # Language mapping
-        # The `Status` message is the logical representation of the error model, but it
-        # is not necessarily the actual wire format. When the `Status` message is
-        # exposed in different client libraries and different wire protocols, it can be
-        # mapped differently. For example, it will likely be mapped to some exceptions
-        # in Java, but more likely mapped to some error codes in C.
-        # # Other uses
-        # The error model and the `Status` message can be used in a variety of
-        # environments, either with or without APIs, to provide a
-        # consistent developer experience across different environments.
-        # Example uses of this error model include:
-        # - Partial errors. If a service needs to return partial errors to the client,
-        # it may embed the `Status` in the normal response to indicate the partial
-        # errors.
-        # - Workflow errors. A typical workflow has multiple steps. Each step may
-        # have a `Status` message for error reporting purpose.
-        # - Batch operations. If a client uses batch request and batch response, the
-        # `Status` message should be used directly inside batch response, one for
-        # each error sub-response.
-        # - Asynchronous operations. If an API call embeds asynchronous operation
-        # results in its response, the status of those operations should be
-        # represented directly using the `Status` message.
-        # - Logging. If some API errors are stored in logs, the message `Status` could
-        # be used directly after any stripping needed for security/privacy reasons.
-        # Corresponds to the JSON property `error`
-        # @return [Google::Apis::SpeechV1beta1::Status]
-        attr_accessor :error
+        attr_accessor :content
       
         def initialize(**args)
            update!(**args)
@@ -419,66 +461,28 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @metadata = args[:metadata] if args.key?(:metadata)
-          @done = args[:done] if args.key?(:done)
-          @response = args[:response] if args.key?(:response)
-          @name = args[:name] if args.key?(:name)
-          @error = args[:error] if args.key?(:error)
+          @uri = args[:uri] if args.key?(:uri)
+          @content = args[:content] if args.key?(:content)
         end
       end
       
-      # Provides information to the recognizer that specifies how to process the
-      # request.
-      class RecognitionConfig
+      # The top-level message sent by the client for the `AsyncRecognize` method.
+      class AsyncRecognizeRequest
         include Google::Apis::Core::Hashable
       
-        # *Optional* Maximum number of recognition hypotheses to be returned.
-        # Specifically, the maximum number of `SpeechRecognitionAlternative` messages
-        # within each `SpeechRecognitionResult`.
-        # The server may return fewer than `max_alternatives`.
-        # Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of
-        # one. If omitted, will return a maximum of one.
-        # Corresponds to the JSON property `maxAlternatives`
-        # @return [Fixnum]
-        attr_accessor :max_alternatives
-      
-        # *Optional* The language of the supplied audio as a BCP-47 language tag.
-        # Example: "en-GB"  https://www.rfc-editor.org/rfc/bcp/bcp47.txt
-        # If omitted, defaults to "en-US". See
-        # [Language Support](https://cloud.google.com/speech/docs/languages)
-        # for a list of the currently supported language codes.
-        # Corresponds to the JSON property `languageCode`
-        # @return [String]
-        attr_accessor :language_code
-      
-        # *Required* Sample rate in Hertz of the audio data sent in all
-        # `RecognitionAudio` messages. Valid values are: 8000-48000.
-        # 16000 is optimal. For best results, set the sampling rate of the audio
-        # source to 16000 Hz. If that's not possible, use the native sample rate of
-        # the audio source (instead of re-sampling).
-        # Corresponds to the JSON property `sampleRate`
-        # @return [Fixnum]
-        attr_accessor :sample_rate
-      
-        # *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
-        # Corresponds to the JSON property `encoding`
-        # @return [String]
-        attr_accessor :encoding
-      
-        # *Optional* If set to `true`, the server will attempt to filter out
-        # profanities, replacing all but the initial character in each filtered word
-        # with asterisks, e.g. "f***". If set to `false` or omitted, profanities
-        # won't be filtered out.
-        # Corresponds to the JSON property `profanityFilter`
-        # @return [Boolean]
-        attr_accessor :profanity_filter
-        alias_method :profanity_filter?, :profanity_filter
+        # Provides information to the recognizer that specifies how to process the
+        # request.
+        # Corresponds to the JSON property `config`
+        # @return [Google::Apis::SpeechV1beta1::RecognitionConfig]
+        attr_accessor :config
       
-        # Provides "hints" to the speech recognizer to favor specific words and phrases
-        # in the results.
-        # Corresponds to the JSON property `speechContext`
-        # @return [Google::Apis::SpeechV1beta1::SpeechContext]
-        attr_accessor :speech_context
+        # Contains audio data in the encoding specified in the `RecognitionConfig`.
+        # Either `content` or `uri` must be supplied. Supplying both or neither
+        # returns google.rpc.Code.INVALID_ARGUMENT. See
+        # [audio limits](https://cloud.google.com/speech/limits#content).
+        # Corresponds to the JSON property `audio`
+        # @return [Google::Apis::SpeechV1beta1::RecognitionAudio]
+        attr_accessor :audio
       
         def initialize(**args)
            update!(**args)
@@ -486,12 +490,8 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @max_alternatives = args[:max_alternatives] if args.key?(:max_alternatives)
-          @language_code = args[:language_code] if args.key?(:language_code)
-          @sample_rate = args[:sample_rate] if args.key?(:sample_rate)
-          @encoding = args[:encoding] if args.key?(:encoding)
-          @profanity_filter = args[:profanity_filter] if args.key?(:profanity_filter)
-          @speech_context = args[:speech_context] if args.key?(:speech_context)
+          @config = args[:config] if args.key?(:config)
+          @audio = args[:audio] if args.key?(:audio)
         end
       end
     end