google-cloud-tasks-v2 0.8.2 → 0.10.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4fc458310d9519284809db91d4decce47c8590e7a44af2c444d6ba626d198e51
4
- data.tar.gz: '0908a45fc002152c9e1259dfcc6680652efc79cd6ba11e2447d13124d328014d'
3
+ metadata.gz: d3f840faea02d77cbdd6c65dbf473abb5577f923e32f6deca00abb75b87d1bb3
4
+ data.tar.gz: 8d77c3c12ad3cf620be861401e0f01c186b2feb872279d4471206153bf9d1e41
5
5
  SHA512:
6
- metadata.gz: 505427abd2604868628701d74666a47cc00961817c6bedf5dd5ccecca9bc78ad99c03a129aaf132c9ed343054bd086198c9837344a8f8eaea8f3f630cd881735
7
- data.tar.gz: 495a3154f884a9b7ea3671530a6103bab8cab73e93b50360943e8802e85e505957e9edff8647aa8933f05642c622e919783f395e8ecc12a0e1e6efcf65052081
6
+ metadata.gz: 9bfac133fcc3dfc2b5426ba95f2893fe609289d84774fa97f1dd2515aaeff71a0f356ef543e05c37eb0e54c3ba5497a86f5650b79cf573b927eb4294d0b631f3
7
+ data.tar.gz: e25f6e19d7f97e8e3be41a73a2696665c60f2bda3e5e3cd3d050167c71bd423ddff90baa0c9c71260fa265bc1c2af08074482024b64eb3f76f6bddebe25495f0
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-tasks-v2 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
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-v2 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
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export TASKS_CREDENTIALS=path/to/keyfile.json
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
- ```ruby
28
- require "google/cloud/tasks/v2"
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
- client = ::Google::Cloud::Tasks::V2::CloudTasks::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-tasks-v2 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
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
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
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
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-v2 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
- The environment variables that google-cloud-tasks-v2
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Tasks::V2::CloudTasks::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `TASKS_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `TASKS_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
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
- ```ruby
76
- require "google/cloud/tasks/v2"
77
-
78
- ENV["TASKS_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Tasks::V2::CloudTasks::Client.new
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
- ### Configuration
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
- The path to the **Credentials JSON** file can be configured instead of storing
86
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/tasks/v2"
90
58
 
91
59
  client = ::Google::Cloud::Tasks::V2::CloudTasks::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/tasks/v2"
100
68
 
101
69
  ::Google::Cloud::Tasks::V2::CloudTasks::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::Tasks::V2::CloudTasks::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
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
- To configure your system for this, simply:
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
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
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-v2
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/tasks/v2"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-tasks-v2.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Tasks::V2::CloudTasks::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
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
- *Note: You may need to enable billing in order to use these services.*
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
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
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.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
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**.
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
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
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
@@ -148,6 +151,15 @@ module Google
148
151
  @config
149
152
  end
150
153
 
154
+ ##
155
+ # The effective universe domain
156
+ #
157
+ # @return [String]
158
+ #
159
+ def universe_domain
160
+ @cloud_tasks_stub.universe_domain
161
+ end
162
+
151
163
  ##
152
164
  # Create a new CloudTasks client object.
153
165
  #
@@ -181,8 +193,9 @@ module Google
181
193
  credentials = @config.credentials
182
194
  # Use self-signed JWT if the endpoint is unchanged from default,
183
195
  # but only if the default endpoint does not have a region prefix.
184
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
185
- !@config.endpoint.split(".").first.include?("-")
196
+ enable_self_signed_jwt = @config.endpoint.nil? ||
197
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
198
+ !@config.endpoint.split(".").first.include?("-"))
186
199
  credentials ||= Credentials.default scope: @config.scope,
187
200
  enable_self_signed_jwt: enable_self_signed_jwt
188
201
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -195,14 +208,18 @@ module Google
195
208
  config.credentials = credentials
196
209
  config.quota_project = @quota_project_id
197
210
  config.endpoint = @config.endpoint
211
+ config.universe_domain = @config.universe_domain
198
212
  end
199
213
 
200
214
  @cloud_tasks_stub = ::Gapic::ServiceStub.new(
201
215
  ::Google::Cloud::Tasks::V2::CloudTasks::Stub,
202
- credentials: credentials,
203
- endpoint: @config.endpoint,
216
+ credentials: credentials,
217
+ endpoint: @config.endpoint,
218
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
219
+ universe_domain: @config.universe_domain,
204
220
  channel_args: @config.channel_args,
205
- interceptors: @config.interceptors
221
+ interceptors: @config.interceptors,
222
+ channel_pool_config: @config.channel_pool
206
223
  )
207
224
  end
208
225
 
@@ -1935,9 +1952,9 @@ module Google
1935
1952
  # end
1936
1953
  #
1937
1954
  # @!attribute [rw] endpoint
1938
- # The hostname or hostname:port of the service endpoint.
1939
- # Defaults to `"cloudtasks.googleapis.com"`.
1940
- # @return [::String]
1955
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1956
+ # nil, indicating to use the default endpoint in the current universe domain.
1957
+ # @return [::String,nil]
1941
1958
  # @!attribute [rw] credentials
1942
1959
  # Credentials to send with calls. You may provide any of the following types:
1943
1960
  # * (`String`) The path to a service account key file in JSON format
@@ -1983,13 +2000,20 @@ module Google
1983
2000
  # @!attribute [rw] quota_project
1984
2001
  # A separate project against which to charge quota.
1985
2002
  # @return [::String]
2003
+ # @!attribute [rw] universe_domain
2004
+ # The universe domain within which to make requests. This determines the
2005
+ # default endpoint URL. The default value of nil uses the environment
2006
+ # universe (usually the default "googleapis.com" universe).
2007
+ # @return [::String,nil]
1986
2008
  #
1987
2009
  class Configuration
1988
2010
  extend ::Gapic::Config
1989
2011
 
2012
+ # @private
2013
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1990
2014
  DEFAULT_ENDPOINT = "cloudtasks.googleapis.com"
1991
2015
 
1992
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2016
+ config_attr :endpoint, nil, ::String, nil
1993
2017
  config_attr :credentials, nil do |value|
1994
2018
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1995
2019
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2004,6 +2028,7 @@ module Google
2004
2028
  config_attr :metadata, nil, ::Hash, nil
2005
2029
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2006
2030
  config_attr :quota_project, nil, ::String, nil
2031
+ config_attr :universe_domain, nil, ::String, nil
2007
2032
 
2008
2033
  # @private
2009
2034
  def initialize parent_config = nil
@@ -2024,6 +2049,14 @@ module Google
2024
2049
  end
2025
2050
  end
2026
2051
 
2052
+ ##
2053
+ # Configuration for the channel pool
2054
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
2055
+ #
2056
+ def channel_pool
2057
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
2058
+ end
2059
+
2027
2060
  ##
2028
2061
  # Configuration RPC class for the CloudTasks API.
2029
2062
  #
@@ -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
@@ -150,6 +153,15 @@ module Google
150
153
  @config
151
154
  end
152
155
 
156
+ ##
157
+ # The effective universe domain
158
+ #
159
+ # @return [String]
160
+ #
161
+ def universe_domain
162
+ @cloud_tasks_stub.universe_domain
163
+ end
164
+
153
165
  ##
154
166
  # Create a new CloudTasks REST client object.
155
167
  #
@@ -177,8 +189,9 @@ module Google
177
189
  credentials = @config.credentials
178
190
  # Use self-signed JWT if the endpoint is unchanged from default,
179
191
  # but only if the default endpoint does not have a region prefix.
180
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
181
- !@config.endpoint.split(".").first.include?("-")
192
+ enable_self_signed_jwt = @config.endpoint.nil? ||
193
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
194
+ !@config.endpoint.split(".").first.include?("-"))
182
195
  credentials ||= Credentials.default scope: @config.scope,
183
196
  enable_self_signed_jwt: enable_self_signed_jwt
184
197
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -192,10 +205,16 @@ module Google
192
205
  config.credentials = credentials
193
206
  config.quota_project = @quota_project_id
194
207
  config.endpoint = @config.endpoint
208
+ config.universe_domain = @config.universe_domain
195
209
  config.bindings_override = @config.bindings_override
196
210
  end
197
211
 
198
- @cloud_tasks_stub = ::Google::Cloud::Tasks::V2::CloudTasks::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
212
+ @cloud_tasks_stub = ::Google::Cloud::Tasks::V2::CloudTasks::Rest::ServiceStub.new(
213
+ endpoint: @config.endpoint,
214
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
215
+ universe_domain: @config.universe_domain,
216
+ credentials: credentials
217
+ )
199
218
  end
200
219
 
201
220
  ##
@@ -267,6 +286,26 @@ module Google
267
286
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2::Queue>]
268
287
  #
269
288
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
289
+ #
290
+ # @example Basic example
291
+ # require "google/cloud/tasks/v2"
292
+ #
293
+ # # Create a client object. The client can be reused for multiple calls.
294
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
295
+ #
296
+ # # Create a request. To set request fields, pass in keyword arguments.
297
+ # request = Google::Cloud::Tasks::V2::ListQueuesRequest.new
298
+ #
299
+ # # Call the list_queues method.
300
+ # result = client.list_queues request
301
+ #
302
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
303
+ # # over elements, and API calls will be issued to fetch pages as needed.
304
+ # result.each do |item|
305
+ # # Each element is of type ::Google::Cloud::Tasks::V2::Queue.
306
+ # p item
307
+ # end
308
+ #
270
309
  def list_queues request, options = nil
271
310
  raise ::ArgumentError, "request must be provided" if request.nil?
272
311
 
@@ -331,6 +370,22 @@ module Google
331
370
  # @return [::Google::Cloud::Tasks::V2::Queue]
332
371
  #
333
372
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
373
+ #
374
+ # @example Basic example
375
+ # require "google/cloud/tasks/v2"
376
+ #
377
+ # # Create a client object. The client can be reused for multiple calls.
378
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
379
+ #
380
+ # # Create a request. To set request fields, pass in keyword arguments.
381
+ # request = Google::Cloud::Tasks::V2::GetQueueRequest.new
382
+ #
383
+ # # Call the get_queue method.
384
+ # result = client.get_queue request
385
+ #
386
+ # # The returned object is of type Google::Cloud::Tasks::V2::Queue.
387
+ # p result
388
+ #
334
389
  def get_queue request, options = nil
335
390
  raise ::ArgumentError, "request must be provided" if request.nil?
336
391
 
@@ -414,6 +469,22 @@ module Google
414
469
  # @return [::Google::Cloud::Tasks::V2::Queue]
415
470
  #
416
471
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
472
+ #
473
+ # @example Basic example
474
+ # require "google/cloud/tasks/v2"
475
+ #
476
+ # # Create a client object. The client can be reused for multiple calls.
477
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
478
+ #
479
+ # # Create a request. To set request fields, pass in keyword arguments.
480
+ # request = Google::Cloud::Tasks::V2::CreateQueueRequest.new
481
+ #
482
+ # # Call the create_queue method.
483
+ # result = client.create_queue request
484
+ #
485
+ # # The returned object is of type Google::Cloud::Tasks::V2::Queue.
486
+ # p result
487
+ #
417
488
  def create_queue request, options = nil
418
489
  raise ::ArgumentError, "request must be provided" if request.nil?
419
490
 
@@ -500,6 +571,22 @@ module Google
500
571
  # @return [::Google::Cloud::Tasks::V2::Queue]
501
572
  #
502
573
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
574
+ #
575
+ # @example Basic example
576
+ # require "google/cloud/tasks/v2"
577
+ #
578
+ # # Create a client object. The client can be reused for multiple calls.
579
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
580
+ #
581
+ # # Create a request. To set request fields, pass in keyword arguments.
582
+ # request = Google::Cloud::Tasks::V2::UpdateQueueRequest.new
583
+ #
584
+ # # Call the update_queue method.
585
+ # result = client.update_queue request
586
+ #
587
+ # # The returned object is of type Google::Cloud::Tasks::V2::Queue.
588
+ # p result
589
+ #
503
590
  def update_queue request, options = nil
504
591
  raise ::ArgumentError, "request must be provided" if request.nil?
505
592
 
@@ -575,6 +662,22 @@ module Google
575
662
  # @return [::Google::Protobuf::Empty]
576
663
  #
577
664
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
665
+ #
666
+ # @example Basic example
667
+ # require "google/cloud/tasks/v2"
668
+ #
669
+ # # Create a client object. The client can be reused for multiple calls.
670
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
671
+ #
672
+ # # Create a request. To set request fields, pass in keyword arguments.
673
+ # request = Google::Cloud::Tasks::V2::DeleteQueueRequest.new
674
+ #
675
+ # # Call the delete_queue method.
676
+ # result = client.delete_queue request
677
+ #
678
+ # # The returned object is of type Google::Protobuf::Empty.
679
+ # p result
680
+ #
578
681
  def delete_queue request, options = nil
579
682
  raise ::ArgumentError, "request must be provided" if request.nil?
580
683
 
@@ -643,6 +746,22 @@ module Google
643
746
  # @return [::Google::Cloud::Tasks::V2::Queue]
644
747
  #
645
748
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
749
+ #
750
+ # @example Basic example
751
+ # require "google/cloud/tasks/v2"
752
+ #
753
+ # # Create a client object. The client can be reused for multiple calls.
754
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
755
+ #
756
+ # # Create a request. To set request fields, pass in keyword arguments.
757
+ # request = Google::Cloud::Tasks::V2::PurgeQueueRequest.new
758
+ #
759
+ # # Call the purge_queue method.
760
+ # result = client.purge_queue request
761
+ #
762
+ # # The returned object is of type Google::Cloud::Tasks::V2::Queue.
763
+ # p result
764
+ #
646
765
  def purge_queue request, options = nil
647
766
  raise ::ArgumentError, "request must be provided" if request.nil?
648
767
 
@@ -713,6 +832,22 @@ module Google
713
832
  # @return [::Google::Cloud::Tasks::V2::Queue]
714
833
  #
715
834
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
835
+ #
836
+ # @example Basic example
837
+ # require "google/cloud/tasks/v2"
838
+ #
839
+ # # Create a client object. The client can be reused for multiple calls.
840
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
841
+ #
842
+ # # Create a request. To set request fields, pass in keyword arguments.
843
+ # request = Google::Cloud::Tasks::V2::PauseQueueRequest.new
844
+ #
845
+ # # Call the pause_queue method.
846
+ # result = client.pause_queue request
847
+ #
848
+ # # The returned object is of type Google::Cloud::Tasks::V2::Queue.
849
+ # p result
850
+ #
716
851
  def pause_queue request, options = nil
717
852
  raise ::ArgumentError, "request must be provided" if request.nil?
718
853
 
@@ -789,6 +924,22 @@ module Google
789
924
  # @return [::Google::Cloud::Tasks::V2::Queue]
790
925
  #
791
926
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
927
+ #
928
+ # @example Basic example
929
+ # require "google/cloud/tasks/v2"
930
+ #
931
+ # # Create a client object. The client can be reused for multiple calls.
932
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
933
+ #
934
+ # # Create a request. To set request fields, pass in keyword arguments.
935
+ # request = Google::Cloud::Tasks::V2::ResumeQueueRequest.new
936
+ #
937
+ # # Call the resume_queue method.
938
+ # result = client.resume_queue request
939
+ #
940
+ # # The returned object is of type Google::Cloud::Tasks::V2::Queue.
941
+ # p result
942
+ #
792
943
  def resume_queue request, options = nil
793
944
  raise ::ArgumentError, "request must be provided" if request.nil?
794
945
 
@@ -863,6 +1014,22 @@ module Google
863
1014
  # @return [::Google::Iam::V1::Policy]
864
1015
  #
865
1016
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1017
+ #
1018
+ # @example Basic example
1019
+ # require "google/cloud/tasks/v2"
1020
+ #
1021
+ # # Create a client object. The client can be reused for multiple calls.
1022
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
1023
+ #
1024
+ # # Create a request. To set request fields, pass in keyword arguments.
1025
+ # request = Google::Iam::V1::GetIamPolicyRequest.new
1026
+ #
1027
+ # # Call the get_iam_policy method.
1028
+ # result = client.get_iam_policy request
1029
+ #
1030
+ # # The returned object is of type Google::Iam::V1::Policy.
1031
+ # p result
1032
+ #
866
1033
  def get_iam_policy request, options = nil
867
1034
  raise ::ArgumentError, "request must be provided" if request.nil?
868
1035
 
@@ -947,6 +1114,22 @@ module Google
947
1114
  # @return [::Google::Iam::V1::Policy]
948
1115
  #
949
1116
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1117
+ #
1118
+ # @example Basic example
1119
+ # require "google/cloud/tasks/v2"
1120
+ #
1121
+ # # Create a client object. The client can be reused for multiple calls.
1122
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
1123
+ #
1124
+ # # Create a request. To set request fields, pass in keyword arguments.
1125
+ # request = Google::Iam::V1::SetIamPolicyRequest.new
1126
+ #
1127
+ # # Call the set_iam_policy method.
1128
+ # result = client.set_iam_policy request
1129
+ #
1130
+ # # The returned object is of type Google::Iam::V1::Policy.
1131
+ # p result
1132
+ #
950
1133
  def set_iam_policy request, options = nil
951
1134
  raise ::ArgumentError, "request must be provided" if request.nil?
952
1135
 
@@ -1022,6 +1205,22 @@ module Google
1022
1205
  # @return [::Google::Iam::V1::TestIamPermissionsResponse]
1023
1206
  #
1024
1207
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1208
+ #
1209
+ # @example Basic example
1210
+ # require "google/cloud/tasks/v2"
1211
+ #
1212
+ # # Create a client object. The client can be reused for multiple calls.
1213
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
1214
+ #
1215
+ # # Create a request. To set request fields, pass in keyword arguments.
1216
+ # request = Google::Iam::V1::TestIamPermissionsRequest.new
1217
+ #
1218
+ # # Call the test_iam_permissions method.
1219
+ # result = client.test_iam_permissions request
1220
+ #
1221
+ # # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
1222
+ # p result
1223
+ #
1025
1224
  def test_iam_permissions request, options = nil
1026
1225
  raise ::ArgumentError, "request must be provided" if request.nil?
1027
1226
 
@@ -1125,6 +1324,26 @@ module Google
1125
1324
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2::Task>]
1126
1325
  #
1127
1326
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1327
+ #
1328
+ # @example Basic example
1329
+ # require "google/cloud/tasks/v2"
1330
+ #
1331
+ # # Create a client object. The client can be reused for multiple calls.
1332
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
1333
+ #
1334
+ # # Create a request. To set request fields, pass in keyword arguments.
1335
+ # request = Google::Cloud::Tasks::V2::ListTasksRequest.new
1336
+ #
1337
+ # # Call the list_tasks method.
1338
+ # result = client.list_tasks request
1339
+ #
1340
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1341
+ # # over elements, and API calls will be issued to fetch pages as needed.
1342
+ # result.each do |item|
1343
+ # # Each element is of type ::Google::Cloud::Tasks::V2::Task.
1344
+ # p item
1345
+ # end
1346
+ #
1128
1347
  def list_tasks request, options = nil
1129
1348
  raise ::ArgumentError, "request must be provided" if request.nil?
1130
1349
 
@@ -1202,6 +1421,22 @@ module Google
1202
1421
  # @return [::Google::Cloud::Tasks::V2::Task]
1203
1422
  #
1204
1423
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1424
+ #
1425
+ # @example Basic example
1426
+ # require "google/cloud/tasks/v2"
1427
+ #
1428
+ # # Create a client object. The client can be reused for multiple calls.
1429
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
1430
+ #
1431
+ # # Create a request. To set request fields, pass in keyword arguments.
1432
+ # request = Google::Cloud::Tasks::V2::GetTaskRequest.new
1433
+ #
1434
+ # # Call the get_task method.
1435
+ # result = client.get_task request
1436
+ #
1437
+ # # The returned object is of type Google::Cloud::Tasks::V2::Task.
1438
+ # p result
1439
+ #
1205
1440
  def get_task request, options = nil
1206
1441
  raise ::ArgumentError, "request must be provided" if request.nil?
1207
1442
 
@@ -1318,6 +1553,22 @@ module Google
1318
1553
  # @return [::Google::Cloud::Tasks::V2::Task]
1319
1554
  #
1320
1555
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1556
+ #
1557
+ # @example Basic example
1558
+ # require "google/cloud/tasks/v2"
1559
+ #
1560
+ # # Create a client object. The client can be reused for multiple calls.
1561
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
1562
+ #
1563
+ # # Create a request. To set request fields, pass in keyword arguments.
1564
+ # request = Google::Cloud::Tasks::V2::CreateTaskRequest.new
1565
+ #
1566
+ # # Call the create_task method.
1567
+ # result = client.create_task request
1568
+ #
1569
+ # # The returned object is of type Google::Cloud::Tasks::V2::Task.
1570
+ # p result
1571
+ #
1321
1572
  def create_task request, options = nil
1322
1573
  raise ::ArgumentError, "request must be provided" if request.nil?
1323
1574
 
@@ -1385,6 +1636,22 @@ module Google
1385
1636
  # @return [::Google::Protobuf::Empty]
1386
1637
  #
1387
1638
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1639
+ #
1640
+ # @example Basic example
1641
+ # require "google/cloud/tasks/v2"
1642
+ #
1643
+ # # Create a client object. The client can be reused for multiple calls.
1644
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
1645
+ #
1646
+ # # Create a request. To set request fields, pass in keyword arguments.
1647
+ # request = Google::Cloud::Tasks::V2::DeleteTaskRequest.new
1648
+ #
1649
+ # # Call the delete_task method.
1650
+ # result = client.delete_task request
1651
+ #
1652
+ # # The returned object is of type Google::Protobuf::Empty.
1653
+ # p result
1654
+ #
1388
1655
  def delete_task request, options = nil
1389
1656
  raise ::ArgumentError, "request must be provided" if request.nil?
1390
1657
 
@@ -1486,6 +1753,22 @@ module Google
1486
1753
  # @return [::Google::Cloud::Tasks::V2::Task]
1487
1754
  #
1488
1755
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1756
+ #
1757
+ # @example Basic example
1758
+ # require "google/cloud/tasks/v2"
1759
+ #
1760
+ # # Create a client object. The client can be reused for multiple calls.
1761
+ # client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
1762
+ #
1763
+ # # Create a request. To set request fields, pass in keyword arguments.
1764
+ # request = Google::Cloud::Tasks::V2::RunTaskRequest.new
1765
+ #
1766
+ # # Call the run_task method.
1767
+ # result = client.run_task request
1768
+ #
1769
+ # # The returned object is of type Google::Cloud::Tasks::V2::Task.
1770
+ # p result
1771
+ #
1489
1772
  def run_task request, options = nil
1490
1773
  raise ::ArgumentError, "request must be provided" if request.nil?
1491
1774
 
@@ -1551,9 +1834,9 @@ module Google
1551
1834
  # end
1552
1835
  #
1553
1836
  # @!attribute [rw] endpoint
1554
- # The hostname or hostname:port of the service endpoint.
1555
- # Defaults to `"cloudtasks.googleapis.com"`.
1556
- # @return [::String]
1837
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1838
+ # nil, indicating to use the default endpoint in the current universe domain.
1839
+ # @return [::String,nil]
1557
1840
  # @!attribute [rw] credentials
1558
1841
  # Credentials to send with calls. You may provide any of the following types:
1559
1842
  # * (`String`) The path to a service account key file in JSON format
@@ -1590,13 +1873,20 @@ module Google
1590
1873
  # @!attribute [rw] quota_project
1591
1874
  # A separate project against which to charge quota.
1592
1875
  # @return [::String]
1876
+ # @!attribute [rw] universe_domain
1877
+ # The universe domain within which to make requests. This determines the
1878
+ # default endpoint URL. The default value of nil uses the environment
1879
+ # universe (usually the default "googleapis.com" universe).
1880
+ # @return [::String,nil]
1593
1881
  #
1594
1882
  class Configuration
1595
1883
  extend ::Gapic::Config
1596
1884
 
1885
+ # @private
1886
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1597
1887
  DEFAULT_ENDPOINT = "cloudtasks.googleapis.com"
1598
1888
 
1599
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1889
+ config_attr :endpoint, nil, ::String, nil
1600
1890
  config_attr :credentials, nil do |value|
1601
1891
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1602
1892
  allowed.any? { |klass| klass === value }
@@ -1608,6 +1898,7 @@ module Google
1608
1898
  config_attr :metadata, nil, ::Hash, nil
1609
1899
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1610
1900
  config_attr :quota_project, nil, ::String, nil
1901
+ config_attr :universe_domain, nil, ::String, nil
1611
1902
 
1612
1903
  # @private
1613
1904
  # 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, credentials: credentials,
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,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Tasks
23
23
  module V2
24
- VERSION = "0.8.2"
24
+ VERSION = "0.10.0"
25
25
  end
26
26
  end
27
27
  end
@@ -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-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.2
4
+ version: 0.10.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: 2023-08-04 00:00:00.000000000 Z
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.1
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.19.1
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.4'
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.4'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -260,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
260
260
  - !ruby/object:Gem::Version
261
261
  version: '0'
262
262
  requirements: []
263
- rubygems_version: 3.4.2
263
+ rubygems_version: 3.5.3
264
264
  signing_key:
265
265
  specification_version: 4
266
266
  summary: Manages the execution of large numbers of distributed requests.