google-cloud-vision-v1p3beta1 0.5.1 → 0.5.5

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cf4bd38e66f18259d80c85744d74fab27496876b86cdc51cd1093dcf4206c3c5
4
- data.tar.gz: 708f2b27cbb5ec761b68ea77e8634ead7539d3ce04313afa81f903122db5712a
3
+ metadata.gz: 124b0c0f4aaf391ca102e9ea61c5be2bbdb850d1dab00f1f15abfa90c3e088e0
4
+ data.tar.gz: 192d426aecc150c16d53f5f50ed0f629c24437fd57dade4e6fbd1ea81227cd69
5
5
  SHA512:
6
- metadata.gz: 81a8f6e3ee14ac83d9d9e2321d52a8cc8f4dedd3475c89ac6111c27f4a631532eb645276a96ce53e3a588f1a67f79a7320ac6d056d744faa8e162b92e6e028f2
7
- data.tar.gz: 52ea21c88af31c603e5ea104b3afff032dedb7aa3242d5d6c807607ffbbbe3286f1e0282179c7965b3555dbd95aac988803d2d3f9dddcbefa5dd0bb4075d3f42
6
+ metadata.gz: bcda433755b4b676c7bc90d76cc1c4da4b74be91bddea2dc3bca67efd159f17c7b8eb6251d911f1c777ab68a3b570677e79d3092b5ea575b953b574c52966bc6
7
+ data.tar.gz: 78cd4fa0be225d36f9815ae1ff0efb9a78345dba95821ca4137ce8e754b102a67f38b46c2f12ba5f8f719ce4065526c9f001ad3868304c8e9da2fe2798d722d5
data/.yardopts CHANGED
@@ -1,5 +1,5 @@
1
1
  --no-private
2
- --title=Cloud Vision V1p3beta1 API
2
+ --title="Cloud Vision V1p3beta1 API"
3
3
  --exclude _pb\.rb$
4
4
  --markup markdown
5
5
  --markup-provider redcarpet
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-vision-v1p3beta1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::Vision::V1p3beta1::ProductSearch::Credentials}):
68
68
 
69
- 1. `VISION_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `VISION_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `VISION_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `VISION_KEYFILE` - Path to JSON file, or JSON contents
71
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
74
74
 
75
75
  ```ruby
76
76
  require "google/cloud/vision/v1p3beta1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new
82
82
 
83
83
  ### Configuration
84
84
 
85
- The **Credentials JSON** can be configured instead of placing them in
86
- environment variables. Either on an individual client initialization:
85
+ The path to the **Credentials JSON** file can be configured instead of storing
86
+ it in an environment variable. Either on an individual client initialization:
87
87
 
88
88
  ```ruby
89
89
  require "google/cloud/vision/v1p3beta1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new do |confi
93
93
  end
94
94
  ```
95
95
 
96
- Or configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/vision/v1p3beta1"
@@ -120,15 +120,6 @@ To configure your system for this, simply:
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
121
  *should* only be used during development.
122
122
 
123
- [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
124
- [dev-console]: https://console.cloud.google.com/project
125
-
126
- [enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
127
-
128
- [create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
129
- [create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
130
- [reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
131
-
132
123
  ## Creating a Service Account
133
124
 
134
125
  Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
139
130
  [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
131
  need a Google Developers service account.
141
132
 
142
- 1. Visit the [Google Developers Console][dev-console].
133
+ 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
143
134
  2. Create a new project or click on an existing project.
144
- 3. Activate the slide-out navigation tray and select **API Manager**. From
135
+ 3. Activate the menu in the upper left and select **APIs & Services**. From
145
136
  here, you will enable the APIs that your application requires.
146
137
 
147
- ![Enable the APIs that your application requires][enable-apis]
148
-
149
138
  *Note: You may need to enable billing in order to use these services.*
150
139
 
151
140
  4. Select **Credentials** from the side navigation.
152
141
 
153
- You should see a screen like one of the following.
154
-
155
- ![Create a new service account][create-new-service-account]
156
-
157
- ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
158
-
159
- Find the "Add credentials" drop down and select "Service account" to be
160
- guided through downloading a new JSON key file.
142
+ Find the "Create credentials" drop down near the top of the page, and select
143
+ "Service account" to be guided through downloading a new JSON key file.
161
144
 
162
145
  If you want to re-use an existing service account, you can easily generate a
163
- new key file. Just select the account you wish to re-use, and click "Generate
164
- new JSON key":
165
-
166
- ![Re-use an existing service account][reuse-service-account]
146
+ new key file. Just select the account you wish to re-use, click the pencil
147
+ tool on the right side to edit the service account, select the **Keys** tab,
148
+ and then select **Add Key**.
167
149
 
168
150
  The key file you download will be used by this library to authenticate API
169
151
  requests and should be stored in a secure location.
data/README.md CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/vision/v1p3beta1"
34
34
 
35
35
  client = ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::Vision::V1p3beta1::CreateProductSetRequest.new # (request fields as keyword arguments...)
37
37
  response = client.create_product_set request
38
38
  ```
39
39
 
@@ -1,9 +1,9 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/vision/v1p3beta1/geometry.proto
3
3
 
4
+ require 'google/api/annotations_pb'
4
5
  require 'google/protobuf'
5
6
 
6
- require 'google/api/annotations_pb'
7
7
  Google::Protobuf::DescriptorPool.generated_pool.build do
8
8
  add_file("google/cloud/vision/v1p3beta1/geometry.proto", :syntax => :proto3) do
9
9
  add_message "google.cloud.vision.v1p3beta1.Vertex" do
@@ -43,13 +43,12 @@ module Google
43
43
  # See {::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client::Configuration}
44
44
  # for a description of the configuration fields.
45
45
  #
46
- # ## Example
46
+ # @example
47
47
  #
48
- # To modify the configuration for all ImageAnnotator clients:
49
- #
50
- # ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.configure do |config|
51
- # config.timeout = 10.0
52
- # end
48
+ # # Modify the configuration for all ImageAnnotator clients
49
+ # ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.configure do |config|
50
+ # config.timeout = 10.0
51
+ # end
53
52
  #
54
53
  # @yield [config] Configure the Client client.
55
54
  # @yieldparam config [Client::Configuration]
@@ -69,18 +68,12 @@ module Google
69
68
 
70
69
  default_config.rpcs.batch_annotate_images.timeout = 600.0
71
70
  default_config.rpcs.batch_annotate_images.retry_policy = {
72
- initial_delay: 0.1,
73
- max_delay: 60.0,
74
- multiplier: 1.3,
75
- retry_codes: [14, 4]
71
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
76
72
  }
77
73
 
78
74
  default_config.rpcs.async_batch_annotate_files.timeout = 600.0
79
75
  default_config.rpcs.async_batch_annotate_files.retry_policy = {
80
- initial_delay: 0.1,
81
- max_delay: 60.0,
82
- multiplier: 1.3,
83
- retry_codes: []
76
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: []
84
77
  }
85
78
 
86
79
  default_config
@@ -112,19 +105,15 @@ module Google
112
105
  ##
113
106
  # Create a new ImageAnnotator client object.
114
107
  #
115
- # ## Examples
116
- #
117
- # To create a new ImageAnnotator client with the default
118
- # configuration:
119
- #
120
- # client = ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.new
108
+ # @example
121
109
  #
122
- # To create a new ImageAnnotator client with a custom
123
- # configuration:
110
+ # # Create a client using the default configuration
111
+ # client = ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.new
124
112
  #
125
- # client = ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.new do |config|
126
- # config.timeout = 10.0
127
- # end
113
+ # # Create a client using a custom configuration
114
+ # client = ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.new do |config|
115
+ # config.timeout = 10.0
116
+ # end
128
117
  #
129
118
  # @yield [config] Configure the ImageAnnotator client.
130
119
  # @yieldparam config [Client::Configuration]
@@ -144,14 +133,13 @@ module Google
144
133
 
145
134
  # Create credentials
146
135
  credentials = @config.credentials
147
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
136
+ # Use self-signed JWT if the endpoint is unchanged from default,
148
137
  # but only if the default endpoint does not have a region prefix.
149
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
150
- @config.endpoint == Client.configure.endpoint &&
138
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
151
139
  !@config.endpoint.split(".").first.include?("-")
152
140
  credentials ||= Credentials.default scope: @config.scope,
153
141
  enable_self_signed_jwt: enable_self_signed_jwt
154
- if credentials.is_a?(String) || credentials.is_a?(Hash)
142
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
155
143
  credentials = Credentials.new credentials, scope: @config.scope
156
144
  end
157
145
  @quota_project_id = @config.quota_project
@@ -159,6 +147,7 @@ module Google
159
147
 
160
148
  @operations_client = Operations.new do |config|
161
149
  config.credentials = credentials
150
+ config.quota_project = @quota_project_id
162
151
  config.endpoint = @config.endpoint
163
152
  end
164
153
 
@@ -209,6 +198,21 @@ module Google
209
198
  #
210
199
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
211
200
  #
201
+ # @example Basic example
202
+ # require "google/cloud/vision/v1p3beta1"
203
+ #
204
+ # # Create a client object. The client can be reused for multiple calls.
205
+ # client = Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.new
206
+ #
207
+ # # Create a request. To set request fields, pass in keyword arguments.
208
+ # request = Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesRequest.new
209
+ #
210
+ # # Call the batch_annotate_images method.
211
+ # result = client.batch_annotate_images request
212
+ #
213
+ # # The returned object is of type Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesResponse.
214
+ # p result
215
+ #
212
216
  def batch_annotate_images request, options = nil
213
217
  raise ::ArgumentError, "request must be provided" if request.nil?
214
218
 
@@ -229,7 +233,9 @@ module Google
229
233
  options.apply_defaults timeout: @config.rpcs.batch_annotate_images.timeout,
230
234
  metadata: metadata,
231
235
  retry_policy: @config.rpcs.batch_annotate_images.retry_policy
232
- options.apply_defaults metadata: @config.metadata,
236
+
237
+ options.apply_defaults timeout: @config.timeout,
238
+ metadata: @config.metadata,
233
239
  retry_policy: @config.retry_policy
234
240
 
235
241
  @image_annotator_stub.call_rpc :batch_annotate_images, request, options: options do |response, operation|
@@ -274,6 +280,28 @@ module Google
274
280
  #
275
281
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
276
282
  #
283
+ # @example Basic example
284
+ # require "google/cloud/vision/v1p3beta1"
285
+ #
286
+ # # Create a client object. The client can be reused for multiple calls.
287
+ # client = Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.new
288
+ #
289
+ # # Create a request. To set request fields, pass in keyword arguments.
290
+ # request = Google::Cloud::Vision::V1p3beta1::AsyncBatchAnnotateFilesRequest.new
291
+ #
292
+ # # Call the async_batch_annotate_files method.
293
+ # result = client.async_batch_annotate_files request
294
+ #
295
+ # # The returned object is of type Gapic::Operation. You can use this
296
+ # # object to check the status of an operation, cancel it, or wait
297
+ # # for results. Here is how to block until completion:
298
+ # result.wait_until_done! timeout: 60
299
+ # if result.response?
300
+ # p result.response
301
+ # else
302
+ # puts "Error!"
303
+ # end
304
+ #
277
305
  def async_batch_annotate_files request, options = nil
278
306
  raise ::ArgumentError, "request must be provided" if request.nil?
279
307
 
@@ -294,7 +322,9 @@ module Google
294
322
  options.apply_defaults timeout: @config.rpcs.async_batch_annotate_files.timeout,
295
323
  metadata: metadata,
296
324
  retry_policy: @config.rpcs.async_batch_annotate_files.retry_policy
297
- options.apply_defaults metadata: @config.metadata,
325
+
326
+ options.apply_defaults timeout: @config.timeout,
327
+ metadata: @config.metadata,
298
328
  retry_policy: @config.retry_policy
299
329
 
300
330
  @image_annotator_stub.call_rpc :async_batch_annotate_files, request, options: options do |response, operation|
@@ -319,22 +349,21 @@ module Google
319
349
  # Configuration can be applied globally to all clients, or to a single client
320
350
  # on construction.
321
351
  #
322
- # # Examples
323
- #
324
- # To modify the global config, setting the timeout for batch_annotate_images
325
- # to 20 seconds, and all remaining timeouts to 10 seconds:
326
- #
327
- # ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.configure do |config|
328
- # config.timeout = 10.0
329
- # config.rpcs.batch_annotate_images.timeout = 20.0
330
- # end
331
- #
332
- # To apply the above configuration only to a new client:
333
- #
334
- # client = ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.new do |config|
335
- # config.timeout = 10.0
336
- # config.rpcs.batch_annotate_images.timeout = 20.0
337
- # end
352
+ # @example
353
+ #
354
+ # # Modify the global config, setting the timeout for
355
+ # # batch_annotate_images to 20 seconds,
356
+ # # and all remaining timeouts to 10 seconds.
357
+ # ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.configure do |config|
358
+ # config.timeout = 10.0
359
+ # config.rpcs.batch_annotate_images.timeout = 20.0
360
+ # end
361
+ #
362
+ # # Apply the above configuration only to a new client.
363
+ # client = ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.new do |config|
364
+ # config.timeout = 10.0
365
+ # config.rpcs.batch_annotate_images.timeout = 20.0
366
+ # end
338
367
  #
339
368
  # @!attribute [rw] endpoint
340
369
  # The hostname or hostname:port of the service endpoint.
@@ -82,7 +82,7 @@ module Google
82
82
  # Create credentials
83
83
  credentials = @config.credentials
84
84
  credentials ||= Credentials.default scope: @config.scope
85
- if credentials.is_a?(String) || credentials.is_a?(Hash)
85
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
86
86
  credentials = Credentials.new credentials, scope: @config.scope
87
87
  end
88
88
  @quota_project_id = @config.quota_project
@@ -143,6 +143,27 @@ module Google
143
143
  #
144
144
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
145
  #
146
+ # @example Basic example
147
+ # require "google/longrunning"
148
+ #
149
+ # # Create a client object. The client can be reused for multiple calls.
150
+ # client = Google::Longrunning::Operations::Client.new
151
+ #
152
+ # # Create a request. To set request fields, pass in keyword arguments.
153
+ # request = Google::Longrunning::ListOperationsRequest.new
154
+ #
155
+ # # Call the list_operations method.
156
+ # result = client.list_operations request
157
+ #
158
+ # # The returned object is of type Gapic::PagedEnumerable. You can
159
+ # # iterate over all elements by calling #each, and the enumerable
160
+ # # will lazily make API calls to fetch subsequent pages. Other
161
+ # # methods are also available for managing paging directly.
162
+ # result.each do |response|
163
+ # # Each element is of type ::Google::Longrunning::Operation.
164
+ # p response
165
+ # end
166
+ #
146
167
  def list_operations request, options = nil
147
168
  raise ::ArgumentError, "request must be provided" if request.nil?
148
169
 
@@ -160,16 +181,20 @@ module Google
160
181
  gapic_version: ::Google::Cloud::Vision::V1p3beta1::VERSION
161
182
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
162
183
 
163
- header_params = {
164
- "name" => request.name
165
- }
184
+ header_params = {}
185
+ if request.name
186
+ header_params["name"] = request.name
187
+ end
188
+
166
189
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
167
190
  metadata[:"x-goog-request-params"] ||= request_params_header
168
191
 
169
192
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
170
193
  metadata: metadata,
171
194
  retry_policy: @config.rpcs.list_operations.retry_policy
172
- options.apply_defaults metadata: @config.metadata,
195
+
196
+ options.apply_defaults timeout: @config.timeout,
197
+ metadata: @config.metadata,
173
198
  retry_policy: @config.retry_policy
174
199
 
175
200
  @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -213,6 +238,28 @@ module Google
213
238
  #
214
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
215
240
  #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use this
254
+ # # object to check the status of an operation, cancel it, or wait
255
+ # # for results. Here is how to block until completion:
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "Error!"
261
+ # end
262
+ #
216
263
  def get_operation request, options = nil
217
264
  raise ::ArgumentError, "request must be provided" if request.nil?
218
265
 
@@ -230,16 +277,20 @@ module Google
230
277
  gapic_version: ::Google::Cloud::Vision::V1p3beta1::VERSION
231
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
232
279
 
233
- header_params = {
234
- "name" => request.name
235
- }
280
+ header_params = {}
281
+ if request.name
282
+ header_params["name"] = request.name
283
+ end
284
+
236
285
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
237
286
  metadata[:"x-goog-request-params"] ||= request_params_header
238
287
 
239
288
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
240
289
  metadata: metadata,
241
290
  retry_policy: @config.rpcs.get_operation.retry_policy
242
- options.apply_defaults metadata: @config.metadata,
291
+
292
+ options.apply_defaults timeout: @config.timeout,
293
+ metadata: @config.metadata,
243
294
  retry_policy: @config.retry_policy
244
295
 
245
296
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -283,6 +334,21 @@ module Google
283
334
  #
284
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
285
336
  #
337
+ # @example Basic example
338
+ # require "google/longrunning"
339
+ #
340
+ # # Create a client object. The client can be reused for multiple calls.
341
+ # client = Google::Longrunning::Operations::Client.new
342
+ #
343
+ # # Create a request. To set request fields, pass in keyword arguments.
344
+ # request = Google::Longrunning::DeleteOperationRequest.new
345
+ #
346
+ # # Call the delete_operation method.
347
+ # result = client.delete_operation request
348
+ #
349
+ # # The returned object is of type Google::Protobuf::Empty.
350
+ # p result
351
+ #
286
352
  def delete_operation request, options = nil
287
353
  raise ::ArgumentError, "request must be provided" if request.nil?
288
354
 
@@ -300,16 +366,20 @@ module Google
300
366
  gapic_version: ::Google::Cloud::Vision::V1p3beta1::VERSION
301
367
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
302
368
 
303
- header_params = {
304
- "name" => request.name
305
- }
369
+ header_params = {}
370
+ if request.name
371
+ header_params["name"] = request.name
372
+ end
373
+
306
374
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
307
375
  metadata[:"x-goog-request-params"] ||= request_params_header
308
376
 
309
377
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
310
378
  metadata: metadata,
311
379
  retry_policy: @config.rpcs.delete_operation.retry_policy
312
- options.apply_defaults metadata: @config.metadata,
380
+
381
+ options.apply_defaults timeout: @config.timeout,
382
+ metadata: @config.metadata,
313
383
  retry_policy: @config.retry_policy
314
384
 
315
385
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -358,6 +428,21 @@ module Google
358
428
  #
359
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
360
430
  #
431
+ # @example Basic example
432
+ # require "google/longrunning"
433
+ #
434
+ # # Create a client object. The client can be reused for multiple calls.
435
+ # client = Google::Longrunning::Operations::Client.new
436
+ #
437
+ # # Create a request. To set request fields, pass in keyword arguments.
438
+ # request = Google::Longrunning::CancelOperationRequest.new
439
+ #
440
+ # # Call the cancel_operation method.
441
+ # result = client.cancel_operation request
442
+ #
443
+ # # The returned object is of type Google::Protobuf::Empty.
444
+ # p result
445
+ #
361
446
  def cancel_operation request, options = nil
362
447
  raise ::ArgumentError, "request must be provided" if request.nil?
363
448
 
@@ -375,16 +460,20 @@ module Google
375
460
  gapic_version: ::Google::Cloud::Vision::V1p3beta1::VERSION
376
461
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
377
462
 
378
- header_params = {
379
- "name" => request.name
380
- }
463
+ header_params = {}
464
+ if request.name
465
+ header_params["name"] = request.name
466
+ end
467
+
381
468
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
382
469
  metadata[:"x-goog-request-params"] ||= request_params_header
383
470
 
384
471
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
385
472
  metadata: metadata,
386
473
  retry_policy: @config.rpcs.cancel_operation.retry_policy
387
- options.apply_defaults metadata: @config.metadata,
474
+
475
+ options.apply_defaults timeout: @config.timeout,
476
+ metadata: @config.metadata,
388
477
  retry_policy: @config.retry_policy
389
478
 
390
479
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -396,9 +485,9 @@ module Google
396
485
  end
397
486
 
398
487
  ##
399
- # Waits for the specified long-running operation until it is done or reaches
400
- # at most a specified timeout, returning the latest state. If the operation
401
- # is already done, the latest state is immediately returned. If the timeout
488
+ # Waits until the specified long-running operation is done or reaches at most
489
+ # a specified timeout, returning the latest state. If the operation is
490
+ # already done, the latest state is immediately returned. If the timeout
402
491
  # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
403
492
  # timeout is used. If the server does not support this method, it returns
404
493
  # `google.rpc.Code.UNIMPLEMENTED`.
@@ -436,6 +525,28 @@ module Google
436
525
  #
437
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
438
527
  #
528
+ # @example Basic example
529
+ # require "google/longrunning"
530
+ #
531
+ # # Create a client object. The client can be reused for multiple calls.
532
+ # client = Google::Longrunning::Operations::Client.new
533
+ #
534
+ # # Create a request. To set request fields, pass in keyword arguments.
535
+ # request = Google::Longrunning::WaitOperationRequest.new
536
+ #
537
+ # # Call the wait_operation method.
538
+ # result = client.wait_operation request
539
+ #
540
+ # # The returned object is of type Gapic::Operation. You can use this
541
+ # # object to check the status of an operation, cancel it, or wait
542
+ # # for results. Here is how to block until completion:
543
+ # result.wait_until_done! timeout: 60
544
+ # if result.response?
545
+ # p result.response
546
+ # else
547
+ # puts "Error!"
548
+ # end
549
+ #
439
550
  def wait_operation request, options = nil
440
551
  raise ::ArgumentError, "request must be provided" if request.nil?
441
552
 
@@ -456,7 +567,9 @@ module Google
456
567
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
568
  metadata: metadata,
458
569
  retry_policy: @config.rpcs.wait_operation.retry_policy
459
- options.apply_defaults metadata: @config.metadata,
570
+
571
+ options.apply_defaults timeout: @config.timeout,
572
+ metadata: @config.metadata,
460
573
  retry_policy: @config.retry_policy
461
574
 
462
575
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +594,21 @@ module Google
481
594
  # Configuration can be applied globally to all clients, or to a single client
482
595
  # on construction.
483
596
  #
484
- # # Examples
485
- #
486
- # To modify the global config, setting the timeout for list_operations
487
- # to 20 seconds, and all remaining timeouts to 10 seconds:
488
- #
489
- # ::Google::Longrunning::Operations::Client.configure do |config|
490
- # config.timeout = 10.0
491
- # config.rpcs.list_operations.timeout = 20.0
492
- # end
493
- #
494
- # To apply the above configuration only to a new client:
495
- #
496
- # client = ::Google::Longrunning::Operations::Client.new do |config|
497
- # config.timeout = 10.0
498
- # config.rpcs.list_operations.timeout = 20.0
499
- # end
597
+ # @example
598
+ #
599
+ # # Modify the global config, setting the timeout for
600
+ # # list_operations to 20 seconds,
601
+ # # and all remaining timeouts to 10 seconds.
602
+ # ::Google::Longrunning::Operations::Client.configure do |config|
603
+ # config.timeout = 10.0
604
+ # config.rpcs.list_operations.timeout = 20.0
605
+ # end
606
+ #
607
+ # # Apply the above configuration only to a new client.
608
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
609
+ # config.timeout = 10.0
610
+ # config.rpcs.list_operations.timeout = 20.0
611
+ # end
500
612
  #
501
613
  # @!attribute [rw] endpoint
502
614
  # The hostname or hostname:port of the service endpoint.
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/vision/v1p3beta1/image_annotator.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/api/field_behavior_pb'
@@ -15,6 +13,8 @@ require 'google/protobuf/timestamp_pb'
15
13
  require 'google/rpc/status_pb'
16
14
  require 'google/type/color_pb'
17
15
  require 'google/type/latlng_pb'
16
+ require 'google/protobuf'
17
+
18
18
  Google::Protobuf::DescriptorPool.generated_pool.build do
19
19
  add_file("google/cloud/vision/v1p3beta1/image_annotator.proto", :syntax => :proto3) do
20
20
  add_message "google.cloud.vision.v1p3beta1.Feature" do