google-api-client 0.9.25 → 0.9.26

data/generated/google/apis/speech_v1beta1.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://cloud.google.com/speech/
     module SpeechV1beta1
       VERSION = 'V1beta1'
-      REVISION = '20170118'
+      REVISION = '20170125'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

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

@@ -22,110 +22,16 @@ module Google
   module Apis
     module SpeechV1beta1
       
-      # 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.
-      class Status
-        include Google::Apis::Core::Hashable
-      
-        # The status code, which should be an enum value of google.rpc.Code.
-        # Corresponds to the JSON property `code`
-        # @return [Fixnum]
-        attr_accessor :code
-      
-        # 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`
-        # @return [Array<Hash<String,Object>>]
-        attr_accessor :details
-      
-        # 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)
-          @code = args[:code] if args.key?(:code)
-          @details = args[:details] if args.key?(:details)
-          @message = args[:message] if args.key?(:message)
-        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
-      # [audio limits](https://cloud.google.com/speech/limits#content).
-      class RecognitionAudio
+      # The request message for Operations.CancelOperation.
+      class CancelOperationRequest
         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`
-        # @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:
-        # `gs://bucket_name/object_name` (other URI formats return
-        # google.rpc.Code.INVALID_ARGUMENT). For more information, see
-        # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
-        # Corresponds to the JSON property `uri`
-        # @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
       
@@ -177,14 +83,6 @@ module Google
         # @return [Google::Apis::SpeechV1beta1::Status]
         attr_accessor :error
       
-        # 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
-      
         # 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
@@ -193,6 +91,14 @@ module Google
         # @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
@@ -219,55 +125,13 @@ module Google
         # Update properties of this object
         def update!(**args)
           @error = args[:error] if args.key?(:error)
-          @done = args[:done] if args.key?(:done)
           @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)
         end
       end
       
-      # Alternative hypotheses (a.k.a. n-best list).
-      class SpeechRecognitionAlternative
-        include Google::Apis::Core::Hashable
-      
-        # [Output-only] Transcript text representing the words that the user spoke.
-        # Corresponds to the JSON property `transcript`
-        # @return [String]
-        attr_accessor :transcript
-      
-        # [Output-only] The confidence estimate between 0.0 and 1.0. A higher number
-        # means the system is more confident that the recognition is correct.
-        # This field is typically provided only for the top hypothesis, and only for
-        # `is_final=true` results.
-        # The default of 0.0 is a sentinel value indicating confidence was not set.
-        # Corresponds to the JSON property `confidence`
-        # @return [Float]
-        attr_accessor :confidence
-      
-        def initialize(**args)
-           update!(**args)
-        end
-      
-        # Update properties of this object
-        def update!(**args)
-          @transcript = args[:transcript] if args.key?(:transcript)
-          @confidence = args[:confidence] if args.key?(:confidence)
-        end
-      end
-      
-      # The request message for Operations.CancelOperation.
-      class CancelOperationRequest
-        include Google::Apis::Core::Hashable
-      
-        def initialize(**args)
-           update!(**args)
-        end
-      
-        # Update properties of this object
-        def update!(**args)
-        end
-      end
-      
       # The `RecognitionConfig` message provides information to the recognizer
       # that specifies how to process the request.
       class RecognitionConfig
@@ -278,11 +142,20 @@ module Google
         # 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
-        # `1`. If omitted, defaults to `1`.
+        # 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
@@ -312,15 +185,6 @@ module Google
         attr_accessor :profanity_filter
         alias_method :profanity_filter?, :profanity_filter
       
-        # [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
-      
         def initialize(**args)
            update!(**args)
         end
@@ -328,11 +192,11 @@ module Google
         # 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)
-          @sample_rate = args[:sample_rate] if args.key?(:sample_rate)
         end
       end
       
@@ -341,6 +205,12 @@ module Google
       class SyncRecognizeRequest
         include Google::Apis::Core::Hashable
       
+        # The `RecognitionConfig` message 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
@@ -349,32 +219,76 @@ module Google
         # @return [Google::Apis::SpeechV1beta1::RecognitionAudio]
         attr_accessor :audio
       
-        # The `RecognitionConfig` message 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
-      
         def initialize(**args)
            update!(**args)
         end
       
         # Update properties of this object
         def update!(**args)
-          @audio = args[:audio] if args.key?(:audio)
           @config = args[:config] if args.key?(:config)
+          @audio = args[:audio] if args.key?(:audio)
         end
       end
       
-      # A speech recognition result corresponding to a portion of the audio.
-      class SpeechRecognitionResult
+      # 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.
+      class Status
         include Google::Apis::Core::Hashable
       
-        # [Output-only] May contain one or more recognition hypotheses (up to the
-        # maximum specified in `max_alternatives`).
-        # Corresponds to the JSON property `alternatives`
-        # @return [Array<Google::Apis::SpeechV1beta1::SpeechRecognitionAlternative>]
-        attr_accessor :alternatives
+        # 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`
+        # @return [Array<Hash<String,Object>>]
+        attr_accessor :details
+      
+        # The status code, which should be an enum value of google.rpc.Code.
+        # Corresponds to the JSON property `code`
+        # @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)
@@ -382,7 +296,75 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @alternatives = args[:alternatives] if args.key?(:alternatives)
+          @details = args[:details] if args.key?(:details)
+          @code = args[:code] if args.key?(:code)
+          @message = args[:message] if args.key?(:message)
+        end
+      end
+      
+      # `SyncRecognizeResponse` is the only message returned to the client by
+      # `SyncRecognize`. It contains the result as zero or more sequential
+      # `SpeechRecognitionResult` messages.
+      class SyncRecognizeResponse
+        include Google::Apis::Core::Hashable
+      
+        # [Output-only] Sequential list of transcription results corresponding to
+        # sequential portions of audio.
+        # Corresponds to the JSON property `results`
+        # @return [Array<Google::Apis::SpeechV1beta1::SpeechRecognitionResult>]
+        attr_accessor :results
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @results = args[:results] if args.key?(:results)
+        end
+      end
+      
+      # A generic empty message that you can re-use to avoid defining duplicated
+      # empty messages in your APIs. A typical example is to use it as the request
+      # or the response type of an API method. For instance:
+      # service Foo `
+      # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+      # `
+      # The JSON representation for `Empty` is empty JSON object ````.
+      class Empty
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Provides "hints" to the speech recognizer to favor specific words and phrases
+      # in the results.
+      class SpeechContext
+        include Google::Apis::Core::Hashable
+      
+        # [Optional] A list of strings containing words and phrases "hints" so that
+        # the speech recognition is more likely to recognize them. This can be used
+        # to improve the accuracy for specific words and phrases, for example, if
+        # specific commands are typically spoken by the user. This can also be used
+        # to add additional words to the vocabulary of the recognizer. See
+        # [usage limits](https://cloud.google.com/speech/limits#content).
+        # Corresponds to the JSON property `phrases`
+        # @return [Array<String>]
+        attr_accessor :phrases
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @phrases = args[:phrases] if args.key?(:phrases)
         end
       end
       
@@ -411,36 +393,46 @@ module Google
         end
       end
       
-      # A generic empty message that you can re-use to avoid defining duplicated
-      # empty messages in your APIs. A typical example is to use it as the request
-      # or the response type of an API method. For instance:
-      # service Foo `
-      # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
-      # `
-      # The JSON representation for `Empty` is empty JSON object ````.
-      class Empty
+      # Alternative hypotheses (a.k.a. n-best list).
+      class SpeechRecognitionAlternative
         include Google::Apis::Core::Hashable
       
+        # [Output-only] The confidence estimate between 0.0 and 1.0. A higher number
+        # indicates an estimated greater likelihood that the recognized words are
+        # correct. This field is typically provided only for the top hypothesis, and
+        # only for `is_final=true` results. Clients should not rely on the
+        # `confidence` field as it is not guaranteed to be accurate, or even set, in
+        # any of the results.
+        # The default of 0.0 is a sentinel value indicating `confidence` was not set.
+        # Corresponds to the JSON property `confidence`
+        # @return [Float]
+        attr_accessor :confidence
+      
+        # [Output-only] Transcript text representing the words that the user spoke.
+        # Corresponds to the JSON property `transcript`
+        # @return [String]
+        attr_accessor :transcript
+      
         def initialize(**args)
            update!(**args)
         end
       
         # Update properties of this object
         def update!(**args)
+          @confidence = args[:confidence] if args.key?(:confidence)
+          @transcript = args[:transcript] if args.key?(:transcript)
         end
       end
       
-      # `SyncRecognizeResponse` is the only message returned to the client by
-      # `SyncRecognize`. It contains the result as zero or more sequential
-      # `SpeechRecognitionResult` messages.
-      class SyncRecognizeResponse
+      # A speech recognition result corresponding to a portion of the audio.
+      class SpeechRecognitionResult
         include Google::Apis::Core::Hashable
       
-        # [Output-only] Sequential list of transcription results corresponding to
-        # sequential portions of audio.
-        # Corresponds to the JSON property `results`
-        # @return [Array<Google::Apis::SpeechV1beta1::SpeechRecognitionResult>]
-        attr_accessor :results
+        # [Output-only] May contain one or more recognition hypotheses (up to the
+        # maximum specified in `max_alternatives`).
+        # Corresponds to the JSON property `alternatives`
+        # @return [Array<Google::Apis::SpeechV1beta1::SpeechRecognitionAlternative>]
+        attr_accessor :alternatives
       
         def initialize(**args)
            update!(**args)
@@ -448,24 +440,33 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @results = args[:results] if args.key?(:results)
+          @alternatives = args[:alternatives] if args.key?(:alternatives)
         end
       end
       
-      # Provides "hints" to the speech recognizer to favor specific words and phrases
-      # in the results.
-      class SpeechContext
+      # 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).
+      class RecognitionAudio
         include Google::Apis::Core::Hashable
       
-        # [Optional] A list of strings containing words and phrases "hints" so that
-        # the speech recognition is more likely to recognize them. This can be used
-        # to improve the accuracy for specific words and phrases, for example, if
-        # specific commands are typically spoken by the user. This can also be used
-        # to add additional words to the vocabulary of the recognizer. See
-        # [usage limits](https://cloud.google.com/speech/limits#content).
-        # Corresponds to the JSON property `phrases`
-        # @return [Array<String>]
-        attr_accessor :phrases
+        # 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`
+        # @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:
+        # `gs://bucket_name/object_name` (other URI formats return
+        # google.rpc.Code.INVALID_ARGUMENT). For more information, see
+        # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
+        # Corresponds to the JSON property `uri`
+        # @return [String]
+        attr_accessor :uri
       
         def initialize(**args)
            update!(**args)
@@ -473,7 +474,8 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @phrases = args[:phrases] if args.key?(:phrases)
+          @content = args[:content] if args.key?(:content)
+          @uri = args[:uri] if args.key?(:uri)
         end
       end
       
@@ -482,6 +484,12 @@ module Google
       class AsyncRecognizeRequest
         include Google::Apis::Core::Hashable
       
+        # The `RecognitionConfig` message 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
@@ -490,20 +498,14 @@ module Google
         # @return [Google::Apis::SpeechV1beta1::RecognitionAudio]
         attr_accessor :audio
       
-        # The `RecognitionConfig` message 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
-      
         def initialize(**args)
            update!(**args)
         end
       
         # Update properties of this object
         def update!(**args)
-          @audio = args[:audio] if args.key?(:audio)
           @config = args[:config] if args.key?(:config)
+          @audio = args[:audio] if args.key?(:audio)
         end
       end
     end