google-cloud-dataproc-v1 0.3.2 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +64 -0
- data/lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb +7 -1
- data/lib/google/cloud/dataproc/v1/cluster_controller/client.rb +7 -1
- data/lib/google/cloud/dataproc/v1/cluster_controller/operations.rb +88 -3
- data/lib/google/cloud/dataproc/v1/job_controller/client.rb +7 -1
- data/lib/google/cloud/dataproc/v1/job_controller/operations.rb +88 -3
- data/lib/google/cloud/dataproc/v1/version.rb +1 -1
- data/lib/google/cloud/dataproc/v1/workflow_template_service/client.rb +7 -1
- data/lib/google/cloud/dataproc/v1/workflow_template_service/operations.rb +88 -3
- data/proto_docs/google/api/field_behavior.rb +6 -0
- data/proto_docs/google/longrunning/operations.rb +17 -3
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- metadata +6 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3a52ce94bdae1f76062be290ebebc5edc5c0732aac76c4a339564aaa92af6d13
|
|
4
|
+
data.tar.gz: a9e12b96f312e6167d6c07df02f919bbb814350ddcafbd2c950df90528e2a13b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4b8cf8f4b5f30eabd11527e5115e519b48f9c847f9345ed6185a30669a379c958b87afd7318dfac4865a80c1dfcda7111bd2323d36e3695c9cac826b98ad9495
|
|
7
|
+
data.tar.gz: 42c03da8d54c388ced1cf4ff18036994ae7991d603c57705604f27008c601c1badfdfcf78c2af11801164f35de95d285298b0722b4f06e72ed6c6158af577ff6
|
data/README.md
CHANGED
|
@@ -6,6 +6,12 @@ Manages Hadoop-based clusters and jobs on Google Cloud Platform.
|
|
|
6
6
|
|
|
7
7
|
https://github.com/googleapis/google-cloud-ruby
|
|
8
8
|
|
|
9
|
+
This gem is a _versioned_ client. It provides basic client classes for a
|
|
10
|
+
specific version of the Cloud Dataproc V1 API. Most users should consider using
|
|
11
|
+
the main client gem,
|
|
12
|
+
[google-cloud-dataproc](https://rubygems.org/gems/google-cloud-dataproc).
|
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
|
14
|
+
|
|
9
15
|
## Installation
|
|
10
16
|
|
|
11
17
|
```
|
|
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
|
|
|
73
79
|
and later. Older versions of Ruby _may_ still work, but are unsupported and not
|
|
74
80
|
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
|
75
81
|
about the Ruby support schedule.
|
|
82
|
+
|
|
83
|
+
## Which client should I use?
|
|
84
|
+
|
|
85
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
|
86
|
+
client library with a name such as `google-cloud-dataproc`,
|
|
87
|
+
and lower-level _versioned_ client libraries with names such as
|
|
88
|
+
`google-cloud-dataproc-v1`.
|
|
89
|
+
_In most cases, you should install the main client._
|
|
90
|
+
|
|
91
|
+
### What's the difference between the main client and a versioned client?
|
|
92
|
+
|
|
93
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
|
94
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
|
95
|
+
versions, there might be a separate versioned client for each service version.)
|
|
96
|
+
Most versioned clients are written and maintained by a code generator.
|
|
97
|
+
|
|
98
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
|
99
|
+
interfaces for the service. There will be only one main client for any given
|
|
100
|
+
service, even a service with multiple versions. The main client includes
|
|
101
|
+
factory methods for constructing the client objects we recommend for most
|
|
102
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
|
103
|
+
client; in other cases, they will be handwritten higher-level client objects
|
|
104
|
+
with additional capabilities, convenience methods, or best practices built in.
|
|
105
|
+
Generally, the main client will default to a recommended service version,
|
|
106
|
+
although in some cases you can override this if you need to talk to a specific
|
|
107
|
+
service version.
|
|
108
|
+
|
|
109
|
+
### Why would I want to use the main client?
|
|
110
|
+
|
|
111
|
+
We recommend that most users install the main client gem for a service. You can
|
|
112
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
|
113
|
+
`google-cloud-dataproc`.
|
|
114
|
+
The main client is recommended because it will embody the best practices for
|
|
115
|
+
accessing the service, and may also provide more convenient interfaces or
|
|
116
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
|
117
|
+
documentation and samples published by Google will generally demonstrate use of
|
|
118
|
+
the main client.
|
|
119
|
+
|
|
120
|
+
### Why would I want to use a versioned client?
|
|
121
|
+
|
|
122
|
+
You can use a versioned client if you are content with a possibly lower-level
|
|
123
|
+
class interface, you explicitly want to avoid features provided by the main
|
|
124
|
+
client, or you want to access a specific service version not be covered by the
|
|
125
|
+
main client. You can identify versioned client gems because the service version
|
|
126
|
+
is part of the name, e.g. `google-cloud-dataproc-v1`.
|
|
127
|
+
|
|
128
|
+
### What about the google-apis-<name> clients?
|
|
129
|
+
|
|
130
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
|
131
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
|
132
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
|
133
|
+
not offer the same performance, features, and ease of use provided by more
|
|
134
|
+
modern clients.
|
|
135
|
+
|
|
136
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
|
137
|
+
might need to use one if there is no modern client available for the service.
|
|
138
|
+
However, if a modern client is available, we generally recommend it over the
|
|
139
|
+
older `google-apis-` clients.
|
|
@@ -155,7 +155,13 @@ module Google
|
|
|
155
155
|
|
|
156
156
|
# Create credentials
|
|
157
157
|
credentials = @config.credentials
|
|
158
|
-
|
|
158
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
159
|
+
# but only if the default endpoint does not have a region prefix.
|
|
160
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
|
161
|
+
@config.endpoint == Client.configure.endpoint &&
|
|
162
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
163
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
164
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
159
165
|
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
|
160
166
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
161
167
|
end
|
|
@@ -173,7 +173,13 @@ module Google
|
|
|
173
173
|
|
|
174
174
|
# Create credentials
|
|
175
175
|
credentials = @config.credentials
|
|
176
|
-
|
|
176
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
177
|
+
# but only if the default endpoint does not have a region prefix.
|
|
178
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
|
179
|
+
@config.endpoint == Client.configure.endpoint &&
|
|
180
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
181
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
182
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
177
183
|
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
|
178
184
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
179
185
|
end
|
|
@@ -103,8 +103,13 @@ module Google
|
|
|
103
103
|
# Lists operations that match the specified filter in the request. If the
|
|
104
104
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
105
105
|
#
|
|
106
|
-
# NOTE: the `name` binding
|
|
107
|
-
# to use different resource name schemes, such as `users/*/operations`.
|
|
106
|
+
# NOTE: the `name` binding allows API services to override the binding
|
|
107
|
+
# to use different resource name schemes, such as `users/*/operations`. To
|
|
108
|
+
# override the binding, API services can add a binding such as
|
|
109
|
+
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
|
110
|
+
# For backwards compatibility, the default name includes the operations
|
|
111
|
+
# collection id, however overriding users must ensure the name binding
|
|
112
|
+
# is the parent resource, without the operations collection id.
|
|
108
113
|
#
|
|
109
114
|
# @overload list_operations(request, options = nil)
|
|
110
115
|
# Pass arguments to `list_operations` via a request object, either of type
|
|
@@ -122,7 +127,7 @@ module Google
|
|
|
122
127
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
123
128
|
#
|
|
124
129
|
# @param name [::String]
|
|
125
|
-
# The name of the operation
|
|
130
|
+
# The name of the operation's parent resource.
|
|
126
131
|
# @param filter [::String]
|
|
127
132
|
# The standard list filter.
|
|
128
133
|
# @param page_size [::Integer]
|
|
@@ -390,6 +395,79 @@ module Google
|
|
|
390
395
|
raise ::Google::Cloud::Error.from_error(e)
|
|
391
396
|
end
|
|
392
397
|
|
|
398
|
+
##
|
|
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
|
|
402
|
+
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
|
403
|
+
# timeout is used. If the server does not support this method, it returns
|
|
404
|
+
# `google.rpc.Code.UNIMPLEMENTED`.
|
|
405
|
+
# Note that this method is on a best-effort basis. It may return the latest
|
|
406
|
+
# state before the specified timeout (including immediately), meaning even an
|
|
407
|
+
# immediate response is no guarantee that the operation is done.
|
|
408
|
+
#
|
|
409
|
+
# @overload wait_operation(request, options = nil)
|
|
410
|
+
# Pass arguments to `wait_operation` via a request object, either of type
|
|
411
|
+
# {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
|
|
412
|
+
#
|
|
413
|
+
# @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
|
|
414
|
+
# A request object representing the call parameters. Required. To specify no
|
|
415
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
416
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
417
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
418
|
+
#
|
|
419
|
+
# @overload wait_operation(name: nil, timeout: nil)
|
|
420
|
+
# Pass arguments to `wait_operation` via keyword arguments. Note that at
|
|
421
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
422
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
423
|
+
#
|
|
424
|
+
# @param name [::String]
|
|
425
|
+
# The name of the operation resource to wait on.
|
|
426
|
+
# @param timeout [::Google::Protobuf::Duration, ::Hash]
|
|
427
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
|
428
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
|
429
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
|
430
|
+
#
|
|
431
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
432
|
+
# @yieldparam response [::Gapic::Operation]
|
|
433
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
434
|
+
#
|
|
435
|
+
# @return [::Gapic::Operation]
|
|
436
|
+
#
|
|
437
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
438
|
+
#
|
|
439
|
+
def wait_operation request, options = nil
|
|
440
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
441
|
+
|
|
442
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
|
|
443
|
+
|
|
444
|
+
# Converts hash and nil to an options object
|
|
445
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
446
|
+
|
|
447
|
+
# Customize the options with defaults
|
|
448
|
+
metadata = @config.rpcs.wait_operation.metadata.to_h
|
|
449
|
+
|
|
450
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
451
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
452
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
453
|
+
gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
|
|
454
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
455
|
+
|
|
456
|
+
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
|
457
|
+
metadata: metadata,
|
|
458
|
+
retry_policy: @config.rpcs.wait_operation.retry_policy
|
|
459
|
+
options.apply_defaults metadata: @config.metadata,
|
|
460
|
+
retry_policy: @config.retry_policy
|
|
461
|
+
|
|
462
|
+
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
|
463
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
464
|
+
yield response, operation if block_given?
|
|
465
|
+
return response
|
|
466
|
+
end
|
|
467
|
+
rescue ::GRPC::BadStatus => e
|
|
468
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
469
|
+
end
|
|
470
|
+
|
|
393
471
|
##
|
|
394
472
|
# Configuration class for the Operations API.
|
|
395
473
|
#
|
|
@@ -546,6 +624,11 @@ module Google
|
|
|
546
624
|
# @return [::Gapic::Config::Method]
|
|
547
625
|
#
|
|
548
626
|
attr_reader :cancel_operation
|
|
627
|
+
##
|
|
628
|
+
# RPC-specific configuration for `wait_operation`
|
|
629
|
+
# @return [::Gapic::Config::Method]
|
|
630
|
+
#
|
|
631
|
+
attr_reader :wait_operation
|
|
549
632
|
|
|
550
633
|
# @private
|
|
551
634
|
def initialize parent_rpcs = nil
|
|
@@ -557,6 +640,8 @@ module Google
|
|
|
557
640
|
@delete_operation = ::Gapic::Config::Method.new delete_operation_config
|
|
558
641
|
cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
|
|
559
642
|
@cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
|
|
643
|
+
wait_operation_config = parent_rpcs&.wait_operation if parent_rpcs&.respond_to? :wait_operation
|
|
644
|
+
@wait_operation = ::Gapic::Config::Method.new wait_operation_config
|
|
560
645
|
|
|
561
646
|
yield self if block_given?
|
|
562
647
|
end
|
|
@@ -180,7 +180,13 @@ module Google
|
|
|
180
180
|
|
|
181
181
|
# Create credentials
|
|
182
182
|
credentials = @config.credentials
|
|
183
|
-
|
|
183
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
184
|
+
# but only if the default endpoint does not have a region prefix.
|
|
185
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
|
186
|
+
@config.endpoint == Client.configure.endpoint &&
|
|
187
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
188
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
189
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
184
190
|
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
|
185
191
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
186
192
|
end
|
|
@@ -103,8 +103,13 @@ module Google
|
|
|
103
103
|
# Lists operations that match the specified filter in the request. If the
|
|
104
104
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
105
105
|
#
|
|
106
|
-
# NOTE: the `name` binding
|
|
107
|
-
# to use different resource name schemes, such as `users/*/operations`.
|
|
106
|
+
# NOTE: the `name` binding allows API services to override the binding
|
|
107
|
+
# to use different resource name schemes, such as `users/*/operations`. To
|
|
108
|
+
# override the binding, API services can add a binding such as
|
|
109
|
+
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
|
110
|
+
# For backwards compatibility, the default name includes the operations
|
|
111
|
+
# collection id, however overriding users must ensure the name binding
|
|
112
|
+
# is the parent resource, without the operations collection id.
|
|
108
113
|
#
|
|
109
114
|
# @overload list_operations(request, options = nil)
|
|
110
115
|
# Pass arguments to `list_operations` via a request object, either of type
|
|
@@ -122,7 +127,7 @@ module Google
|
|
|
122
127
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
123
128
|
#
|
|
124
129
|
# @param name [::String]
|
|
125
|
-
# The name of the operation
|
|
130
|
+
# The name of the operation's parent resource.
|
|
126
131
|
# @param filter [::String]
|
|
127
132
|
# The standard list filter.
|
|
128
133
|
# @param page_size [::Integer]
|
|
@@ -390,6 +395,79 @@ module Google
|
|
|
390
395
|
raise ::Google::Cloud::Error.from_error(e)
|
|
391
396
|
end
|
|
392
397
|
|
|
398
|
+
##
|
|
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
|
|
402
|
+
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
|
403
|
+
# timeout is used. If the server does not support this method, it returns
|
|
404
|
+
# `google.rpc.Code.UNIMPLEMENTED`.
|
|
405
|
+
# Note that this method is on a best-effort basis. It may return the latest
|
|
406
|
+
# state before the specified timeout (including immediately), meaning even an
|
|
407
|
+
# immediate response is no guarantee that the operation is done.
|
|
408
|
+
#
|
|
409
|
+
# @overload wait_operation(request, options = nil)
|
|
410
|
+
# Pass arguments to `wait_operation` via a request object, either of type
|
|
411
|
+
# {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
|
|
412
|
+
#
|
|
413
|
+
# @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
|
|
414
|
+
# A request object representing the call parameters. Required. To specify no
|
|
415
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
416
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
417
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
418
|
+
#
|
|
419
|
+
# @overload wait_operation(name: nil, timeout: nil)
|
|
420
|
+
# Pass arguments to `wait_operation` via keyword arguments. Note that at
|
|
421
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
422
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
423
|
+
#
|
|
424
|
+
# @param name [::String]
|
|
425
|
+
# The name of the operation resource to wait on.
|
|
426
|
+
# @param timeout [::Google::Protobuf::Duration, ::Hash]
|
|
427
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
|
428
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
|
429
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
|
430
|
+
#
|
|
431
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
432
|
+
# @yieldparam response [::Gapic::Operation]
|
|
433
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
434
|
+
#
|
|
435
|
+
# @return [::Gapic::Operation]
|
|
436
|
+
#
|
|
437
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
438
|
+
#
|
|
439
|
+
def wait_operation request, options = nil
|
|
440
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
441
|
+
|
|
442
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
|
|
443
|
+
|
|
444
|
+
# Converts hash and nil to an options object
|
|
445
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
446
|
+
|
|
447
|
+
# Customize the options with defaults
|
|
448
|
+
metadata = @config.rpcs.wait_operation.metadata.to_h
|
|
449
|
+
|
|
450
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
451
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
452
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
453
|
+
gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
|
|
454
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
455
|
+
|
|
456
|
+
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
|
457
|
+
metadata: metadata,
|
|
458
|
+
retry_policy: @config.rpcs.wait_operation.retry_policy
|
|
459
|
+
options.apply_defaults metadata: @config.metadata,
|
|
460
|
+
retry_policy: @config.retry_policy
|
|
461
|
+
|
|
462
|
+
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
|
463
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
464
|
+
yield response, operation if block_given?
|
|
465
|
+
return response
|
|
466
|
+
end
|
|
467
|
+
rescue ::GRPC::BadStatus => e
|
|
468
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
469
|
+
end
|
|
470
|
+
|
|
393
471
|
##
|
|
394
472
|
# Configuration class for the Operations API.
|
|
395
473
|
#
|
|
@@ -546,6 +624,11 @@ module Google
|
|
|
546
624
|
# @return [::Gapic::Config::Method]
|
|
547
625
|
#
|
|
548
626
|
attr_reader :cancel_operation
|
|
627
|
+
##
|
|
628
|
+
# RPC-specific configuration for `wait_operation`
|
|
629
|
+
# @return [::Gapic::Config::Method]
|
|
630
|
+
#
|
|
631
|
+
attr_reader :wait_operation
|
|
549
632
|
|
|
550
633
|
# @private
|
|
551
634
|
def initialize parent_rpcs = nil
|
|
@@ -557,6 +640,8 @@ module Google
|
|
|
557
640
|
@delete_operation = ::Gapic::Config::Method.new delete_operation_config
|
|
558
641
|
cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
|
|
559
642
|
@cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
|
|
643
|
+
wait_operation_config = parent_rpcs&.wait_operation if parent_rpcs&.respond_to? :wait_operation
|
|
644
|
+
@wait_operation = ::Gapic::Config::Method.new wait_operation_config
|
|
560
645
|
|
|
561
646
|
yield self if block_given?
|
|
562
647
|
end
|
|
@@ -183,7 +183,13 @@ module Google
|
|
|
183
183
|
|
|
184
184
|
# Create credentials
|
|
185
185
|
credentials = @config.credentials
|
|
186
|
-
|
|
186
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
187
|
+
# but only if the default endpoint does not have a region prefix.
|
|
188
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
|
189
|
+
@config.endpoint == Client.configure.endpoint &&
|
|
190
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
191
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
192
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
187
193
|
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
|
188
194
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
189
195
|
end
|
|
@@ -103,8 +103,13 @@ module Google
|
|
|
103
103
|
# Lists operations that match the specified filter in the request. If the
|
|
104
104
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
105
105
|
#
|
|
106
|
-
# NOTE: the `name` binding
|
|
107
|
-
# to use different resource name schemes, such as `users/*/operations`.
|
|
106
|
+
# NOTE: the `name` binding allows API services to override the binding
|
|
107
|
+
# to use different resource name schemes, such as `users/*/operations`. To
|
|
108
|
+
# override the binding, API services can add a binding such as
|
|
109
|
+
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
|
110
|
+
# For backwards compatibility, the default name includes the operations
|
|
111
|
+
# collection id, however overriding users must ensure the name binding
|
|
112
|
+
# is the parent resource, without the operations collection id.
|
|
108
113
|
#
|
|
109
114
|
# @overload list_operations(request, options = nil)
|
|
110
115
|
# Pass arguments to `list_operations` via a request object, either of type
|
|
@@ -122,7 +127,7 @@ module Google
|
|
|
122
127
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
123
128
|
#
|
|
124
129
|
# @param name [::String]
|
|
125
|
-
# The name of the operation
|
|
130
|
+
# The name of the operation's parent resource.
|
|
126
131
|
# @param filter [::String]
|
|
127
132
|
# The standard list filter.
|
|
128
133
|
# @param page_size [::Integer]
|
|
@@ -390,6 +395,79 @@ module Google
|
|
|
390
395
|
raise ::Google::Cloud::Error.from_error(e)
|
|
391
396
|
end
|
|
392
397
|
|
|
398
|
+
##
|
|
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
|
|
402
|
+
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
|
403
|
+
# timeout is used. If the server does not support this method, it returns
|
|
404
|
+
# `google.rpc.Code.UNIMPLEMENTED`.
|
|
405
|
+
# Note that this method is on a best-effort basis. It may return the latest
|
|
406
|
+
# state before the specified timeout (including immediately), meaning even an
|
|
407
|
+
# immediate response is no guarantee that the operation is done.
|
|
408
|
+
#
|
|
409
|
+
# @overload wait_operation(request, options = nil)
|
|
410
|
+
# Pass arguments to `wait_operation` via a request object, either of type
|
|
411
|
+
# {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
|
|
412
|
+
#
|
|
413
|
+
# @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
|
|
414
|
+
# A request object representing the call parameters. Required. To specify no
|
|
415
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
416
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
417
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
418
|
+
#
|
|
419
|
+
# @overload wait_operation(name: nil, timeout: nil)
|
|
420
|
+
# Pass arguments to `wait_operation` via keyword arguments. Note that at
|
|
421
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
422
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
423
|
+
#
|
|
424
|
+
# @param name [::String]
|
|
425
|
+
# The name of the operation resource to wait on.
|
|
426
|
+
# @param timeout [::Google::Protobuf::Duration, ::Hash]
|
|
427
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
|
428
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
|
429
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
|
430
|
+
#
|
|
431
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
432
|
+
# @yieldparam response [::Gapic::Operation]
|
|
433
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
434
|
+
#
|
|
435
|
+
# @return [::Gapic::Operation]
|
|
436
|
+
#
|
|
437
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
438
|
+
#
|
|
439
|
+
def wait_operation request, options = nil
|
|
440
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
441
|
+
|
|
442
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
|
|
443
|
+
|
|
444
|
+
# Converts hash and nil to an options object
|
|
445
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
446
|
+
|
|
447
|
+
# Customize the options with defaults
|
|
448
|
+
metadata = @config.rpcs.wait_operation.metadata.to_h
|
|
449
|
+
|
|
450
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
451
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
452
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
453
|
+
gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
|
|
454
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
455
|
+
|
|
456
|
+
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
|
457
|
+
metadata: metadata,
|
|
458
|
+
retry_policy: @config.rpcs.wait_operation.retry_policy
|
|
459
|
+
options.apply_defaults metadata: @config.metadata,
|
|
460
|
+
retry_policy: @config.retry_policy
|
|
461
|
+
|
|
462
|
+
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
|
463
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
464
|
+
yield response, operation if block_given?
|
|
465
|
+
return response
|
|
466
|
+
end
|
|
467
|
+
rescue ::GRPC::BadStatus => e
|
|
468
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
469
|
+
end
|
|
470
|
+
|
|
393
471
|
##
|
|
394
472
|
# Configuration class for the Operations API.
|
|
395
473
|
#
|
|
@@ -546,6 +624,11 @@ module Google
|
|
|
546
624
|
# @return [::Gapic::Config::Method]
|
|
547
625
|
#
|
|
548
626
|
attr_reader :cancel_operation
|
|
627
|
+
##
|
|
628
|
+
# RPC-specific configuration for `wait_operation`
|
|
629
|
+
# @return [::Gapic::Config::Method]
|
|
630
|
+
#
|
|
631
|
+
attr_reader :wait_operation
|
|
549
632
|
|
|
550
633
|
# @private
|
|
551
634
|
def initialize parent_rpcs = nil
|
|
@@ -557,6 +640,8 @@ module Google
|
|
|
557
640
|
@delete_operation = ::Gapic::Config::Method.new delete_operation_config
|
|
558
641
|
cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
|
|
559
642
|
@cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
|
|
643
|
+
wait_operation_config = parent_rpcs&.wait_operation if parent_rpcs&.respond_to? :wait_operation
|
|
644
|
+
@wait_operation = ::Gapic::Config::Method.new wait_operation_config
|
|
560
645
|
|
|
561
646
|
yield self if block_given?
|
|
562
647
|
end
|
|
@@ -54,6 +54,12 @@ module Google
|
|
|
54
54
|
# This indicates that the field may be set once in a request to create a
|
|
55
55
|
# resource, but may not be changed thereafter.
|
|
56
56
|
IMMUTABLE = 5
|
|
57
|
+
|
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
|
59
|
+
# This indicates that the service may provide the elements of the list
|
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
|
62
|
+
UNORDERED_LIST = 6
|
|
57
63
|
end
|
|
58
64
|
end
|
|
59
65
|
end
|
|
@@ -25,7 +25,7 @@ module Google
|
|
|
25
25
|
# @return [::String]
|
|
26
26
|
# The server-assigned name, which is only unique within the same service that
|
|
27
27
|
# originally returns it. If you use the default HTTP mapping, the
|
|
28
|
-
# `name` should
|
|
28
|
+
# `name` should be a resource name ending with `operations/{unique_id}`.
|
|
29
29
|
# @!attribute [rw] metadata
|
|
30
30
|
# @return [::Google::Protobuf::Any]
|
|
31
31
|
# Service-specific metadata associated with the operation. It typically
|
|
@@ -35,7 +35,7 @@ module Google
|
|
|
35
35
|
# @!attribute [rw] done
|
|
36
36
|
# @return [::Boolean]
|
|
37
37
|
# If the value is `false`, it means the operation is still in progress.
|
|
38
|
-
# If true
|
|
38
|
+
# If `true`, the operation is completed, and either `error` or `response` is
|
|
39
39
|
# available.
|
|
40
40
|
# @!attribute [rw] error
|
|
41
41
|
# @return [::Google::Rpc::Status]
|
|
@@ -67,7 +67,7 @@ module Google
|
|
|
67
67
|
# The request message for Operations.ListOperations.
|
|
68
68
|
# @!attribute [rw] name
|
|
69
69
|
# @return [::String]
|
|
70
|
-
# The name of the operation
|
|
70
|
+
# The name of the operation's parent resource.
|
|
71
71
|
# @!attribute [rw] filter
|
|
72
72
|
# @return [::String]
|
|
73
73
|
# The standard list filter.
|
|
@@ -112,6 +112,20 @@ module Google
|
|
|
112
112
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
113
113
|
end
|
|
114
114
|
|
|
115
|
+
# The request message for Operations.WaitOperation.
|
|
116
|
+
# @!attribute [rw] name
|
|
117
|
+
# @return [::String]
|
|
118
|
+
# The name of the operation resource to wait on.
|
|
119
|
+
# @!attribute [rw] timeout
|
|
120
|
+
# @return [::Google::Protobuf::Duration]
|
|
121
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
|
122
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
|
123
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
|
124
|
+
class WaitOperationRequest
|
|
125
|
+
include ::Google::Protobuf::MessageExts
|
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
127
|
+
end
|
|
128
|
+
|
|
115
129
|
# A message representing the message types used by a long-running operation.
|
|
116
130
|
#
|
|
117
131
|
# Example:
|
|
@@ -57,10 +57,13 @@ module Google
|
|
|
57
57
|
# Example 4: Pack and unpack a message in Go
|
|
58
58
|
#
|
|
59
59
|
# foo := &pb.Foo{...}
|
|
60
|
-
# any, err :=
|
|
60
|
+
# any, err := anypb.New(foo)
|
|
61
|
+
# if err != nil {
|
|
62
|
+
# ...
|
|
63
|
+
# }
|
|
61
64
|
# ...
|
|
62
65
|
# foo := &pb.Foo{}
|
|
63
|
-
# if err :=
|
|
66
|
+
# if err := any.UnmarshalTo(foo); err != nil {
|
|
64
67
|
# ...
|
|
65
68
|
# }
|
|
66
69
|
#
|
|
@@ -70,7 +70,16 @@ module Google
|
|
|
70
70
|
# .setNanos((int) ((millis % 1000) * 1000000)).build();
|
|
71
71
|
#
|
|
72
72
|
#
|
|
73
|
-
# Example 5: Compute Timestamp from
|
|
73
|
+
# Example 5: Compute Timestamp from Java `Instant.now()`.
|
|
74
|
+
#
|
|
75
|
+
# Instant now = Instant.now();
|
|
76
|
+
#
|
|
77
|
+
# Timestamp timestamp =
|
|
78
|
+
# Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
|
79
|
+
# .setNanos(now.getNano()).build();
|
|
80
|
+
#
|
|
81
|
+
#
|
|
82
|
+
# Example 6: Compute Timestamp from current time in Python.
|
|
74
83
|
#
|
|
75
84
|
# timestamp = Timestamp()
|
|
76
85
|
# timestamp.GetCurrentTime()
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-dataproc-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-02-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -150,7 +150,10 @@ dependencies:
|
|
|
150
150
|
- - "~>"
|
|
151
151
|
- !ruby/object:Gem::Version
|
|
152
152
|
version: '0.9'
|
|
153
|
-
description: Manages Hadoop-based clusters and jobs on Google Cloud Platform.
|
|
153
|
+
description: Manages Hadoop-based clusters and jobs on Google Cloud Platform. Note
|
|
154
|
+
that google-cloud-dataproc-v1 is a version-specific client library. For most uses,
|
|
155
|
+
we recommend installing the main client library google-cloud-dataproc instead. See
|
|
156
|
+
the readme for more details.
|
|
154
157
|
email: googleapis-packages@google.com
|
|
155
158
|
executables: []
|
|
156
159
|
extensions: []
|