google-cloud-speech 0.31.0 → 0.31.1

data/lib/google/cloud/speech/v1p1beta1/doc/google/longrunning/operations.rb

@@ -21,7 +21,7 @@ module Google
     #   @return [String]
     #     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+.
+    #     `name` should have the format of `operations/some/unique/name`.
     # @!attribute [rw] metadata
     #   @return [Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically
@@ -30,8 +30,8 @@ module Google
     #     long-running operation should document the metadata type, if any.
     # @!attribute [rw] done
     #   @return [true, false]
-    #     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
+    #     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.
     # @!attribute [rw] error
     #   @return [Google::Rpc::Status]
@@ -39,13 +39,13 @@ module Google
     # @!attribute [rw] response
     #   @return [Google::Protobuf::Any]
     #     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+
+    #     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+.
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
     class Operation; end
 
     # The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.

data/lib/google/cloud/speech/v1p1beta1/doc/google/protobuf/any.rb

@@ -15,7 +15,7 @@
 
 module Google
   module Protobuf
-    # +Any+ contains an arbitrary serialized protocol buffer message along with a
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
     # URL that describes the type of the serialized message.
     #
     # Protobuf library provides support to pack/unpack Any values in the form
@@ -69,9 +69,9 @@ module Google
     #
     # = JSON
     #
-    # The JSON representation of an +Any+ value uses the regular
+    # The JSON representation of an `Any` value uses the regular
     # representation of the deserialized, embedded message, with an
-    # additional field +@type+ which contains the type URL. Example:
+    # additional field `@type` which contains the type URL. Example:
     #
     #     package google.profile;
     #     message Person {
@@ -87,7 +87,7 @@ module Google
     #
     # If the embedded message type is well-known and has a custom JSON
     # representation, that representation will be embedded adding a field
-    # +value+ which holds the custom JSON in addition to the +@type+
+    # `value` which holds the custom JSON in addition to the `@type`
     # field. Example (for message {Google::Protobuf::Duration}):
     #
     #     {
@@ -99,15 +99,15 @@ module Google
     #     A URL/resource name that uniquely identifies the type of the serialized
     #     protocol buffer message. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
-    #     +path/google.protobuf.Duration+). The name should be in a canonical form
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).
     #
     #     In practice, teams usually precompile into the binary all types that they
     #     expect it to use in the context of Any. However, for URLs which use the
-    #     scheme +http+, +https+, or no scheme, one can optionally set up a type
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
     #     server that maps type URLs to message definitions as follows:
     #
-    #     * If no scheme is provided, +https+ is assumed.
+    #     * If no scheme is provided, `https` is assumed.
     #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
     #       value in binary format, or produce an error.
     #     * Applications are allowed to cache lookup results based on the
@@ -120,7 +120,7 @@ module Google
     #     protobuf release, and it is not used for type URLs beginning with
     #     type.googleapis.com.
     #
-    #     Schemes other than +http+, +https+ (or the empty scheme) might be
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
     #     used with implementation specific semantics.
     # @!attribute [rw] value
     #   @return [String]

data/lib/google/cloud/speech/v1p1beta1/doc/google/protobuf/duration.rb

@@ -82,9 +82,9 @@ module Google
     #   @return [Integer]
     #     Signed fractions of a second at nanosecond resolution of the span
     #     of time. Durations less than one second are represented with a 0
-    #     +seconds+ field and a positive or negative +nanos+ field. For durations
-    #     of one second or more, a non-zero value for the +nanos+ field must be
-    #     of the same sign as the +seconds+ field. Must be from -999,999,999
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
     #     to +999,999,999 inclusive.
     class Duration; end
   end

data/lib/google/cloud/speech/v1p1beta1/doc/google/rpc/status.rb

@@ -15,7 +15,7 @@
 
 module Google
   module Rpc
-    # The +Status+ type defines a logical error model that is suitable for different
+    # 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:
     #
@@ -24,7 +24,7 @@ module Google
     #
     # = Overview
     #
-    # The +Status+ message contains three pieces of data: error code, error message,
+    # 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
@@ -32,40 +32,40 @@ module Google
     # 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+ that can be used for common error conditions.
+    # in the package `google.rpc` that 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
+    # 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
+    # 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
+    #   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.
+    #   have a `Status` message for error reporting.
     #
     # * Batch operations. If a client uses batch request and batch response, the
-    #   +Status+ message should be used directly inside batch response, one for
+    #   `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.
+    #   represented directly using the `Status` message.
     #
-    # * Logging. If some API errors are stored in logs, the message +Status+ could
+    # * Logging. If some API errors are stored in logs, the message `Status` could
     #   be used directly after any stripping needed for security/privacy reasons.
     # @!attribute [rw] code
     #   @return [Integer]

data/lib/google/cloud/speech/v1p1beta1/speech_client.rb

@@ -246,8 +246,8 @@ module Google
 
           # Performs asynchronous speech recognition: receive results via the
           # google.longrunning.Operations interface. Returns either an
-          # +Operation.error+ or an +Operation.response+ which contains
-          # a +LongRunningRecognizeResponse+ message.
+          # `Operation.error` or an `Operation.response` which contains
+          # a `LongRunningRecognizeResponse` message.
           #
           # @param config [Google::Cloud::Speech::V1p1beta1::RecognitionConfig | Hash]
           #   *Required* Provides information to the recognizer that specifies how to

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-speech
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.31.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-gax
@@ -113,7 +113,6 @@ files:
 - lib/google/cloud/speech/v1/doc/google/protobuf/any.rb
 - lib/google/cloud/speech/v1/doc/google/protobuf/duration.rb
 - lib/google/cloud/speech/v1/doc/google/rpc/status.rb
-- lib/google/cloud/speech/v1/doc/overview.rb
 - lib/google/cloud/speech/v1/helpers.rb
 - lib/google/cloud/speech/v1/speech_client.rb
 - lib/google/cloud/speech/v1/speech_client_config.json
@@ -127,7 +126,6 @@ files:
 - lib/google/cloud/speech/v1p1beta1/doc/google/protobuf/any.rb
 - lib/google/cloud/speech/v1p1beta1/doc/google/protobuf/duration.rb
 - lib/google/cloud/speech/v1p1beta1/doc/google/rpc/status.rb
-- lib/google/cloud/speech/v1p1beta1/doc/overview.rb
 - lib/google/cloud/speech/v1p1beta1/helpers.rb
 - lib/google/cloud/speech/v1p1beta1/speech_client.rb
 - lib/google/cloud/speech/v1p1beta1/speech_client_config.json

data/lib/google/cloud/speech/v1/doc/overview.rb

@@ -1,99 +0,0 @@
-# Copyright 2018 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Google
-  module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Google Cloud Speech API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
-    #
-    # [Google Cloud Speech API][Product Documentation]:
-    # Google Cloud Speech API.
-    # - [Product Documentation][]
-    #
-    # ## Quick Start
-    # In order to use this library, you first need to go through the following
-    # steps:
-    #
-    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Google Cloud Speech API.](https://console.cloud.google.com/apis/library/speech.googleapis.com)
-    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
-    #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-speech
-    # ```
-    #
-    # ### Preview
-    # #### SpeechClient
-    # ```rb
-    # require "google/cloud/speech"
-    #
-    # speech_client = Google::Cloud::Speech.new
-    # language_code = "en-US"
-    # sample_rate_hertz = 44100
-    # encoding = :FLAC
-    # config = {
-    #   language_code: language_code,
-    #   sample_rate_hertz: sample_rate_hertz,
-    #   encoding: encoding
-    # }
-    # uri = "gs://gapic-toolkit/hello.flac"
-    # audio = { uri: uri }
-    # response = speech_client.recognize(config, audio)
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Google Cloud Speech API Product documentation][Product Documentation]
-    #   to learn more about the product and see How-to Guides.
-    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
-    #   to see the full list of Cloud APIs that we cover.
-    #
-    # [Product Documentation]: https://cloud.google.com/speech
-    #
-    # ## Enabling Logging
-    #
-    # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-    # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-    # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
-    # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-    # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-    #
-    # Configuring a Ruby stdlib logger:
-    #
-    # ```ruby
-    # require "logger"
-    #
-    # module MyLogger
-    #   LOGGER = Logger.new $stderr, level: Logger::WARN
-    #   def logger
-    #     LOGGER
-    #   end
-    # end
-    #
-    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-    # module GRPC
-    #   extend MyLogger
-    # end
-    # ```
-    #
-    module Speech
-      module V1
-      end
-    end
-  end
-end

data/lib/google/cloud/speech/v1p1beta1/doc/overview.rb

@@ -1,99 +0,0 @@
-# Copyright 2018 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Google
-  module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Cloud Speech API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
-    #
-    # [Cloud Speech API][Product Documentation]:
-    # Converts audio to text by applying powerful neural network models.
-    # - [Product Documentation][]
-    #
-    # ## Quick Start
-    # In order to use this library, you first need to go through the following
-    # steps:
-    #
-    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Cloud Speech API.](https://console.cloud.google.com/apis/library/speech.googleapis.com)
-    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
-    #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-speech
-    # ```
-    #
-    # ### Preview
-    # #### SpeechClient
-    # ```rb
-    # require "google/cloud/speech"
-    #
-    # speech_client = Google::Cloud::Speech.new
-    # language_code = "en-US"
-    # sample_rate_hertz = 44100
-    # encoding = :FLAC
-    # config = {
-    #   language_code: language_code,
-    #   sample_rate_hertz: sample_rate_hertz,
-    #   encoding: encoding
-    # }
-    # uri = "gs://gapic-toolkit/hello.flac"
-    # audio = { uri: uri }
-    # response = speech_client.recognize(config, audio)
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Cloud Speech API Product documentation][Product Documentation]
-    #   to learn more about the product and see How-to Guides.
-    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
-    #   to see the full list of Cloud APIs that we cover.
-    #
-    # [Product Documentation]: https://cloud.google.com/speech
-    #
-    # ## Enabling Logging
-    #
-    # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-    # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-    # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
-    # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-    # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-    #
-    # Configuring a Ruby stdlib logger:
-    #
-    # ```ruby
-    # require "logger"
-    #
-    # module MyLogger
-    #   LOGGER = Logger.new $stderr, level: Logger::WARN
-    #   def logger
-    #     LOGGER
-    #   end
-    # end
-    #
-    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-    # module GRPC
-    #   extend MyLogger
-    # end
-    # ```
-    #
-    module Speech
-      module V1p1beta1
-      end
-    end
-  end
-end