google-cloud-document_ai-v1 0.2.1 → 0.3.0
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 +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/README.md +1 -1
- data/lib/google/cloud/document_ai/v1/document_processor_service/client.rb +113 -48
- data/lib/google/cloud/document_ai/v1/document_processor_service/operations.rb +145 -33
- data/lib/google/cloud/document_ai/v1/version.rb +1 -1
- data/lib/google/cloud/documentai/v1/document_io_pb.rb +1 -1
- data/lib/google/cloud/documentai/v1/document_pb.rb +9 -3
- data/lib/google/cloud/documentai/v1/document_processor_service_pb.rb +3 -2
- data/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb +1 -1
- data/lib/google/cloud/documentai/v1/geometry_pb.rb +1 -1
- data/lib/google/cloud/documentai/v1/operation_metadata_pb.rb +2 -2
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/cloud/documentai/v1/document.rb +158 -81
- data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb +3 -0
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: db1b8b3e4a2a0e11379da959689aab8db44a9e531a7dab68763e71fba5cb4a8b
|
4
|
+
data.tar.gz: 4328522a4c2e5400b29affed08535e9dd13271113920ee8d9552a20a7cec2b5f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 14ac2abace39ad77e14fa79cd2621b1f62e89a313aca9cdfe8511591277bd078dd4680de95dac79c36c5157fda31fadde180c5f3eac51c74e0324633a04edebc
|
7
|
+
data.tar.gz: 3a7bc1163f4a53739ca45a393e57c975a1eb59858399104d51f02d21b41238fa2c1055938aef0a639fbc774fdb7f653137b0ae748a6754d91bc389a49cff2a71
|
data/.yardopts
CHANGED
data/AUTHENTICATION.md
CHANGED
@@ -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
|
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
|
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
|
-
|
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,
|
164
|
-
|
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
@@ -37,7 +37,7 @@ request = ::Google::Cloud::DocumentAI::V1::ProcessRequest.new # (request fields
|
|
37
37
|
response = client.process_document request
|
38
38
|
```
|
39
39
|
|
40
|
-
View the [Client Library Documentation](https://
|
40
|
+
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-document_ai-v1/latest)
|
41
41
|
for class and method documentation.
|
42
42
|
|
43
43
|
See also the [Product Documentation](https://cloud.google.com/document-ai/)
|
@@ -44,13 +44,12 @@ module Google
|
|
44
44
|
# See {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client::Configuration}
|
45
45
|
# for a description of the configuration fields.
|
46
46
|
#
|
47
|
-
#
|
47
|
+
# @example
|
48
48
|
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
# end
|
49
|
+
# # Modify the configuration for all DocumentProcessorService clients
|
50
|
+
# ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.configure do |config|
|
51
|
+
# config.timeout = 10.0
|
52
|
+
# end
|
54
53
|
#
|
55
54
|
# @yield [config] Configure the Client client.
|
56
55
|
# @yieldparam config [Client::Configuration]
|
@@ -112,19 +111,15 @@ module Google
|
|
112
111
|
##
|
113
112
|
# Create a new DocumentProcessorService client object.
|
114
113
|
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
# To create a new DocumentProcessorService client with the default
|
118
|
-
# configuration:
|
114
|
+
# @example
|
119
115
|
#
|
120
|
-
#
|
116
|
+
# # Create a client using the default configuration
|
117
|
+
# client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
|
121
118
|
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
# config.timeout = 10.0
|
127
|
-
# end
|
119
|
+
# # Create a client using a custom configuration
|
120
|
+
# client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new do |config|
|
121
|
+
# config.timeout = 10.0
|
122
|
+
# end
|
128
123
|
#
|
129
124
|
# @yield [config] Configure the DocumentProcessorService client.
|
130
125
|
# @yieldparam config [Client::Configuration]
|
@@ -144,10 +139,9 @@ module Google
|
|
144
139
|
|
145
140
|
# Create credentials
|
146
141
|
credentials = @config.credentials
|
147
|
-
# Use self-signed JWT if the
|
142
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
148
143
|
# but only if the default endpoint does not have a region prefix.
|
149
|
-
enable_self_signed_jwt = @config.
|
150
|
-
@config.endpoint == Client.configure.endpoint &&
|
144
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
151
145
|
!@config.endpoint.split(".").first.include?("-")
|
152
146
|
credentials ||= Credentials.default scope: @config.scope,
|
153
147
|
enable_self_signed_jwt: enable_self_signed_jwt
|
@@ -159,6 +153,7 @@ module Google
|
|
159
153
|
|
160
154
|
@operations_client = Operations.new do |config|
|
161
155
|
config.credentials = credentials
|
156
|
+
config.quota_project = @quota_project_id
|
162
157
|
config.endpoint = @config.endpoint
|
163
158
|
end
|
164
159
|
|
@@ -216,6 +211,21 @@ module Google
|
|
216
211
|
#
|
217
212
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
218
213
|
#
|
214
|
+
# @example Basic example
|
215
|
+
# require "google/cloud/document_ai/v1"
|
216
|
+
#
|
217
|
+
# # Create a client object. The client can be reused for multiple calls.
|
218
|
+
# client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
|
219
|
+
#
|
220
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
221
|
+
# request = Google::Cloud::DocumentAI::V1::ProcessRequest.new
|
222
|
+
#
|
223
|
+
# # Call the process_document method.
|
224
|
+
# result = client.process_document request
|
225
|
+
#
|
226
|
+
# # The returned object is of type Google::Cloud::DocumentAI::V1::ProcessResponse.
|
227
|
+
# p result
|
228
|
+
#
|
219
229
|
def process_document request, options = nil
|
220
230
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
221
231
|
|
@@ -233,16 +243,20 @@ module Google
|
|
233
243
|
gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
|
234
244
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
235
245
|
|
236
|
-
header_params = {
|
237
|
-
|
238
|
-
|
246
|
+
header_params = {}
|
247
|
+
if request.name
|
248
|
+
header_params["name"] = request.name
|
249
|
+
end
|
250
|
+
|
239
251
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
240
252
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
241
253
|
|
242
254
|
options.apply_defaults timeout: @config.rpcs.process_document.timeout,
|
243
255
|
metadata: metadata,
|
244
256
|
retry_policy: @config.rpcs.process_document.retry_policy
|
245
|
-
|
257
|
+
|
258
|
+
options.apply_defaults timeout: @config.timeout,
|
259
|
+
metadata: @config.metadata,
|
246
260
|
retry_policy: @config.retry_policy
|
247
261
|
|
248
262
|
@document_processor_service_stub.call_rpc :process_document, request, options: options do |response, operation|
|
@@ -290,6 +304,28 @@ module Google
|
|
290
304
|
#
|
291
305
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
292
306
|
#
|
307
|
+
# @example Basic example
|
308
|
+
# require "google/cloud/document_ai/v1"
|
309
|
+
#
|
310
|
+
# # Create a client object. The client can be reused for multiple calls.
|
311
|
+
# client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
|
312
|
+
#
|
313
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
314
|
+
# request = Google::Cloud::DocumentAI::V1::BatchProcessRequest.new
|
315
|
+
#
|
316
|
+
# # Call the batch_process_documents method.
|
317
|
+
# result = client.batch_process_documents request
|
318
|
+
#
|
319
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
320
|
+
# # object to check the status of an operation, cancel it, or wait
|
321
|
+
# # for results. Here is how to block until completion:
|
322
|
+
# result.wait_until_done! timeout: 60
|
323
|
+
# if result.response?
|
324
|
+
# p result.response
|
325
|
+
# else
|
326
|
+
# puts "Error!"
|
327
|
+
# end
|
328
|
+
#
|
293
329
|
def batch_process_documents request, options = nil
|
294
330
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
295
331
|
|
@@ -307,16 +343,20 @@ module Google
|
|
307
343
|
gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
|
308
344
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
309
345
|
|
310
|
-
header_params = {
|
311
|
-
|
312
|
-
|
346
|
+
header_params = {}
|
347
|
+
if request.name
|
348
|
+
header_params["name"] = request.name
|
349
|
+
end
|
350
|
+
|
313
351
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
314
352
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
315
353
|
|
316
354
|
options.apply_defaults timeout: @config.rpcs.batch_process_documents.timeout,
|
317
355
|
metadata: metadata,
|
318
356
|
retry_policy: @config.rpcs.batch_process_documents.retry_policy
|
319
|
-
|
357
|
+
|
358
|
+
options.apply_defaults timeout: @config.timeout,
|
359
|
+
metadata: @config.metadata,
|
320
360
|
retry_policy: @config.retry_policy
|
321
361
|
|
322
362
|
@document_processor_service_stub.call_rpc :batch_process_documents, request, options: options do |response, operation|
|
@@ -365,6 +405,28 @@ module Google
|
|
365
405
|
#
|
366
406
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
367
407
|
#
|
408
|
+
# @example Basic example
|
409
|
+
# require "google/cloud/document_ai/v1"
|
410
|
+
#
|
411
|
+
# # Create a client object. The client can be reused for multiple calls.
|
412
|
+
# client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
|
413
|
+
#
|
414
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
415
|
+
# request = Google::Cloud::DocumentAI::V1::ReviewDocumentRequest.new
|
416
|
+
#
|
417
|
+
# # Call the review_document method.
|
418
|
+
# result = client.review_document request
|
419
|
+
#
|
420
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
421
|
+
# # object to check the status of an operation, cancel it, or wait
|
422
|
+
# # for results. Here is how to block until completion:
|
423
|
+
# result.wait_until_done! timeout: 60
|
424
|
+
# if result.response?
|
425
|
+
# p result.response
|
426
|
+
# else
|
427
|
+
# puts "Error!"
|
428
|
+
# end
|
429
|
+
#
|
368
430
|
def review_document request, options = nil
|
369
431
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
370
432
|
|
@@ -382,16 +444,20 @@ module Google
|
|
382
444
|
gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
|
383
445
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
384
446
|
|
385
|
-
header_params = {
|
386
|
-
|
387
|
-
|
447
|
+
header_params = {}
|
448
|
+
if request.human_review_config
|
449
|
+
header_params["human_review_config"] = request.human_review_config
|
450
|
+
end
|
451
|
+
|
388
452
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
389
453
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
390
454
|
|
391
455
|
options.apply_defaults timeout: @config.rpcs.review_document.timeout,
|
392
456
|
metadata: metadata,
|
393
457
|
retry_policy: @config.rpcs.review_document.retry_policy
|
394
|
-
|
458
|
+
|
459
|
+
options.apply_defaults timeout: @config.timeout,
|
460
|
+
metadata: @config.metadata,
|
395
461
|
retry_policy: @config.retry_policy
|
396
462
|
|
397
463
|
@document_processor_service_stub.call_rpc :review_document, request, options: options do |response, operation|
|
@@ -416,22 +482,21 @@ module Google
|
|
416
482
|
# Configuration can be applied globally to all clients, or to a single client
|
417
483
|
# on construction.
|
418
484
|
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
422
|
-
# to 20 seconds,
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
428
|
-
#
|
429
|
-
#
|
430
|
-
#
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
434
|
-
# end
|
485
|
+
# @example
|
486
|
+
#
|
487
|
+
# # Modify the global config, setting the timeout for
|
488
|
+
# # process_document to 20 seconds,
|
489
|
+
# # and all remaining timeouts to 10 seconds.
|
490
|
+
# ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.configure do |config|
|
491
|
+
# config.timeout = 10.0
|
492
|
+
# config.rpcs.process_document.timeout = 20.0
|
493
|
+
# end
|
494
|
+
#
|
495
|
+
# # Apply the above configuration only to a new client.
|
496
|
+
# client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new do |config|
|
497
|
+
# config.timeout = 10.0
|
498
|
+
# config.rpcs.process_document.timeout = 20.0
|
499
|
+
# end
|
435
500
|
#
|
436
501
|
# @!attribute [rw] endpoint
|
437
502
|
# The hostname or hostname:port of the service endpoint.
|
@@ -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::DocumentAI::V1::VERSION
|
161
182
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
162
183
|
|
163
|
-
header_params = {
|
164
|
-
|
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
|
-
|
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::DocumentAI::V1::VERSION
|
231
278
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
232
279
|
|
233
|
-
header_params = {
|
234
|
-
|
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
|
-
|
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::DocumentAI::V1::VERSION
|
301
367
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
302
368
|
|
303
|
-
header_params = {
|
304
|
-
|
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
|
-
|
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::DocumentAI::V1::VERSION
|
376
461
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
377
462
|
|
378
|
-
header_params = {
|
379
|
-
|
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
|
-
|
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|
|
@@ -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
|
-
|
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
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
# to 20 seconds,
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
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,9 +1,9 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/documentai/v1/document_io.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/documentai/v1/document_io.proto", :syntax => :proto3) do
|
9
9
|
add_message "google.cloud.documentai.v1.RawDocument" do
|