google-cloud-tasks-v2beta2 0.9.2 → 0.11.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/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/client.rb +42 -9
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/rest/client.rb +378 -7
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/rest/service_stub.rb +14 -2
- data/lib/google/cloud/tasks/v2beta2/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- metadata +7 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2947dfcb365dc3834d1ccf6ad8b1a73ae654b0cdf7ca21dc85d4cd2c56eb8c1a
|
|
4
|
+
data.tar.gz: c71e9dffca9509866ff7ef3c4df4cd4648de394447e21362e2b59e1b5541f8da
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8a071b11eb2912f1a5505af9221a6dfe5790bb243d1b933d7166affaba8ffef25efdbb100c5786fc18b7380af5d0949d58b7653c36641cd19e3a4ee1acdbd095
|
|
7
|
+
data.tar.gz: 6f02ecf6240e60648f1879b65d60ddccc65066660e2d4a91dc11bf57694c623e64dca644b946ef73079c54ff109183e3a3f9f49f2502a2e7a6860c769441849c
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
|
7
|
-
credentials will be discovered automatically. When running on other
|
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
|
9
|
-
path to the
|
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
|
11
|
-
for the account (or the JSON itself) in
|
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
|
14
|
-
during development.
|
|
3
|
+
The recommended way to authenticate to the google-cloud-tasks-v2beta2 library is to use
|
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
|
15
6
|
|
|
16
7
|
## Quickstart
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
3. Initialize the client.
|
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
|
13
|
+
should be used only during development.
|
|
26
14
|
|
|
27
|
-
|
|
28
|
-
|
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
|
29
17
|
|
|
30
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-tasks-v2beta2 library aims to make authentication
|
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
|
38
|
-
|
|
39
|
-
**Credentials** are discovered in the following order:
|
|
40
|
-
|
|
41
|
-
1. Specify credentials in method arguments
|
|
42
|
-
2. Specify credentials in configuration
|
|
43
|
-
3. Discover credentials path in environment variables
|
|
44
|
-
4. Discover credentials JSON in environment variables
|
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
|
46
|
-
6. Discover GCP credentials
|
|
47
|
-
|
|
48
|
-
### Google Cloud Platform environments
|
|
22
|
+
3. Write code as if already authenticated.
|
|
49
23
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
|
53
|
-
Code should be written as if already authenticated.
|
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
|
54
26
|
|
|
55
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
|
63
|
-
containers where writing files is difficult or not encouraged.
|
|
29
|
+
The google-cloud-tasks-v2beta2 library provides several mechanisms to configure your system.
|
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
|
32
|
+
credentials, there are several methods available to you.
|
|
64
33
|
|
|
65
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::Tasks::V2beta2::CloudTasks::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
36
|
+
1. Credentials specified in method arguments
|
|
37
|
+
2. Credentials specified in configuration
|
|
38
|
+
3. Credentials pointed to or included in environment variables
|
|
39
|
+
4. Credentials found in local ADC file
|
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
|
74
41
|
|
|
75
|
-
|
|
76
|
-
require "google/cloud/tasks/v2beta2"
|
|
77
|
-
|
|
78
|
-
ENV["TASKS_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
81
|
-
|
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
82
49
|
|
|
83
|
-
|
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
52
|
+
whenever possible.
|
|
84
53
|
|
|
85
|
-
|
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
87
55
|
|
|
88
56
|
```ruby
|
|
89
57
|
require "google/cloud/tasks/v2beta2"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Tasks::V2beta2::CloudTasks::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/tasks/v2beta2"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Tasks::V2beta2::CloudTasks::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::Tasks::V2beta2::CloudTasks::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
|
81
|
+
you can include the credentials file itself.
|
|
113
82
|
|
|
114
|
-
|
|
83
|
+
The JSON file can contain credentials created for
|
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
90
|
+
whenever possible.
|
|
91
|
+
|
|
92
|
+
The environment variables that google-cloud-tasks-v2beta2
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/tasks/v2beta2"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-tasks-v2beta2.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Tasks::V2beta2::CloudTasks::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
134
|
-
2. Create a new project or click on an existing project.
|
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
137
107
|
|
|
138
|
-
|
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
|
110
|
+
then the local ADC credentials are discovered.
|
|
139
111
|
|
|
140
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
|
149
120
|
|
|
150
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# work in their applications.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudtasks.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
include Paths
|
|
36
39
|
|
|
37
40
|
# @private
|
|
@@ -160,6 +163,15 @@ module Google
|
|
|
160
163
|
@config
|
|
161
164
|
end
|
|
162
165
|
|
|
166
|
+
##
|
|
167
|
+
# The effective universe domain
|
|
168
|
+
#
|
|
169
|
+
# @return [String]
|
|
170
|
+
#
|
|
171
|
+
def universe_domain
|
|
172
|
+
@cloud_tasks_stub.universe_domain
|
|
173
|
+
end
|
|
174
|
+
|
|
163
175
|
##
|
|
164
176
|
# Create a new CloudTasks client object.
|
|
165
177
|
#
|
|
@@ -193,8 +205,9 @@ module Google
|
|
|
193
205
|
credentials = @config.credentials
|
|
194
206
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
195
207
|
# but only if the default endpoint does not have a region prefix.
|
|
196
|
-
enable_self_signed_jwt = @config.endpoint
|
|
197
|
-
|
|
208
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
209
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
210
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
198
211
|
credentials ||= Credentials.default scope: @config.scope,
|
|
199
212
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
200
213
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -207,14 +220,18 @@ module Google
|
|
|
207
220
|
config.credentials = credentials
|
|
208
221
|
config.quota_project = @quota_project_id
|
|
209
222
|
config.endpoint = @config.endpoint
|
|
223
|
+
config.universe_domain = @config.universe_domain
|
|
210
224
|
end
|
|
211
225
|
|
|
212
226
|
@cloud_tasks_stub = ::Gapic::ServiceStub.new(
|
|
213
227
|
::Google::Cloud::Tasks::V2beta2::CloudTasks::Stub,
|
|
214
|
-
credentials:
|
|
215
|
-
endpoint:
|
|
228
|
+
credentials: credentials,
|
|
229
|
+
endpoint: @config.endpoint,
|
|
230
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
231
|
+
universe_domain: @config.universe_domain,
|
|
216
232
|
channel_args: @config.channel_args,
|
|
217
|
-
interceptors: @config.interceptors
|
|
233
|
+
interceptors: @config.interceptors,
|
|
234
|
+
channel_pool_config: @config.channel_pool
|
|
218
235
|
)
|
|
219
236
|
end
|
|
220
237
|
|
|
@@ -2688,9 +2705,9 @@ module Google
|
|
|
2688
2705
|
# end
|
|
2689
2706
|
#
|
|
2690
2707
|
# @!attribute [rw] endpoint
|
|
2691
|
-
#
|
|
2692
|
-
#
|
|
2693
|
-
# @return [::String]
|
|
2708
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
2709
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
2710
|
+
# @return [::String,nil]
|
|
2694
2711
|
# @!attribute [rw] credentials
|
|
2695
2712
|
# Credentials to send with calls. You may provide any of the following types:
|
|
2696
2713
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -2736,13 +2753,20 @@ module Google
|
|
|
2736
2753
|
# @!attribute [rw] quota_project
|
|
2737
2754
|
# A separate project against which to charge quota.
|
|
2738
2755
|
# @return [::String]
|
|
2756
|
+
# @!attribute [rw] universe_domain
|
|
2757
|
+
# The universe domain within which to make requests. This determines the
|
|
2758
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
2759
|
+
# universe (usually the default "googleapis.com" universe).
|
|
2760
|
+
# @return [::String,nil]
|
|
2739
2761
|
#
|
|
2740
2762
|
class Configuration
|
|
2741
2763
|
extend ::Gapic::Config
|
|
2742
2764
|
|
|
2765
|
+
# @private
|
|
2766
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
2743
2767
|
DEFAULT_ENDPOINT = "cloudtasks.googleapis.com"
|
|
2744
2768
|
|
|
2745
|
-
config_attr :endpoint,
|
|
2769
|
+
config_attr :endpoint, nil, ::String, nil
|
|
2746
2770
|
config_attr :credentials, nil do |value|
|
|
2747
2771
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
2748
2772
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -2757,6 +2781,7 @@ module Google
|
|
|
2757
2781
|
config_attr :metadata, nil, ::Hash, nil
|
|
2758
2782
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
2759
2783
|
config_attr :quota_project, nil, ::String, nil
|
|
2784
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
2760
2785
|
|
|
2761
2786
|
# @private
|
|
2762
2787
|
def initialize parent_config = nil
|
|
@@ -2777,6 +2802,14 @@ module Google
|
|
|
2777
2802
|
end
|
|
2778
2803
|
end
|
|
2779
2804
|
|
|
2805
|
+
##
|
|
2806
|
+
# Configuration for the channel pool
|
|
2807
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
2808
|
+
#
|
|
2809
|
+
def channel_pool
|
|
2810
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
2811
|
+
end
|
|
2812
|
+
|
|
2780
2813
|
##
|
|
2781
2814
|
# Configuration RPC class for the CloudTasks API.
|
|
2782
2815
|
#
|
|
@@ -34,6 +34,9 @@ module Google
|
|
|
34
34
|
# work in their applications.
|
|
35
35
|
#
|
|
36
36
|
class Client
|
|
37
|
+
# @private
|
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudtasks.$UNIVERSE_DOMAIN$"
|
|
39
|
+
|
|
37
40
|
include Paths
|
|
38
41
|
|
|
39
42
|
# @private
|
|
@@ -160,6 +163,15 @@ module Google
|
|
|
160
163
|
@config
|
|
161
164
|
end
|
|
162
165
|
|
|
166
|
+
##
|
|
167
|
+
# The effective universe domain
|
|
168
|
+
#
|
|
169
|
+
# @return [String]
|
|
170
|
+
#
|
|
171
|
+
def universe_domain
|
|
172
|
+
@cloud_tasks_stub.universe_domain
|
|
173
|
+
end
|
|
174
|
+
|
|
163
175
|
##
|
|
164
176
|
# Create a new CloudTasks REST client object.
|
|
165
177
|
#
|
|
@@ -187,8 +199,9 @@ module Google
|
|
|
187
199
|
credentials = @config.credentials
|
|
188
200
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
189
201
|
# but only if the default endpoint does not have a region prefix.
|
|
190
|
-
enable_self_signed_jwt = @config.endpoint
|
|
191
|
-
|
|
202
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
203
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
204
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
192
205
|
credentials ||= Credentials.default scope: @config.scope,
|
|
193
206
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
194
207
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -202,10 +215,16 @@ module Google
|
|
|
202
215
|
config.credentials = credentials
|
|
203
216
|
config.quota_project = @quota_project_id
|
|
204
217
|
config.endpoint = @config.endpoint
|
|
218
|
+
config.universe_domain = @config.universe_domain
|
|
205
219
|
config.bindings_override = @config.bindings_override
|
|
206
220
|
end
|
|
207
221
|
|
|
208
|
-
@cloud_tasks_stub = ::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::ServiceStub.new
|
|
222
|
+
@cloud_tasks_stub = ::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::ServiceStub.new(
|
|
223
|
+
endpoint: @config.endpoint,
|
|
224
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
225
|
+
universe_domain: @config.universe_domain,
|
|
226
|
+
credentials: credentials
|
|
227
|
+
)
|
|
209
228
|
end
|
|
210
229
|
|
|
211
230
|
##
|
|
@@ -282,6 +301,26 @@ module Google
|
|
|
282
301
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2beta2::Queue>]
|
|
283
302
|
#
|
|
284
303
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
304
|
+
#
|
|
305
|
+
# @example Basic example
|
|
306
|
+
# require "google/cloud/tasks/v2beta2"
|
|
307
|
+
#
|
|
308
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
309
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
310
|
+
#
|
|
311
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
312
|
+
# request = Google::Cloud::Tasks::V2beta2::ListQueuesRequest.new
|
|
313
|
+
#
|
|
314
|
+
# # Call the list_queues method.
|
|
315
|
+
# result = client.list_queues request
|
|
316
|
+
#
|
|
317
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
318
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
319
|
+
# result.each do |item|
|
|
320
|
+
# # Each element is of type ::Google::Cloud::Tasks::V2beta2::Queue.
|
|
321
|
+
# p item
|
|
322
|
+
# end
|
|
323
|
+
#
|
|
285
324
|
def list_queues request, options = nil
|
|
286
325
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
287
326
|
|
|
@@ -351,6 +390,22 @@ module Google
|
|
|
351
390
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
|
352
391
|
#
|
|
353
392
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
393
|
+
#
|
|
394
|
+
# @example Basic example
|
|
395
|
+
# require "google/cloud/tasks/v2beta2"
|
|
396
|
+
#
|
|
397
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
398
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
399
|
+
#
|
|
400
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
401
|
+
# request = Google::Cloud::Tasks::V2beta2::GetQueueRequest.new
|
|
402
|
+
#
|
|
403
|
+
# # Call the get_queue method.
|
|
404
|
+
# result = client.get_queue request
|
|
405
|
+
#
|
|
406
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
|
407
|
+
# p result
|
|
408
|
+
#
|
|
354
409
|
def get_queue request, options = nil
|
|
355
410
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
356
411
|
|
|
@@ -434,6 +489,22 @@ module Google
|
|
|
434
489
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
|
435
490
|
#
|
|
436
491
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
492
|
+
#
|
|
493
|
+
# @example Basic example
|
|
494
|
+
# require "google/cloud/tasks/v2beta2"
|
|
495
|
+
#
|
|
496
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
497
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
498
|
+
#
|
|
499
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
500
|
+
# request = Google::Cloud::Tasks::V2beta2::CreateQueueRequest.new
|
|
501
|
+
#
|
|
502
|
+
# # Call the create_queue method.
|
|
503
|
+
# result = client.create_queue request
|
|
504
|
+
#
|
|
505
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
|
506
|
+
# p result
|
|
507
|
+
#
|
|
437
508
|
def create_queue request, options = nil
|
|
438
509
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
439
510
|
|
|
@@ -522,6 +593,22 @@ module Google
|
|
|
522
593
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
|
523
594
|
#
|
|
524
595
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
596
|
+
#
|
|
597
|
+
# @example Basic example
|
|
598
|
+
# require "google/cloud/tasks/v2beta2"
|
|
599
|
+
#
|
|
600
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
601
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
602
|
+
#
|
|
603
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
604
|
+
# request = Google::Cloud::Tasks::V2beta2::UpdateQueueRequest.new
|
|
605
|
+
#
|
|
606
|
+
# # Call the update_queue method.
|
|
607
|
+
# result = client.update_queue request
|
|
608
|
+
#
|
|
609
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
|
610
|
+
# p result
|
|
611
|
+
#
|
|
525
612
|
def update_queue request, options = nil
|
|
526
613
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
527
614
|
|
|
@@ -597,6 +684,22 @@ module Google
|
|
|
597
684
|
# @return [::Google::Protobuf::Empty]
|
|
598
685
|
#
|
|
599
686
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
687
|
+
#
|
|
688
|
+
# @example Basic example
|
|
689
|
+
# require "google/cloud/tasks/v2beta2"
|
|
690
|
+
#
|
|
691
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
692
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
693
|
+
#
|
|
694
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
695
|
+
# request = Google::Cloud::Tasks::V2beta2::DeleteQueueRequest.new
|
|
696
|
+
#
|
|
697
|
+
# # Call the delete_queue method.
|
|
698
|
+
# result = client.delete_queue request
|
|
699
|
+
#
|
|
700
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
|
701
|
+
# p result
|
|
702
|
+
#
|
|
600
703
|
def delete_queue request, options = nil
|
|
601
704
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
602
705
|
|
|
@@ -665,6 +768,22 @@ module Google
|
|
|
665
768
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
|
666
769
|
#
|
|
667
770
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
771
|
+
#
|
|
772
|
+
# @example Basic example
|
|
773
|
+
# require "google/cloud/tasks/v2beta2"
|
|
774
|
+
#
|
|
775
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
776
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
777
|
+
#
|
|
778
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
779
|
+
# request = Google::Cloud::Tasks::V2beta2::PurgeQueueRequest.new
|
|
780
|
+
#
|
|
781
|
+
# # Call the purge_queue method.
|
|
782
|
+
# result = client.purge_queue request
|
|
783
|
+
#
|
|
784
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
|
785
|
+
# p result
|
|
786
|
+
#
|
|
668
787
|
def purge_queue request, options = nil
|
|
669
788
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
670
789
|
|
|
@@ -735,6 +854,22 @@ module Google
|
|
|
735
854
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
|
736
855
|
#
|
|
737
856
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
857
|
+
#
|
|
858
|
+
# @example Basic example
|
|
859
|
+
# require "google/cloud/tasks/v2beta2"
|
|
860
|
+
#
|
|
861
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
862
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
863
|
+
#
|
|
864
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
865
|
+
# request = Google::Cloud::Tasks::V2beta2::PauseQueueRequest.new
|
|
866
|
+
#
|
|
867
|
+
# # Call the pause_queue method.
|
|
868
|
+
# result = client.pause_queue request
|
|
869
|
+
#
|
|
870
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
|
871
|
+
# p result
|
|
872
|
+
#
|
|
738
873
|
def pause_queue request, options = nil
|
|
739
874
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
740
875
|
|
|
@@ -812,6 +947,22 @@ module Google
|
|
|
812
947
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
|
813
948
|
#
|
|
814
949
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
950
|
+
#
|
|
951
|
+
# @example Basic example
|
|
952
|
+
# require "google/cloud/tasks/v2beta2"
|
|
953
|
+
#
|
|
954
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
955
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
956
|
+
#
|
|
957
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
958
|
+
# request = Google::Cloud::Tasks::V2beta2::ResumeQueueRequest.new
|
|
959
|
+
#
|
|
960
|
+
# # Call the resume_queue method.
|
|
961
|
+
# result = client.resume_queue request
|
|
962
|
+
#
|
|
963
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
|
964
|
+
# p result
|
|
965
|
+
#
|
|
815
966
|
def resume_queue request, options = nil
|
|
816
967
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
817
968
|
|
|
@@ -886,6 +1037,22 @@ module Google
|
|
|
886
1037
|
# @return [::Google::Iam::V1::Policy]
|
|
887
1038
|
#
|
|
888
1039
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1040
|
+
#
|
|
1041
|
+
# @example Basic example
|
|
1042
|
+
# require "google/cloud/tasks/v2beta2"
|
|
1043
|
+
#
|
|
1044
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1045
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
1046
|
+
#
|
|
1047
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1048
|
+
# request = Google::Iam::V1::GetIamPolicyRequest.new
|
|
1049
|
+
#
|
|
1050
|
+
# # Call the get_iam_policy method.
|
|
1051
|
+
# result = client.get_iam_policy request
|
|
1052
|
+
#
|
|
1053
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
|
1054
|
+
# p result
|
|
1055
|
+
#
|
|
889
1056
|
def get_iam_policy request, options = nil
|
|
890
1057
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
891
1058
|
|
|
@@ -970,6 +1137,22 @@ module Google
|
|
|
970
1137
|
# @return [::Google::Iam::V1::Policy]
|
|
971
1138
|
#
|
|
972
1139
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1140
|
+
#
|
|
1141
|
+
# @example Basic example
|
|
1142
|
+
# require "google/cloud/tasks/v2beta2"
|
|
1143
|
+
#
|
|
1144
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1145
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
1146
|
+
#
|
|
1147
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1148
|
+
# request = Google::Iam::V1::SetIamPolicyRequest.new
|
|
1149
|
+
#
|
|
1150
|
+
# # Call the set_iam_policy method.
|
|
1151
|
+
# result = client.set_iam_policy request
|
|
1152
|
+
#
|
|
1153
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
|
1154
|
+
# p result
|
|
1155
|
+
#
|
|
973
1156
|
def set_iam_policy request, options = nil
|
|
974
1157
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
975
1158
|
|
|
@@ -1045,6 +1228,22 @@ module Google
|
|
|
1045
1228
|
# @return [::Google::Iam::V1::TestIamPermissionsResponse]
|
|
1046
1229
|
#
|
|
1047
1230
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1231
|
+
#
|
|
1232
|
+
# @example Basic example
|
|
1233
|
+
# require "google/cloud/tasks/v2beta2"
|
|
1234
|
+
#
|
|
1235
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1236
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
1237
|
+
#
|
|
1238
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1239
|
+
# request = Google::Iam::V1::TestIamPermissionsRequest.new
|
|
1240
|
+
#
|
|
1241
|
+
# # Call the test_iam_permissions method.
|
|
1242
|
+
# result = client.test_iam_permissions request
|
|
1243
|
+
#
|
|
1244
|
+
# # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
|
|
1245
|
+
# p result
|
|
1246
|
+
#
|
|
1048
1247
|
def test_iam_permissions request, options = nil
|
|
1049
1248
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1050
1249
|
|
|
@@ -1149,6 +1348,26 @@ module Google
|
|
|
1149
1348
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2beta2::Task>]
|
|
1150
1349
|
#
|
|
1151
1350
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1351
|
+
#
|
|
1352
|
+
# @example Basic example
|
|
1353
|
+
# require "google/cloud/tasks/v2beta2"
|
|
1354
|
+
#
|
|
1355
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1356
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
1357
|
+
#
|
|
1358
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1359
|
+
# request = Google::Cloud::Tasks::V2beta2::ListTasksRequest.new
|
|
1360
|
+
#
|
|
1361
|
+
# # Call the list_tasks method.
|
|
1362
|
+
# result = client.list_tasks request
|
|
1363
|
+
#
|
|
1364
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
1365
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
1366
|
+
# result.each do |item|
|
|
1367
|
+
# # Each element is of type ::Google::Cloud::Tasks::V2beta2::Task.
|
|
1368
|
+
# p item
|
|
1369
|
+
# end
|
|
1370
|
+
#
|
|
1152
1371
|
def list_tasks request, options = nil
|
|
1153
1372
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1154
1373
|
|
|
@@ -1227,6 +1446,22 @@ module Google
|
|
|
1227
1446
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
|
1228
1447
|
#
|
|
1229
1448
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1449
|
+
#
|
|
1450
|
+
# @example Basic example
|
|
1451
|
+
# require "google/cloud/tasks/v2beta2"
|
|
1452
|
+
#
|
|
1453
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1454
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
1455
|
+
#
|
|
1456
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1457
|
+
# request = Google::Cloud::Tasks::V2beta2::GetTaskRequest.new
|
|
1458
|
+
#
|
|
1459
|
+
# # Call the get_task method.
|
|
1460
|
+
# result = client.get_task request
|
|
1461
|
+
#
|
|
1462
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
|
1463
|
+
# p result
|
|
1464
|
+
#
|
|
1230
1465
|
def get_task request, options = nil
|
|
1231
1466
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1232
1467
|
|
|
@@ -1348,6 +1583,22 @@ module Google
|
|
|
1348
1583
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
|
1349
1584
|
#
|
|
1350
1585
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1586
|
+
#
|
|
1587
|
+
# @example Basic example
|
|
1588
|
+
# require "google/cloud/tasks/v2beta2"
|
|
1589
|
+
#
|
|
1590
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1591
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
1592
|
+
#
|
|
1593
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1594
|
+
# request = Google::Cloud::Tasks::V2beta2::CreateTaskRequest.new
|
|
1595
|
+
#
|
|
1596
|
+
# # Call the create_task method.
|
|
1597
|
+
# result = client.create_task request
|
|
1598
|
+
#
|
|
1599
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
|
1600
|
+
# p result
|
|
1601
|
+
#
|
|
1351
1602
|
def create_task request, options = nil
|
|
1352
1603
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1353
1604
|
|
|
@@ -1415,6 +1666,22 @@ module Google
|
|
|
1415
1666
|
# @return [::Google::Protobuf::Empty]
|
|
1416
1667
|
#
|
|
1417
1668
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1669
|
+
#
|
|
1670
|
+
# @example Basic example
|
|
1671
|
+
# require "google/cloud/tasks/v2beta2"
|
|
1672
|
+
#
|
|
1673
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1674
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
1675
|
+
#
|
|
1676
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1677
|
+
# request = Google::Cloud::Tasks::V2beta2::DeleteTaskRequest.new
|
|
1678
|
+
#
|
|
1679
|
+
# # Call the delete_task method.
|
|
1680
|
+
# result = client.delete_task request
|
|
1681
|
+
#
|
|
1682
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
|
1683
|
+
# p result
|
|
1684
|
+
#
|
|
1418
1685
|
def delete_task request, options = nil
|
|
1419
1686
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1420
1687
|
|
|
@@ -1581,6 +1848,22 @@ module Google
|
|
|
1581
1848
|
# @return [::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse]
|
|
1582
1849
|
#
|
|
1583
1850
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1851
|
+
#
|
|
1852
|
+
# @example Basic example
|
|
1853
|
+
# require "google/cloud/tasks/v2beta2"
|
|
1854
|
+
#
|
|
1855
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1856
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
1857
|
+
#
|
|
1858
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1859
|
+
# request = Google::Cloud::Tasks::V2beta2::LeaseTasksRequest.new
|
|
1860
|
+
#
|
|
1861
|
+
# # Call the lease_tasks method.
|
|
1862
|
+
# result = client.lease_tasks request
|
|
1863
|
+
#
|
|
1864
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::LeaseTasksResponse.
|
|
1865
|
+
# p result
|
|
1866
|
+
#
|
|
1584
1867
|
def lease_tasks request, options = nil
|
|
1585
1868
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1586
1869
|
|
|
@@ -1663,6 +1946,22 @@ module Google
|
|
|
1663
1946
|
# @return [::Google::Protobuf::Empty]
|
|
1664
1947
|
#
|
|
1665
1948
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1949
|
+
#
|
|
1950
|
+
# @example Basic example
|
|
1951
|
+
# require "google/cloud/tasks/v2beta2"
|
|
1952
|
+
#
|
|
1953
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1954
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
1955
|
+
#
|
|
1956
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1957
|
+
# request = Google::Cloud::Tasks::V2beta2::AcknowledgeTaskRequest.new
|
|
1958
|
+
#
|
|
1959
|
+
# # Call the acknowledge_task method.
|
|
1960
|
+
# result = client.acknowledge_task request
|
|
1961
|
+
#
|
|
1962
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
|
1963
|
+
# p result
|
|
1964
|
+
#
|
|
1666
1965
|
def acknowledge_task request, options = nil
|
|
1667
1966
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1668
1967
|
|
|
@@ -1757,6 +2056,22 @@ module Google
|
|
|
1757
2056
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
|
1758
2057
|
#
|
|
1759
2058
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
2059
|
+
#
|
|
2060
|
+
# @example Basic example
|
|
2061
|
+
# require "google/cloud/tasks/v2beta2"
|
|
2062
|
+
#
|
|
2063
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2064
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
2065
|
+
#
|
|
2066
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2067
|
+
# request = Google::Cloud::Tasks::V2beta2::RenewLeaseRequest.new
|
|
2068
|
+
#
|
|
2069
|
+
# # Call the renew_lease method.
|
|
2070
|
+
# result = client.renew_lease request
|
|
2071
|
+
#
|
|
2072
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
|
2073
|
+
# p result
|
|
2074
|
+
#
|
|
1760
2075
|
def renew_lease request, options = nil
|
|
1761
2076
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1762
2077
|
|
|
@@ -1845,6 +2160,22 @@ module Google
|
|
|
1845
2160
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
|
1846
2161
|
#
|
|
1847
2162
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
2163
|
+
#
|
|
2164
|
+
# @example Basic example
|
|
2165
|
+
# require "google/cloud/tasks/v2beta2"
|
|
2166
|
+
#
|
|
2167
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2168
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
2169
|
+
#
|
|
2170
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2171
|
+
# request = Google::Cloud::Tasks::V2beta2::CancelLeaseRequest.new
|
|
2172
|
+
#
|
|
2173
|
+
# # Call the cancel_lease method.
|
|
2174
|
+
# result = client.cancel_lease request
|
|
2175
|
+
#
|
|
2176
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
|
2177
|
+
# p result
|
|
2178
|
+
#
|
|
1848
2179
|
def cancel_lease request, options = nil
|
|
1849
2180
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1850
2181
|
|
|
@@ -1951,6 +2282,22 @@ module Google
|
|
|
1951
2282
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
|
1952
2283
|
#
|
|
1953
2284
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
2285
|
+
#
|
|
2286
|
+
# @example Basic example
|
|
2287
|
+
# require "google/cloud/tasks/v2beta2"
|
|
2288
|
+
#
|
|
2289
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2290
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
2291
|
+
#
|
|
2292
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2293
|
+
# request = Google::Cloud::Tasks::V2beta2::RunTaskRequest.new
|
|
2294
|
+
#
|
|
2295
|
+
# # Call the run_task method.
|
|
2296
|
+
# result = client.run_task request
|
|
2297
|
+
#
|
|
2298
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
|
2299
|
+
# p result
|
|
2300
|
+
#
|
|
1954
2301
|
def run_task request, options = nil
|
|
1955
2302
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1956
2303
|
|
|
@@ -2034,6 +2381,22 @@ module Google
|
|
|
2034
2381
|
# @return [::Google::Cloud::Tasks::V2beta2::BufferTaskResponse]
|
|
2035
2382
|
#
|
|
2036
2383
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
2384
|
+
#
|
|
2385
|
+
# @example Basic example
|
|
2386
|
+
# require "google/cloud/tasks/v2beta2"
|
|
2387
|
+
#
|
|
2388
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2389
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
|
2390
|
+
#
|
|
2391
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2392
|
+
# request = Google::Cloud::Tasks::V2beta2::BufferTaskRequest.new
|
|
2393
|
+
#
|
|
2394
|
+
# # Call the buffer_task method.
|
|
2395
|
+
# result = client.buffer_task request
|
|
2396
|
+
#
|
|
2397
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::BufferTaskResponse.
|
|
2398
|
+
# p result
|
|
2399
|
+
#
|
|
2037
2400
|
def buffer_task request, options = nil
|
|
2038
2401
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2039
2402
|
|
|
@@ -2099,9 +2462,9 @@ module Google
|
|
|
2099
2462
|
# end
|
|
2100
2463
|
#
|
|
2101
2464
|
# @!attribute [rw] endpoint
|
|
2102
|
-
#
|
|
2103
|
-
#
|
|
2104
|
-
# @return [::String]
|
|
2465
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
2466
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
2467
|
+
# @return [::String,nil]
|
|
2105
2468
|
# @!attribute [rw] credentials
|
|
2106
2469
|
# Credentials to send with calls. You may provide any of the following types:
|
|
2107
2470
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -2138,13 +2501,20 @@ module Google
|
|
|
2138
2501
|
# @!attribute [rw] quota_project
|
|
2139
2502
|
# A separate project against which to charge quota.
|
|
2140
2503
|
# @return [::String]
|
|
2504
|
+
# @!attribute [rw] universe_domain
|
|
2505
|
+
# The universe domain within which to make requests. This determines the
|
|
2506
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
2507
|
+
# universe (usually the default "googleapis.com" universe).
|
|
2508
|
+
# @return [::String,nil]
|
|
2141
2509
|
#
|
|
2142
2510
|
class Configuration
|
|
2143
2511
|
extend ::Gapic::Config
|
|
2144
2512
|
|
|
2513
|
+
# @private
|
|
2514
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
2145
2515
|
DEFAULT_ENDPOINT = "cloudtasks.googleapis.com"
|
|
2146
2516
|
|
|
2147
|
-
config_attr :endpoint,
|
|
2517
|
+
config_attr :endpoint, nil, ::String, nil
|
|
2148
2518
|
config_attr :credentials, nil do |value|
|
|
2149
2519
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
2150
2520
|
allowed.any? { |klass| klass === value }
|
|
@@ -2156,6 +2526,7 @@ module Google
|
|
|
2156
2526
|
config_attr :metadata, nil, ::Hash, nil
|
|
2157
2527
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
2158
2528
|
config_attr :quota_project, nil, ::String, nil
|
|
2529
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
2159
2530
|
|
|
2160
2531
|
# @private
|
|
2161
2532
|
# Overrides for http bindings for the RPCs of this service
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the list_queues REST call
|
|
45
57
|
#
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -66,6 +66,20 @@ module Google
|
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
|
67
67
|
# non-empty value to expect.
|
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
|
69
|
+
|
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
|
73
|
+
# `name` field on the resource.
|
|
74
|
+
#
|
|
75
|
+
# This behavior should not be applied to references to other resources within
|
|
76
|
+
# the message.
|
|
77
|
+
#
|
|
78
|
+
# The identifier field of resources often have different field behavior
|
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
|
82
|
+
IDENTIFIER = 8
|
|
69
83
|
end
|
|
70
84
|
end
|
|
71
85
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-tasks-v2beta2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.11.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:
|
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.21.1
|
|
20
20
|
- - "<"
|
|
21
21
|
- !ruby/object:Gem::Version
|
|
22
22
|
version: 2.a
|
|
@@ -26,7 +26,7 @@ dependencies:
|
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -50,7 +50,7 @@ dependencies:
|
|
|
50
50
|
requirements:
|
|
51
51
|
- - ">="
|
|
52
52
|
- !ruby/object:Gem::Version
|
|
53
|
-
version: '0.
|
|
53
|
+
version: '0.7'
|
|
54
54
|
- - "<"
|
|
55
55
|
- !ruby/object:Gem::Version
|
|
56
56
|
version: 2.a
|
|
@@ -60,7 +60,7 @@ dependencies:
|
|
|
60
60
|
requirements:
|
|
61
61
|
- - ">="
|
|
62
62
|
- !ruby/object:Gem::Version
|
|
63
|
-
version: '0.
|
|
63
|
+
version: '0.7'
|
|
64
64
|
- - "<"
|
|
65
65
|
- !ruby/object:Gem::Version
|
|
66
66
|
version: 2.a
|
|
@@ -262,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
262
262
|
- !ruby/object:Gem::Version
|
|
263
263
|
version: '0'
|
|
264
264
|
requirements: []
|
|
265
|
-
rubygems_version: 3.
|
|
265
|
+
rubygems_version: 3.5.3
|
|
266
266
|
signing_key:
|
|
267
267
|
specification_version: 4
|
|
268
268
|
summary: Manages the execution of large numbers of distributed requests.
|