google-cloud-vision-v1 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cc9d94836585d64ad1377a90ae263d9ac16a139d33d719f9fd15d7e9d2ef9246
4
- data.tar.gz: 5db3da602b2082277f85132aa413beb38133f309292039bf5976d17f2fafbaa5
3
+ metadata.gz: 00b662e4d0e94b6f05a3bc4515223e81602905efe5b34c4d6386ac14325eab2a
4
+ data.tar.gz: be82341c0066884c13f14d416ae6d8dfcd6e3f89dca122b80ca51a8256aff40b
5
5
  SHA512:
6
- metadata.gz: 1451c949d6fdeeca39d8f65fb368dc6041cd9002a8220978cc9443f04b6e818967ea4003f9392072e037d2a2e6f7aaa2eef0c6c4979a0c1d0ee9549764a127b6
7
- data.tar.gz: c1ed9fa01aa29a65a65e9f376352304e589d356f857680fb23fbac46f1b45dd4d9a1921b9ae439e28cb2c7a43a38973b5f7b24d4fb557f26dbf2c5717dbecf7b
6
+ metadata.gz: e3c5cd5e1412c59119d8592c8fb5178a0dcb4ea4f59dc3685e6c2e982e4f7010d23de9efd44fe05e5e44c16735ff07269051352c089443c2b4f9e8a487b42ff7
7
+ data.tar.gz: a93cdf2b55c328113ea051ac7e41d20c5ff1a0bee338443fab5995337f1547b05cadb1c867ffdbb15f2f53da2193fbb0a284c77f2bb21862bdc5614779647e80
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Cloud Vision V1
1
+ # Ruby Client for the Cloud Vision V1 API
2
2
 
3
3
  API Client library for the Cloud Vision V1 API
4
4
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
12
12
  $ gem install google-cloud-vision-v1
13
13
  ```
14
14
 
15
+ ## Before You Begin
16
+
17
+ In order to use this library, you first need to go through the following steps:
18
+
19
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
20
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
21
+ 1. {file:AUTHENTICATION.md Set up authentication.}
22
+
23
+ ## Quick Start
24
+
25
+ ```ruby
26
+ require "google/cloud/vision/v1"
27
+
28
+ client = Google::Cloud::Vision::V1::ProductSearch::Client.new
29
+ request = my_create_request
30
+ response = client.create_product_set request
31
+ ```
32
+
33
+ View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-vision-v1/latest)
34
+ for class and method documentation.
35
+
36
+ ## Enabling Logging
37
+
38
+ To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
39
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
40
+ or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
41
+ 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)
42
+ and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
43
+
44
+ Configuring a Ruby stdlib logger:
45
+
46
+ ```ruby
47
+ require "logger"
48
+
49
+ module MyLogger
50
+ LOGGER = Logger.new $stderr, level: Logger::WARN
51
+ def logger
52
+ LOGGER
53
+ end
54
+ end
55
+
56
+ # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
57
+ module GRPC
58
+ extend MyLogger
59
+ end
60
+ ```
61
+
15
62
  ## Supported Ruby Versions
16
63
 
17
64
  This library is supported on Ruby 2.4+.
@@ -1 +1,21 @@
1
- require "google/cloud/vision/v1/version"
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/cloud/vision/v1"
@@ -18,3 +18,19 @@
18
18
 
19
19
  require "google/cloud/vision/v1/product_search"
20
20
  require "google/cloud/vision/v1/image_annotator"
21
+ require "google/cloud/vision/v1/version"
22
+
23
+ module Google
24
+ module Cloud
25
+ module Vision
26
+ ##
27
+ # To load this package, including all its services, and instantiate a client:
28
+ #
29
+ # require "google/cloud/vision/v1"
30
+ # client = Google::Cloud::Vision::V1::ProductSearch::Client.new
31
+ #
32
+ module V1
33
+ end
34
+ end
35
+ end
36
+ end
@@ -16,6 +16,37 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/vision/v1/image_annotator/client"
20
- require "google/cloud/vision/v1/image_annotator/operations"
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/vision/v1/version"
24
+
21
25
  require "google/cloud/vision/v1/image_annotator/credentials"
26
+ require "google/cloud/vision/v1/image_annotator/paths"
27
+ require "google/cloud/vision/v1/image_annotator/operations"
28
+ require "google/cloud/vision/v1/image_annotator/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module Vision
33
+ module V1
34
+ ##
35
+ # Service that performs Google Cloud Vision API detection tasks over client
36
+ # images, such as face, landmark, logo, label, and text detection. The
37
+ # ImageAnnotator service returns detected entities from the images.
38
+ #
39
+ # To load this service and instantiate a client:
40
+ #
41
+ # require "google/cloud/vision/v1/image_annotator"
42
+ # client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
43
+ #
44
+ module ImageAnnotator
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
50
+
51
+ helper_path = ::File.join __dir__, "image_annotator", "helpers.rb"
52
+ require "google/cloud/vision/v1/image_annotator/helpers" if ::File.file? helper_path
@@ -16,16 +16,8 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
- require "gapic/config"
21
- require "gapic/config/method"
22
-
23
19
  require "google/cloud/errors"
24
- require "google/cloud/vision/v1/version"
25
20
  require "google/cloud/vision/v1/image_annotator_pb"
26
- require "google/cloud/vision/v1/image_annotator/credentials"
27
- require "google/cloud/vision/v1/image_annotator/paths"
28
- require "google/cloud/vision/v1/image_annotator/operations"
29
21
 
30
22
  module Google
31
23
  module Cloud
@@ -193,13 +185,21 @@ module Google
193
185
  # Run image detection and annotation for a batch of images.
194
186
  #
195
187
  # @overload batch_annotate_images(request, options = nil)
196
- # @param request [Google::Cloud::Vision::V1::BatchAnnotateImagesRequest | Hash]
197
- # Run image detection and annotation for a batch of images.
188
+ # Pass arguments to `batch_annotate_images` via a request object, either of type
189
+ # {Google::Cloud::Vision::V1::BatchAnnotateImagesRequest} or an equivalent Hash.
190
+ #
191
+ # @param request [Google::Cloud::Vision::V1::BatchAnnotateImagesRequest, Hash]
192
+ # A request object representing the call parameters. Required. To specify no
193
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
198
194
  # @param options [Gapic::CallOptions, Hash]
199
195
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
200
196
  #
201
197
  # @overload batch_annotate_images(requests: nil, parent: nil)
202
- # @param requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest | Hash>]
198
+ # Pass arguments to `batch_annotate_images` via keyword arguments. Note that at
199
+ # least one keyword argument is required. To specify no parameters, or to keep all
200
+ # the default parameter values, pass an empty Hash as a request object (see above).
201
+ #
202
+ # @param requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest, Hash>]
203
203
  # Required. Individual image annotation requests for this batch.
204
204
  # @param parent [String]
205
205
  # Optional. Target project and location to make a call.
@@ -215,7 +215,6 @@ module Google
215
215
  #
216
216
  # Example: `projects/project-A/locations/eu`.
217
217
  #
218
- #
219
218
  # @yield [response, operation] Access the result along with the RPC operation
220
219
  # @yieldparam response [Google::Cloud::Vision::V1::BatchAnnotateImagesResponse]
221
220
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -265,19 +264,21 @@ module Google
265
264
  # extracted.
266
265
  #
267
266
  # @overload batch_annotate_files(request, options = nil)
268
- # @param request [Google::Cloud::Vision::V1::BatchAnnotateFilesRequest | Hash]
269
- # Service that performs image detection and annotation for a batch of files.
270
- # Now only "application/pdf", "image/tiff" and "image/gif" are supported.
271
- #
272
- # This service will extract at most 5 (customers can specify which 5 in
273
- # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each
274
- # file provided and perform detection and annotation for each image
275
- # extracted.
267
+ # Pass arguments to `batch_annotate_files` via a request object, either of type
268
+ # {Google::Cloud::Vision::V1::BatchAnnotateFilesRequest} or an equivalent Hash.
269
+ #
270
+ # @param request [Google::Cloud::Vision::V1::BatchAnnotateFilesRequest, Hash]
271
+ # A request object representing the call parameters. Required. To specify no
272
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
276
273
  # @param options [Gapic::CallOptions, Hash]
277
274
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
278
275
  #
279
276
  # @overload batch_annotate_files(requests: nil, parent: nil)
280
- # @param requests [Array<Google::Cloud::Vision::V1::AnnotateFileRequest | Hash>]
277
+ # Pass arguments to `batch_annotate_files` via keyword arguments. Note that at
278
+ # least one keyword argument is required. To specify no parameters, or to keep all
279
+ # the default parameter values, pass an empty Hash as a request object (see above).
280
+ #
281
+ # @param requests [Array<Google::Cloud::Vision::V1::AnnotateFileRequest, Hash>]
281
282
  # Required. The list of file annotation requests. Right now we support only one
282
283
  # AnnotateFileRequest in BatchAnnotateFilesRequest.
283
284
  # @param parent [String]
@@ -294,7 +295,6 @@ module Google
294
295
  #
295
296
  # Example: `projects/project-A/locations/eu`.
296
297
  #
297
- #
298
298
  # @yield [response, operation] Access the result along with the RPC operation
299
299
  # @yieldparam response [Google::Cloud::Vision::V1::BatchAnnotateFilesResponse]
300
300
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -346,23 +346,23 @@ module Google
346
346
  # GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
347
347
  #
348
348
  # @overload async_batch_annotate_images(request, options = nil)
349
- # @param request [Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest | Hash]
350
- # Run asynchronous image detection and annotation for a list of images.
349
+ # Pass arguments to `async_batch_annotate_images` via a request object, either of type
350
+ # {Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest} or an equivalent Hash.
351
351
  #
352
- # Progress and results can be retrieved through the
353
- # `google.longrunning.Operations` interface.
354
- # `Operation.metadata` contains `OperationMetadata` (metadata).
355
- # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).
356
- #
357
- # This service will write image annotation outputs to json files in customer
358
- # GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
352
+ # @param request [Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest, Hash]
353
+ # A request object representing the call parameters. Required. To specify no
354
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
359
355
  # @param options [Gapic::CallOptions, Hash]
360
356
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
361
357
  #
362
358
  # @overload async_batch_annotate_images(requests: nil, output_config: nil, parent: nil)
363
- # @param requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest | Hash>]
359
+ # Pass arguments to `async_batch_annotate_images` via keyword arguments. Note that at
360
+ # least one keyword argument is required. To specify no parameters, or to keep all
361
+ # the default parameter values, pass an empty Hash as a request object (see above).
362
+ #
363
+ # @param requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest, Hash>]
364
364
  # Required. Individual image annotation requests for this batch.
365
- # @param output_config [Google::Cloud::Vision::V1::OutputConfig | Hash]
365
+ # @param output_config [Google::Cloud::Vision::V1::OutputConfig, Hash]
366
366
  # Required. The desired output location and metadata (e.g. format).
367
367
  # @param parent [String]
368
368
  # Optional. Target project and location to make a call.
@@ -378,7 +378,6 @@ module Google
378
378
  #
379
379
  # Example: `projects/project-A/locations/eu`.
380
380
  #
381
- #
382
381
  # @yield [response, operation] Access the result along with the RPC operation
383
382
  # @yieldparam response [Gapic::Operation]
384
383
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -428,18 +427,21 @@ module Google
428
427
  # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
429
428
  #
430
429
  # @overload async_batch_annotate_files(request, options = nil)
431
- # @param request [Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest | Hash]
432
- # Run asynchronous image detection and annotation for a list of generic
433
- # files, such as PDF files, which may contain multiple pages and multiple
434
- # images per page. Progress and results can be retrieved through the
435
- # `google.longrunning.Operations` interface.
436
- # `Operation.metadata` contains `OperationMetadata` (metadata).
437
- # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
430
+ # Pass arguments to `async_batch_annotate_files` via a request object, either of type
431
+ # {Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest} or an equivalent Hash.
432
+ #
433
+ # @param request [Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest, Hash]
434
+ # A request object representing the call parameters. Required. To specify no
435
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
438
436
  # @param options [Gapic::CallOptions, Hash]
439
437
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
440
438
  #
441
439
  # @overload async_batch_annotate_files(requests: nil, parent: nil)
442
- # @param requests [Array<Google::Cloud::Vision::V1::AsyncAnnotateFileRequest | Hash>]
440
+ # Pass arguments to `async_batch_annotate_files` via keyword arguments. Note that at
441
+ # least one keyword argument is required. To specify no parameters, or to keep all
442
+ # the default parameter values, pass an empty Hash as a request object (see above).
443
+ #
444
+ # @param requests [Array<Google::Cloud::Vision::V1::AsyncAnnotateFileRequest, Hash>]
443
445
  # Required. Individual async file annotation requests for this batch.
444
446
  # @param parent [String]
445
447
  # Optional. Target project and location to make a call.
@@ -455,7 +457,6 @@ module Google
455
457
  #
456
458
  # Example: `projects/project-A/locations/eu`.
457
459
  #
458
- #
459
460
  # @yield [response, operation] Access the result along with the RPC operation
460
461
  # @yieldparam response [Gapic::Operation]
461
462
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -670,13 +671,3 @@ module Google
670
671
  end
671
672
  end
672
673
  end
673
-
674
- # rubocop:disable Lint/HandleExceptions
675
-
676
- # Once client is loaded, load helpers.rb if it exists.
677
- begin
678
- require "google/cloud/vision/v1/image_annotator/helpers"
679
- rescue LoadError
680
- end
681
-
682
- # rubocop:enable Lint/HandleExceptions
@@ -16,11 +16,7 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
19
  require "gapic/operation"
21
-
22
- require "google/cloud/vision/v1/version"
23
- require "google/cloud/vision/v1/image_annotator/client"
24
20
  require "google/longrunning/operations_pb"
25
21
 
26
22
  module Google
@@ -109,16 +105,20 @@ module Google
109
105
  # to use different resource name schemes, such as `users/*/operations`.
110
106
  #
111
107
  # @overload list_operations(request, options = nil)
112
- # @param request [Google::Longrunning::ListOperationsRequest | Hash]
113
- # Lists operations that match the specified filter in the request. If the
114
- # server doesn't support this method, it returns `UNIMPLEMENTED`.
108
+ # Pass arguments to `list_operations` via a request object, either of type
109
+ # {Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
115
110
  #
116
- # NOTE: the `name` binding below allows API services to override the binding
117
- # to use different resource name schemes, such as `users/*/operations`.
111
+ # @param request [Google::Longrunning::ListOperationsRequest, Hash]
112
+ # A request object representing the call parameters. Required. To specify no
113
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
118
114
  # @param options [Gapic::CallOptions, Hash]
119
115
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
120
116
  #
121
117
  # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
118
+ # Pass arguments to `list_operations` via keyword arguments. Note that at
119
+ # least one keyword argument is required. To specify no parameters, or to keep all
120
+ # the default parameter values, pass an empty Hash as a request object (see above).
121
+ #
122
122
  # @param name [String]
123
123
  # The name of the operation collection.
124
124
  # @param filter [String]
@@ -128,7 +128,6 @@ module Google
128
128
  # @param page_token [String]
129
129
  # The standard list page token.
130
130
  #
131
- #
132
131
  # @yield [response, operation] Access the result along with the RPC operation
133
132
  # @yieldparam response [Gapic::PagedEnumerable<Gapic::Operation>]
134
133
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -182,18 +181,23 @@ module Google
182
181
  # service.
183
182
  #
184
183
  # @overload get_operation(request, options = nil)
185
- # @param request [Google::Longrunning::GetOperationRequest | Hash]
186
- # Gets the latest state of a long-running operation. Clients can use this
187
- # method to poll the operation result at intervals as recommended by the API
188
- # service.
184
+ # Pass arguments to `get_operation` via a request object, either of type
185
+ # {Google::Longrunning::GetOperationRequest} or an equivalent Hash.
186
+ #
187
+ # @param request [Google::Longrunning::GetOperationRequest, Hash]
188
+ # A request object representing the call parameters. Required. To specify no
189
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
189
190
  # @param options [Gapic::CallOptions, Hash]
190
191
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
191
192
  #
192
193
  # @overload get_operation(name: nil)
194
+ # Pass arguments to `get_operation` via keyword arguments. Note that at
195
+ # least one keyword argument is required. To specify no parameters, or to keep all
196
+ # the default parameter values, pass an empty Hash as a request object (see above).
197
+ #
193
198
  # @param name [String]
194
199
  # The name of the operation resource.
195
200
  #
196
- #
197
201
  # @yield [response, operation] Access the result along with the RPC operation
198
202
  # @yieldparam response [Gapic::Operation]
199
203
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -247,19 +251,23 @@ module Google
247
251
  # `google.rpc.Code.UNIMPLEMENTED`.
248
252
  #
249
253
  # @overload delete_operation(request, options = nil)
250
- # @param request [Google::Longrunning::DeleteOperationRequest | Hash]
251
- # Deletes a long-running operation. This method indicates that the client is
252
- # no longer interested in the operation result. It does not cancel the
253
- # operation. If the server doesn't support this method, it returns
254
- # `google.rpc.Code.UNIMPLEMENTED`.
254
+ # Pass arguments to `delete_operation` via a request object, either of type
255
+ # {Google::Longrunning::DeleteOperationRequest} or an equivalent Hash.
256
+ #
257
+ # @param request [Google::Longrunning::DeleteOperationRequest, Hash]
258
+ # A request object representing the call parameters. Required. To specify no
259
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
255
260
  # @param options [Gapic::CallOptions, Hash]
256
261
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
257
262
  #
258
263
  # @overload delete_operation(name: nil)
264
+ # Pass arguments to `delete_operation` via keyword arguments. Note that at
265
+ # least one keyword argument is required. To specify no parameters, or to keep all
266
+ # the default parameter values, pass an empty Hash as a request object (see above).
267
+ #
259
268
  # @param name [String]
260
269
  # The name of the operation resource to be deleted.
261
270
  #
262
- #
263
271
  # @yield [response, operation] Access the result along with the RPC operation
264
272
  # @yieldparam response [Google::Protobuf::Empty]
265
273
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -318,25 +326,23 @@ module Google
318
326
  # corresponding to `Code.CANCELLED`.
319
327
  #
320
328
  # @overload cancel_operation(request, options = nil)
321
- # @param request [Google::Longrunning::CancelOperationRequest | Hash]
322
- # Starts asynchronous cancellation on a long-running operation. The server
323
- # makes a best effort to cancel the operation, but success is not
324
- # guaranteed. If the server doesn't support this method, it returns
325
- # `google.rpc.Code.UNIMPLEMENTED`. Clients can use
326
- # Operations.GetOperation or
327
- # other methods to check whether the cancellation succeeded or whether the
328
- # operation completed despite cancellation. On successful cancellation,
329
- # the operation is not deleted; instead, it becomes an operation with
330
- # an {Google::Longrunning::Operation#error Operation.error} value with a {Google::Rpc::Status#code google.rpc.Status.code} of 1,
331
- # corresponding to `Code.CANCELLED`.
329
+ # Pass arguments to `cancel_operation` via a request object, either of type
330
+ # {Google::Longrunning::CancelOperationRequest} or an equivalent Hash.
331
+ #
332
+ # @param request [Google::Longrunning::CancelOperationRequest, Hash]
333
+ # A request object representing the call parameters. Required. To specify no
334
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
332
335
  # @param options [Gapic::CallOptions, Hash]
333
336
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
334
337
  #
335
338
  # @overload cancel_operation(name: nil)
339
+ # Pass arguments to `cancel_operation` via keyword arguments. Note that at
340
+ # least one keyword argument is required. To specify no parameters, or to keep all
341
+ # the default parameter values, pass an empty Hash as a request object (see above).
342
+ #
336
343
  # @param name [String]
337
344
  # The name of the operation resource to be cancelled.
338
345
  #
339
- #
340
346
  # @yield [response, operation] Access the result along with the RPC operation
341
347
  # @yieldparam response [Google::Protobuf::Empty]
342
348
  # @yieldparam operation [GRPC::ActiveCall::Operation]