google-cloud-speech-v1 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 224b44e2649f8ed7aefc4d0ab4d363e5da93ee150a99d8ba8b07662379d94dc1
-  data.tar.gz: c8b981f971e5257037de77a850a6c355543dbe5c4d531164ad6d0bdc0c404803
+  metadata.gz: b6f76c56d8d4595b6dc286f2a80902e630ea18ab552080c7f38e26936ed711f2
+  data.tar.gz: d80d0da1084e8933961f0fde8d654415d260999fde439e2661fa34dd3e36b791
 SHA512:
-  metadata.gz: a77d4b2d0f91d88514a65f2a0728ee851ef7a791333e1c7d88c468a77bf12bcceabe4ac410ad569b97aabc57549fa328ce14be1c9403c8512f4e235d2f2988da
-  data.tar.gz: a7ca15ad669561c95c0df4003bfb8d90b30c35eb13798e0e145de5d233748c3e074c078854edd5c3f85a396565e5edced69989b4df9fc03a3c5973a3c63d5e5a
+  metadata.gz: 5a3d156d981c3daedb7e3d119fa99750ee51d6807a1b350ec17617c46428f59329c4d136bed4254b33df12bfbc04c966bfe049b3a81fc9d07a7a289bdcb30bac
+  data.tar.gz: be3c49a184f7d50300dcc5d2ebd52582c42a99504ef14fba801360c440892c3c1947eca510c27844e156fdca901d7319fb9a256e69537e3e19e32123aa74cce0

data/README.md

@@ -1,4 +1,4 @@
-# Cloud Speech-to-Text V1
+# Ruby Client for the Cloud Speech-to-Text V1 API
 
 API Client library for the Cloud Speech-to-Text V1 API
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
 $ gem install google-cloud-speech-v1
 ```
 
+## Before You Begin
+
+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)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/speech/v1"
+
+client = Google::Cloud::Speech::V1::Speech::Client.new
+request = my_create_request
+response = client.recognize request
+```
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-speech-v1/latest)
+for class and method documentation.
+
+## 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/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+that will write logs to [Cloud 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
+```
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.4+.

data/lib/google/cloud/speech/v1/speech/client.rb

@@ -16,15 +16,8 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 require "google/cloud/errors"
-require "google/cloud/speech/v1/version"
 require "google/cloud/speech/v1/cloud_speech_pb"
-require "google/cloud/speech/v1/speech/credentials"
-require "google/cloud/speech/v1/speech/operations"
 
 module Google
   module Cloud
@@ -175,20 +168,26 @@ module Google
             # has been sent and processed.
             #
             # @overload recognize(request, options = nil)
-            #   @param request [Google::Cloud::Speech::V1::RecognizeRequest | Hash]
-            #     Performs synchronous speech recognition: receive results after all audio
-            #     has been sent and processed.
+            #   Pass arguments to `recognize` via a request object, either of type
+            #   {Google::Cloud::Speech::V1::RecognizeRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Speech::V1::RecognizeRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload recognize(config: nil, audio: nil)
-            #   @param config [Google::Cloud::Speech::V1::RecognitionConfig | Hash]
+            #   Pass arguments to `recognize` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param config [Google::Cloud::Speech::V1::RecognitionConfig, Hash]
             #     Required. Provides information to the recognizer that specifies how to
             #     process the request.
-            #   @param audio [Google::Cloud::Speech::V1::RecognitionAudio | Hash]
+            #   @param audio [Google::Cloud::Speech::V1::RecognitionAudio, Hash]
             #     Required. The audio data to be recognized.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Speech::V1::RecognizeResponse]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -237,24 +236,26 @@ module Google
             # [how-to](https://cloud.google.com/speech-to-text/docs/async-recognize).
             #
             # @overload long_running_recognize(request, options = nil)
-            #   @param request [Google::Cloud::Speech::V1::LongRunningRecognizeRequest | Hash]
-            #     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.
-            #     For more information on asynchronous speech recognition, see the
-            #     [how-to](https://cloud.google.com/speech-to-text/docs/async-recognize).
+            #   Pass arguments to `long_running_recognize` via a request object, either of type
+            #   {Google::Cloud::Speech::V1::LongRunningRecognizeRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Speech::V1::LongRunningRecognizeRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload long_running_recognize(config: nil, audio: nil)
-            #   @param config [Google::Cloud::Speech::V1::RecognitionConfig | Hash]
+            #   Pass arguments to `long_running_recognize` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param config [Google::Cloud::Speech::V1::RecognitionConfig, Hash]
             #     Required. Provides information to the recognizer that specifies how to
             #     process the request.
-            #   @param audio [Google::Cloud::Speech::V1::RecognitionAudio | Hash]
+            #   @param audio [Google::Cloud::Speech::V1::RecognitionAudio, Hash]
             #     Required. The audio data to be recognized.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::Operation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -299,7 +300,7 @@ module Google
             # Performs bidirectional streaming speech recognition: receive results while
             # sending audio. This method is only available via the gRPC API (not REST).
             #
-            # @param request [Gapic::StreamInput, Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeRequest | Hash>]
+            # @param request [Gapic::StreamInput, Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeRequest, Hash>]
             #   An enumerable of {Google::Cloud::Speech::V1::StreamingRecognizeRequest} instances.
             # @param options [Gapic::CallOptions, Hash]
             #   Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@@ -515,13 +516,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/speech/v1/speech/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions

data/lib/google/cloud/speech/v1/speech/operations.rb

@@ -16,11 +16,7 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
 require "gapic/operation"
-
-require "google/cloud/speech/v1/version"
-require "google/cloud/speech/v1/speech/client"
 require "google/longrunning/operations_pb"
 
 module Google
@@ -109,16 +105,20 @@ module Google
             # to use different resource name schemes, such as `users/*/operations`.
             #
             # @overload list_operations(request, options = nil)
-            #   @param request [Google::Longrunning::ListOperationsRequest | Hash]
-            #     Lists operations that match the specified filter in the request. If the
-            #     server doesn't support this method, it returns `UNIMPLEMENTED`.
+            #   Pass arguments to `list_operations` via a request object, either of type
+            #   {Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
             #
-            #     NOTE: the `name` binding below allows API services to override the binding
-            #     to use different resource name schemes, such as `users/*/operations`.
+            #   @param request [Google::Longrunning::ListOperationsRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
+            #   Pass arguments to `list_operations` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
             #   @param name [String]
             #     The name of the operation collection.
             #   @param filter [String]
@@ -128,7 +128,6 @@ module Google
             #   @param page_token [String]
             #     The standard list page token.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::PagedEnumerable<Gapic::Operation>]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -182,18 +181,23 @@ module Google
             # service.
             #
             # @overload get_operation(request, options = nil)
-            #   @param request [Google::Longrunning::GetOperationRequest | Hash]
-            #     Gets the latest state of a long-running operation.  Clients can use this
-            #     method to poll the operation result at intervals as recommended by the API
-            #     service.
+            #   Pass arguments to `get_operation` via a request object, either of type
+            #   {Google::Longrunning::GetOperationRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Longrunning::GetOperationRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload get_operation(name: nil)
+            #   Pass arguments to `get_operation` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
             #   @param name [String]
             #     The name of the operation resource.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::Operation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -247,19 +251,23 @@ module Google
             # `google.rpc.Code.UNIMPLEMENTED`.
             #
             # @overload delete_operation(request, options = nil)
-            #   @param request [Google::Longrunning::DeleteOperationRequest | Hash]
-            #     Deletes a long-running operation. This method indicates that the client is
-            #     no longer interested in the operation result. It does not cancel the
-            #     operation. If the server doesn't support this method, it returns
-            #     `google.rpc.Code.UNIMPLEMENTED`.
+            #   Pass arguments to `delete_operation` via a request object, either of type
+            #   {Google::Longrunning::DeleteOperationRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Longrunning::DeleteOperationRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload delete_operation(name: nil)
+            #   Pass arguments to `delete_operation` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
             #   @param name [String]
             #     The name of the operation resource to be deleted.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Protobuf::Empty]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -318,25 +326,23 @@ module Google
             # corresponding to `Code.CANCELLED`.
             #
             # @overload cancel_operation(request, options = nil)
-            #   @param request [Google::Longrunning::CancelOperationRequest | Hash]
-            #     Starts asynchronous cancellation on a long-running operation.  The server
-            #     makes a best effort to cancel the operation, but success is not
-            #     guaranteed.  If the server doesn't support this method, it returns
-            #     `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
-            #     Operations.GetOperation or
-            #     other methods to check whether the cancellation succeeded or whether the
-            #     operation completed despite cancellation. On successful cancellation,
-            #     the operation is not deleted; instead, it becomes an operation with
-            #     an {Google::Longrunning::Operation#error Operation.error} value with a {Google::Rpc::Status#code google.rpc.Status.code} of 1,
-            #     corresponding to `Code.CANCELLED`.
+            #   Pass arguments to `cancel_operation` via a request object, either of type
+            #   {Google::Longrunning::CancelOperationRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Longrunning::CancelOperationRequest, Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
             #   @param options [Gapic::CallOptions, Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
             # @overload cancel_operation(name: nil)
+            #   Pass arguments to `cancel_operation` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
             #   @param name [String]
             #     The name of the operation resource to be cancelled.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Protobuf::Empty]
             # @yieldparam operation [GRPC::ActiveCall::Operation]

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

@@ -16,6 +16,34 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/speech/v1/speech/client"
-require "google/cloud/speech/v1/speech/operations"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/speech/v1/version"
+
 require "google/cloud/speech/v1/speech/credentials"
+require "google/cloud/speech/v1/speech/operations"
+require "google/cloud/speech/v1/speech/client"
+
+module Google
+  module Cloud
+    module Speech
+      module V1
+        ##
+        # Service that implements Google Cloud Speech API.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/speech/v1/speech"
+        #     client = Google::Cloud::Speech::V1::Speech::Client.new
+        #
+        module Speech
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "speech", "helpers.rb"
+require "google/cloud/speech/v1/speech/helpers" if ::File.file? helper_path

data/lib/google/cloud/speech/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Speech
       module V1
-        VERSION = "0.1.1"
+        VERSION = "0.1.2"
       end
     end
   end

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

@@ -17,3 +17,19 @@
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
 require "google/cloud/speech/v1/speech"
+require "google/cloud/speech/v1/version"
+
+module Google
+  module Cloud
+    module Speech
+      ##
+      # To load this package, including all its services, and instantiate a client:
+      #
+      #     require "google/cloud/speech/v1"
+      #     client = Google::Cloud::Speech::V1::Speech::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

data/lib/google-cloud-speech-v1.rb

@@ -1 +1,21 @@
-require "google/cloud/speech/v1/version"
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/speech/v1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-speech-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common