google-cloud-vision-v1 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc9d94836585d64ad1377a90ae263d9ac16a139d33d719f9fd15d7e9d2ef9246
-  data.tar.gz: 5db3da602b2082277f85132aa413beb38133f309292039bf5976d17f2fafbaa5
+  metadata.gz: 00b662e4d0e94b6f05a3bc4515223e81602905efe5b34c4d6386ac14325eab2a
+  data.tar.gz: be82341c0066884c13f14d416ae6d8dfcd6e3f89dca122b80ca51a8256aff40b
 SHA512:
-  metadata.gz: 1451c949d6fdeeca39d8f65fb368dc6041cd9002a8220978cc9443f04b6e818967ea4003f9392072e037d2a2e6f7aaa2eef0c6c4979a0c1d0ee9549764a127b6
-  data.tar.gz: c1ed9fa01aa29a65a65e9f376352304e589d356f857680fb23fbac46f1b45dd4d9a1921b9ae439e28cb2c7a43a38973b5f7b24d4fb557f26dbf2c5717dbecf7b
+  metadata.gz: e3c5cd5e1412c59119d8592c8fb5178a0dcb4ea4f59dc3685e6c2e982e4f7010d23de9efd44fe05e5e44c16735ff07269051352c089443c2b4f9e8a487b42ff7
+  data.tar.gz: a93cdf2b55c328113ea051ac7e41d20c5ff1a0bee338443fab5995337f1547b05cadb1c867ffdbb15f2f53da2193fbb0a284c77f2bb21862bdc5614779647e80

data/README.md

@@ -1,4 +1,4 @@
-# Cloud Vision V1
+# Ruby Client for the Cloud Vision V1 API
 
 API Client library for the Cloud Vision V1 API
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
 $ gem install google-cloud-vision-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/vision/v1"
+
+client = Google::Cloud::Vision::V1::ProductSearch::Client.new
+request = my_create_request
+response = client.create_product_set request
+```
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-vision-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-vision-v1.rb

@@ -1 +1,21 @@
-require "google/cloud/vision/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/vision/v1"

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

@@ -18,3 +18,19 @@
 
 require "google/cloud/vision/v1/product_search"
 require "google/cloud/vision/v1/image_annotator"
+require "google/cloud/vision/v1/version"
+
+module Google
+  module Cloud
+    module Vision
+      ##
+      # To load this package, including all its services, and instantiate a client:
+      #
+      #     require "google/cloud/vision/v1"
+      #     client = Google::Cloud::Vision::V1::ProductSearch::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

data/lib/google/cloud/vision/v1/image_annotator.rb

@@ -16,6 +16,37 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/vision/v1/image_annotator/client"
-require "google/cloud/vision/v1/image_annotator/operations"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/vision/v1/version"
+
 require "google/cloud/vision/v1/image_annotator/credentials"
+require "google/cloud/vision/v1/image_annotator/paths"
+require "google/cloud/vision/v1/image_annotator/operations"
+require "google/cloud/vision/v1/image_annotator/client"
+
+module Google
+  module Cloud
+    module Vision
+      module V1
+        ##
+        # Service that performs Google Cloud Vision API detection tasks over client
+        # images, such as face, landmark, logo, label, and text detection. The
+        # ImageAnnotator service returns detected entities from the images.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/vision/v1/image_annotator"
+        #     client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
+        #
+        module ImageAnnotator
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "image_annotator", "helpers.rb"
+require "google/cloud/vision/v1/image_annotator/helpers" if ::File.file? helper_path

data/lib/google/cloud/vision/v1/image_annotator/client.rb

@@ -16,16 +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/vision/v1/version"
 require "google/cloud/vision/v1/image_annotator_pb"
-require "google/cloud/vision/v1/image_annotator/credentials"
-require "google/cloud/vision/v1/image_annotator/paths"
-require "google/cloud/vision/v1/image_annotator/operations"
 
 module Google
   module Cloud
@@ -193,13 +185,21 @@ module Google
             # Run image detection and annotation for a batch of images.
             #
             # @overload batch_annotate_images(request, options = nil)
-            #   @param request [Google::Cloud::Vision::V1::BatchAnnotateImagesRequest | Hash]
-            #     Run image detection and annotation for a batch of images.
+            #   Pass arguments to `batch_annotate_images` via a request object, either of type
+            #   {Google::Cloud::Vision::V1::BatchAnnotateImagesRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Vision::V1::BatchAnnotateImagesRequest, 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 batch_annotate_images(requests: nil, parent: nil)
-            #   @param requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest | Hash>]
+            #   Pass arguments to `batch_annotate_images` 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 requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest, Hash>]
             #     Required. Individual image annotation requests for this batch.
             #   @param parent [String]
             #     Optional. Target project and location to make a call.
@@ -215,7 +215,6 @@ module Google
             #
             #     Example: `projects/project-A/locations/eu`.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Vision::V1::BatchAnnotateImagesResponse]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -265,19 +264,21 @@ module Google
             # extracted.
             #
             # @overload batch_annotate_files(request, options = nil)
-            #   @param request [Google::Cloud::Vision::V1::BatchAnnotateFilesRequest | Hash]
-            #     Service that performs image detection and annotation for a batch of files.
-            #     Now only "application/pdf", "image/tiff" and "image/gif" are supported.
-            #
-            #     This service will extract at most 5 (customers can specify which 5 in
-            #     AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each
-            #     file provided and perform detection and annotation for each image
-            #     extracted.
+            #   Pass arguments to `batch_annotate_files` via a request object, either of type
+            #   {Google::Cloud::Vision::V1::BatchAnnotateFilesRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Vision::V1::BatchAnnotateFilesRequest, 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 batch_annotate_files(requests: nil, parent: nil)
-            #   @param requests [Array<Google::Cloud::Vision::V1::AnnotateFileRequest | Hash>]
+            #   Pass arguments to `batch_annotate_files` 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 requests [Array<Google::Cloud::Vision::V1::AnnotateFileRequest, Hash>]
             #     Required. The list of file annotation requests. Right now we support only one
             #     AnnotateFileRequest in BatchAnnotateFilesRequest.
             #   @param parent [String]
@@ -294,7 +295,6 @@ module Google
             #
             #     Example: `projects/project-A/locations/eu`.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Vision::V1::BatchAnnotateFilesResponse]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -346,23 +346,23 @@ module Google
             # GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
             #
             # @overload async_batch_annotate_images(request, options = nil)
-            #   @param request [Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest | Hash]
-            #     Run asynchronous image detection and annotation for a list of images.
+            #   Pass arguments to `async_batch_annotate_images` via a request object, either of type
+            #   {Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest} or an equivalent Hash.
             #
-            #     Progress and results can be retrieved through the
-            #     `google.longrunning.Operations` interface.
-            #     `Operation.metadata` contains `OperationMetadata` (metadata).
-            #     `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).
-            #
-            #     This service will write image annotation outputs to json files in customer
-            #     GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
+            #   @param request [Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest, 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 async_batch_annotate_images(requests: nil, output_config: nil, parent: nil)
-            #   @param requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest | Hash>]
+            #   Pass arguments to `async_batch_annotate_images` 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 requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest, Hash>]
             #     Required. Individual image annotation requests for this batch.
-            #   @param output_config [Google::Cloud::Vision::V1::OutputConfig | Hash]
+            #   @param output_config [Google::Cloud::Vision::V1::OutputConfig, Hash]
             #     Required. The desired output location and metadata (e.g. format).
             #   @param parent [String]
             #     Optional. Target project and location to make a call.
@@ -378,7 +378,6 @@ module Google
             #
             #     Example: `projects/project-A/locations/eu`.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::Operation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -428,18 +427,21 @@ module Google
             # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
             #
             # @overload async_batch_annotate_files(request, options = nil)
-            #   @param request [Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest | Hash]
-            #     Run asynchronous image detection and annotation for a list of generic
-            #     files, such as PDF files, which may contain multiple pages and multiple
-            #     images per page. Progress and results can be retrieved through the
-            #     `google.longrunning.Operations` interface.
-            #     `Operation.metadata` contains `OperationMetadata` (metadata).
-            #     `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
+            #   Pass arguments to `async_batch_annotate_files` via a request object, either of type
+            #   {Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest, 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 async_batch_annotate_files(requests: nil, parent: nil)
-            #   @param requests [Array<Google::Cloud::Vision::V1::AsyncAnnotateFileRequest | Hash>]
+            #   Pass arguments to `async_batch_annotate_files` 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 requests [Array<Google::Cloud::Vision::V1::AsyncAnnotateFileRequest, Hash>]
             #     Required. Individual async file annotation requests for this batch.
             #   @param parent [String]
             #     Optional. Target project and location to make a call.
@@ -455,7 +457,6 @@ module Google
             #
             #     Example: `projects/project-A/locations/eu`.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::Operation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -670,13 +671,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/vision/v1/image_annotator/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions

data/lib/google/cloud/vision/v1/image_annotator/operations.rb

@@ -16,11 +16,7 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
 require "gapic/operation"
-
-require "google/cloud/vision/v1/version"
-require "google/cloud/vision/v1/image_annotator/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]