google-cloud-tasks-v2beta3 0.10.2 → 0.12.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: 8356080b4e035e2c9a8e07545fdca4dd3ed425958090e226c2c0f7ab467c7cea
4
- data.tar.gz: 21e01efade0d5dad096643e5cd01bc4d4e792e51fae65c69e675b537774af403
3
+ metadata.gz: ef9317d4413dbab1dfbec8e2307bdeb2927de2caa30fc1dd781235d9b9f258c6
4
+ data.tar.gz: 6b67b22d8b4bf1d61986adbbe491dba675fe4cf4c421f28e71ec278dc65ee21d
5
5
  SHA512:
6
- metadata.gz: 1c207c60837703c273a57f3b577ee3c4300392fcb5ac97ccccfdf28b8bc9c23519475969f6c872e575eaac234f507ad398ebb6cb1811ae3fe2a517cf3734e73f
7
- data.tar.gz: e24b740c37d9db8fd86f0ddbff2d3f2ef97d9a2073f70477a6feb5b82cbab2946edbf7b90dc9da37ade3bcd9e059049603cce707dcaced547ffe2be31e08b323
6
+ metadata.gz: 39f4b7361742e36b99587e674203121d942ccae1151abe762e32b7f87bf87736006bf8d8c966f45b0495b93061dabccf2ebaa7ccf3f5818df16128e6fe940c85
7
+ data.tar.gz: f8262dcdeeba38597ca9682544c62cb670d8b47c5525570effb4caff622419bdc32d9527a6c80a0323f7219f0d5526325fde1b71f3bb7493905392e9daf88a51
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-tasks-v2beta3 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-v2beta3 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/v2beta3"
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::V2beta3::CloudTasks::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-tasks-v2beta3 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-v2beta3 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-v2beta3
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Tasks::V2beta3::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/v2beta3"
77
-
78
- ENV["TASKS_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Tasks::V2beta3::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/v2beta3"
90
58
 
91
59
  client = ::Google::Cloud::Tasks::V2beta3::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/v2beta3"
100
68
 
101
69
  ::Google::Cloud::Tasks::V2beta3::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::V2beta3::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-v2beta3
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/v2beta3"
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-v2beta3.
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::V2beta3::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
@@ -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 client object.
155
167
  #
@@ -183,8 +195,9 @@ module Google
183
195
  credentials = @config.credentials
184
196
  # Use self-signed JWT if the endpoint is unchanged from default,
185
197
  # but only if the default endpoint does not have a region prefix.
186
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
187
- !@config.endpoint.split(".").first.include?("-")
198
+ enable_self_signed_jwt = @config.endpoint.nil? ||
199
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
200
+ !@config.endpoint.split(".").first.include?("-"))
188
201
  credentials ||= Credentials.default scope: @config.scope,
189
202
  enable_self_signed_jwt: enable_self_signed_jwt
190
203
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -197,14 +210,18 @@ module Google
197
210
  config.credentials = credentials
198
211
  config.quota_project = @quota_project_id
199
212
  config.endpoint = @config.endpoint
213
+ config.universe_domain = @config.universe_domain
200
214
  end
201
215
 
202
216
  @cloud_tasks_stub = ::Gapic::ServiceStub.new(
203
217
  ::Google::Cloud::Tasks::V2beta3::CloudTasks::Stub,
204
- credentials: credentials,
205
- endpoint: @config.endpoint,
218
+ credentials: credentials,
219
+ endpoint: @config.endpoint,
220
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
221
+ universe_domain: @config.universe_domain,
206
222
  channel_args: @config.channel_args,
207
- interceptors: @config.interceptors
223
+ interceptors: @config.interceptors,
224
+ channel_pool_config: @config.channel_pool
208
225
  )
209
226
  end
210
227
 
@@ -2064,9 +2081,9 @@ module Google
2064
2081
  # end
2065
2082
  #
2066
2083
  # @!attribute [rw] endpoint
2067
- # The hostname or hostname:port of the service endpoint.
2068
- # Defaults to `"cloudtasks.googleapis.com"`.
2069
- # @return [::String]
2084
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2085
+ # nil, indicating to use the default endpoint in the current universe domain.
2086
+ # @return [::String,nil]
2070
2087
  # @!attribute [rw] credentials
2071
2088
  # Credentials to send with calls. You may provide any of the following types:
2072
2089
  # * (`String`) The path to a service account key file in JSON format
@@ -2112,13 +2129,20 @@ module Google
2112
2129
  # @!attribute [rw] quota_project
2113
2130
  # A separate project against which to charge quota.
2114
2131
  # @return [::String]
2132
+ # @!attribute [rw] universe_domain
2133
+ # The universe domain within which to make requests. This determines the
2134
+ # default endpoint URL. The default value of nil uses the environment
2135
+ # universe (usually the default "googleapis.com" universe).
2136
+ # @return [::String,nil]
2115
2137
  #
2116
2138
  class Configuration
2117
2139
  extend ::Gapic::Config
2118
2140
 
2141
+ # @private
2142
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2119
2143
  DEFAULT_ENDPOINT = "cloudtasks.googleapis.com"
2120
2144
 
2121
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2145
+ config_attr :endpoint, nil, ::String, nil
2122
2146
  config_attr :credentials, nil do |value|
2123
2147
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2124
2148
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2133,6 +2157,7 @@ module Google
2133
2157
  config_attr :metadata, nil, ::Hash, nil
2134
2158
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2135
2159
  config_attr :quota_project, nil, ::String, nil
2160
+ config_attr :universe_domain, nil, ::String, nil
2136
2161
 
2137
2162
  # @private
2138
2163
  def initialize parent_config = nil
@@ -2153,6 +2178,14 @@ module Google
2153
2178
  end
2154
2179
  end
2155
2180
 
2181
+ ##
2182
+ # Configuration for the channel pool
2183
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
2184
+ #
2185
+ def channel_pool
2186
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
2187
+ end
2188
+
2156
2189
  ##
2157
2190
  # Configuration RPC class for the CloudTasks API.
2158
2191
  #
@@ -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
@@ -152,6 +155,15 @@ module Google
152
155
  @config
153
156
  end
154
157
 
158
+ ##
159
+ # The effective universe domain
160
+ #
161
+ # @return [String]
162
+ #
163
+ def universe_domain
164
+ @cloud_tasks_stub.universe_domain
165
+ end
166
+
155
167
  ##
156
168
  # Create a new CloudTasks REST client object.
157
169
  #
@@ -179,8 +191,9 @@ module Google
179
191
  credentials = @config.credentials
180
192
  # Use self-signed JWT if the endpoint is unchanged from default,
181
193
  # but only if the default endpoint does not have a region prefix.
182
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
183
- !@config.endpoint.split(".").first.include?("-")
194
+ enable_self_signed_jwt = @config.endpoint.nil? ||
195
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
196
+ !@config.endpoint.split(".").first.include?("-"))
184
197
  credentials ||= Credentials.default scope: @config.scope,
185
198
  enable_self_signed_jwt: enable_self_signed_jwt
186
199
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -194,10 +207,16 @@ module Google
194
207
  config.credentials = credentials
195
208
  config.quota_project = @quota_project_id
196
209
  config.endpoint = @config.endpoint
210
+ config.universe_domain = @config.universe_domain
197
211
  config.bindings_override = @config.bindings_override
198
212
  end
199
213
 
200
- @cloud_tasks_stub = ::Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
214
+ @cloud_tasks_stub = ::Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::ServiceStub.new(
215
+ endpoint: @config.endpoint,
216
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
217
+ universe_domain: @config.universe_domain,
218
+ credentials: credentials
219
+ )
201
220
  end
202
221
 
203
222
  ##
@@ -274,6 +293,26 @@ module Google
274
293
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2beta3::Queue>]
275
294
  #
276
295
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
296
+ #
297
+ # @example Basic example
298
+ # require "google/cloud/tasks/v2beta3"
299
+ #
300
+ # # Create a client object. The client can be reused for multiple calls.
301
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
302
+ #
303
+ # # Create a request. To set request fields, pass in keyword arguments.
304
+ # request = Google::Cloud::Tasks::V2beta3::ListQueuesRequest.new
305
+ #
306
+ # # Call the list_queues method.
307
+ # result = client.list_queues request
308
+ #
309
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
310
+ # # over elements, and API calls will be issued to fetch pages as needed.
311
+ # result.each do |item|
312
+ # # Each element is of type ::Google::Cloud::Tasks::V2beta3::Queue.
313
+ # p item
314
+ # end
315
+ #
277
316
  def list_queues request, options = nil
278
317
  raise ::ArgumentError, "request must be provided" if request.nil?
279
318
 
@@ -343,6 +382,22 @@ module Google
343
382
  # @return [::Google::Cloud::Tasks::V2beta3::Queue]
344
383
  #
345
384
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
385
+ #
386
+ # @example Basic example
387
+ # require "google/cloud/tasks/v2beta3"
388
+ #
389
+ # # Create a client object. The client can be reused for multiple calls.
390
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
391
+ #
392
+ # # Create a request. To set request fields, pass in keyword arguments.
393
+ # request = Google::Cloud::Tasks::V2beta3::GetQueueRequest.new
394
+ #
395
+ # # Call the get_queue method.
396
+ # result = client.get_queue request
397
+ #
398
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::Queue.
399
+ # p result
400
+ #
346
401
  def get_queue request, options = nil
347
402
  raise ::ArgumentError, "request must be provided" if request.nil?
348
403
 
@@ -426,6 +481,22 @@ module Google
426
481
  # @return [::Google::Cloud::Tasks::V2beta3::Queue]
427
482
  #
428
483
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
484
+ #
485
+ # @example Basic example
486
+ # require "google/cloud/tasks/v2beta3"
487
+ #
488
+ # # Create a client object. The client can be reused for multiple calls.
489
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
490
+ #
491
+ # # Create a request. To set request fields, pass in keyword arguments.
492
+ # request = Google::Cloud::Tasks::V2beta3::CreateQueueRequest.new
493
+ #
494
+ # # Call the create_queue method.
495
+ # result = client.create_queue request
496
+ #
497
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::Queue.
498
+ # p result
499
+ #
429
500
  def create_queue request, options = nil
430
501
  raise ::ArgumentError, "request must be provided" if request.nil?
431
502
 
@@ -514,6 +585,22 @@ module Google
514
585
  # @return [::Google::Cloud::Tasks::V2beta3::Queue]
515
586
  #
516
587
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
588
+ #
589
+ # @example Basic example
590
+ # require "google/cloud/tasks/v2beta3"
591
+ #
592
+ # # Create a client object. The client can be reused for multiple calls.
593
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
594
+ #
595
+ # # Create a request. To set request fields, pass in keyword arguments.
596
+ # request = Google::Cloud::Tasks::V2beta3::UpdateQueueRequest.new
597
+ #
598
+ # # Call the update_queue method.
599
+ # result = client.update_queue request
600
+ #
601
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::Queue.
602
+ # p result
603
+ #
517
604
  def update_queue request, options = nil
518
605
  raise ::ArgumentError, "request must be provided" if request.nil?
519
606
 
@@ -589,6 +676,22 @@ module Google
589
676
  # @return [::Google::Protobuf::Empty]
590
677
  #
591
678
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
679
+ #
680
+ # @example Basic example
681
+ # require "google/cloud/tasks/v2beta3"
682
+ #
683
+ # # Create a client object. The client can be reused for multiple calls.
684
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
685
+ #
686
+ # # Create a request. To set request fields, pass in keyword arguments.
687
+ # request = Google::Cloud::Tasks::V2beta3::DeleteQueueRequest.new
688
+ #
689
+ # # Call the delete_queue method.
690
+ # result = client.delete_queue request
691
+ #
692
+ # # The returned object is of type Google::Protobuf::Empty.
693
+ # p result
694
+ #
592
695
  def delete_queue request, options = nil
593
696
  raise ::ArgumentError, "request must be provided" if request.nil?
594
697
 
@@ -657,6 +760,22 @@ module Google
657
760
  # @return [::Google::Cloud::Tasks::V2beta3::Queue]
658
761
  #
659
762
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
763
+ #
764
+ # @example Basic example
765
+ # require "google/cloud/tasks/v2beta3"
766
+ #
767
+ # # Create a client object. The client can be reused for multiple calls.
768
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
769
+ #
770
+ # # Create a request. To set request fields, pass in keyword arguments.
771
+ # request = Google::Cloud::Tasks::V2beta3::PurgeQueueRequest.new
772
+ #
773
+ # # Call the purge_queue method.
774
+ # result = client.purge_queue request
775
+ #
776
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::Queue.
777
+ # p result
778
+ #
660
779
  def purge_queue request, options = nil
661
780
  raise ::ArgumentError, "request must be provided" if request.nil?
662
781
 
@@ -727,6 +846,22 @@ module Google
727
846
  # @return [::Google::Cloud::Tasks::V2beta3::Queue]
728
847
  #
729
848
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
849
+ #
850
+ # @example Basic example
851
+ # require "google/cloud/tasks/v2beta3"
852
+ #
853
+ # # Create a client object. The client can be reused for multiple calls.
854
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
855
+ #
856
+ # # Create a request. To set request fields, pass in keyword arguments.
857
+ # request = Google::Cloud::Tasks::V2beta3::PauseQueueRequest.new
858
+ #
859
+ # # Call the pause_queue method.
860
+ # result = client.pause_queue request
861
+ #
862
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::Queue.
863
+ # p result
864
+ #
730
865
  def pause_queue request, options = nil
731
866
  raise ::ArgumentError, "request must be provided" if request.nil?
732
867
 
@@ -804,6 +939,22 @@ module Google
804
939
  # @return [::Google::Cloud::Tasks::V2beta3::Queue]
805
940
  #
806
941
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
942
+ #
943
+ # @example Basic example
944
+ # require "google/cloud/tasks/v2beta3"
945
+ #
946
+ # # Create a client object. The client can be reused for multiple calls.
947
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
948
+ #
949
+ # # Create a request. To set request fields, pass in keyword arguments.
950
+ # request = Google::Cloud::Tasks::V2beta3::ResumeQueueRequest.new
951
+ #
952
+ # # Call the resume_queue method.
953
+ # result = client.resume_queue request
954
+ #
955
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::Queue.
956
+ # p result
957
+ #
807
958
  def resume_queue request, options = nil
808
959
  raise ::ArgumentError, "request must be provided" if request.nil?
809
960
 
@@ -878,6 +1029,22 @@ module Google
878
1029
  # @return [::Google::Iam::V1::Policy]
879
1030
  #
880
1031
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1032
+ #
1033
+ # @example Basic example
1034
+ # require "google/cloud/tasks/v2beta3"
1035
+ #
1036
+ # # Create a client object. The client can be reused for multiple calls.
1037
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
1038
+ #
1039
+ # # Create a request. To set request fields, pass in keyword arguments.
1040
+ # request = Google::Iam::V1::GetIamPolicyRequest.new
1041
+ #
1042
+ # # Call the get_iam_policy method.
1043
+ # result = client.get_iam_policy request
1044
+ #
1045
+ # # The returned object is of type Google::Iam::V1::Policy.
1046
+ # p result
1047
+ #
881
1048
  def get_iam_policy request, options = nil
882
1049
  raise ::ArgumentError, "request must be provided" if request.nil?
883
1050
 
@@ -962,6 +1129,22 @@ module Google
962
1129
  # @return [::Google::Iam::V1::Policy]
963
1130
  #
964
1131
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1132
+ #
1133
+ # @example Basic example
1134
+ # require "google/cloud/tasks/v2beta3"
1135
+ #
1136
+ # # Create a client object. The client can be reused for multiple calls.
1137
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
1138
+ #
1139
+ # # Create a request. To set request fields, pass in keyword arguments.
1140
+ # request = Google::Iam::V1::SetIamPolicyRequest.new
1141
+ #
1142
+ # # Call the set_iam_policy method.
1143
+ # result = client.set_iam_policy request
1144
+ #
1145
+ # # The returned object is of type Google::Iam::V1::Policy.
1146
+ # p result
1147
+ #
965
1148
  def set_iam_policy request, options = nil
966
1149
  raise ::ArgumentError, "request must be provided" if request.nil?
967
1150
 
@@ -1037,6 +1220,22 @@ module Google
1037
1220
  # @return [::Google::Iam::V1::TestIamPermissionsResponse]
1038
1221
  #
1039
1222
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1223
+ #
1224
+ # @example Basic example
1225
+ # require "google/cloud/tasks/v2beta3"
1226
+ #
1227
+ # # Create a client object. The client can be reused for multiple calls.
1228
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
1229
+ #
1230
+ # # Create a request. To set request fields, pass in keyword arguments.
1231
+ # request = Google::Iam::V1::TestIamPermissionsRequest.new
1232
+ #
1233
+ # # Call the test_iam_permissions method.
1234
+ # result = client.test_iam_permissions request
1235
+ #
1236
+ # # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
1237
+ # p result
1238
+ #
1040
1239
  def test_iam_permissions request, options = nil
1041
1240
  raise ::ArgumentError, "request must be provided" if request.nil?
1042
1241
 
@@ -1141,6 +1340,26 @@ module Google
1141
1340
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2beta3::Task>]
1142
1341
  #
1143
1342
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1343
+ #
1344
+ # @example Basic example
1345
+ # require "google/cloud/tasks/v2beta3"
1346
+ #
1347
+ # # Create a client object. The client can be reused for multiple calls.
1348
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
1349
+ #
1350
+ # # Create a request. To set request fields, pass in keyword arguments.
1351
+ # request = Google::Cloud::Tasks::V2beta3::ListTasksRequest.new
1352
+ #
1353
+ # # Call the list_tasks method.
1354
+ # result = client.list_tasks request
1355
+ #
1356
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1357
+ # # over elements, and API calls will be issued to fetch pages as needed.
1358
+ # result.each do |item|
1359
+ # # Each element is of type ::Google::Cloud::Tasks::V2beta3::Task.
1360
+ # p item
1361
+ # end
1362
+ #
1144
1363
  def list_tasks request, options = nil
1145
1364
  raise ::ArgumentError, "request must be provided" if request.nil?
1146
1365
 
@@ -1219,6 +1438,22 @@ module Google
1219
1438
  # @return [::Google::Cloud::Tasks::V2beta3::Task]
1220
1439
  #
1221
1440
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1441
+ #
1442
+ # @example Basic example
1443
+ # require "google/cloud/tasks/v2beta3"
1444
+ #
1445
+ # # Create a client object. The client can be reused for multiple calls.
1446
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
1447
+ #
1448
+ # # Create a request. To set request fields, pass in keyword arguments.
1449
+ # request = Google::Cloud::Tasks::V2beta3::GetTaskRequest.new
1450
+ #
1451
+ # # Call the get_task method.
1452
+ # result = client.get_task request
1453
+ #
1454
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::Task.
1455
+ # p result
1456
+ #
1222
1457
  def get_task request, options = nil
1223
1458
  raise ::ArgumentError, "request must be provided" if request.nil?
1224
1459
 
@@ -1336,6 +1571,22 @@ module Google
1336
1571
  # @return [::Google::Cloud::Tasks::V2beta3::Task]
1337
1572
  #
1338
1573
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1574
+ #
1575
+ # @example Basic example
1576
+ # require "google/cloud/tasks/v2beta3"
1577
+ #
1578
+ # # Create a client object. The client can be reused for multiple calls.
1579
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
1580
+ #
1581
+ # # Create a request. To set request fields, pass in keyword arguments.
1582
+ # request = Google::Cloud::Tasks::V2beta3::CreateTaskRequest.new
1583
+ #
1584
+ # # Call the create_task method.
1585
+ # result = client.create_task request
1586
+ #
1587
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::Task.
1588
+ # p result
1589
+ #
1339
1590
  def create_task request, options = nil
1340
1591
  raise ::ArgumentError, "request must be provided" if request.nil?
1341
1592
 
@@ -1403,6 +1654,22 @@ module Google
1403
1654
  # @return [::Google::Protobuf::Empty]
1404
1655
  #
1405
1656
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1657
+ #
1658
+ # @example Basic example
1659
+ # require "google/cloud/tasks/v2beta3"
1660
+ #
1661
+ # # Create a client object. The client can be reused for multiple calls.
1662
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
1663
+ #
1664
+ # # Create a request. To set request fields, pass in keyword arguments.
1665
+ # request = Google::Cloud::Tasks::V2beta3::DeleteTaskRequest.new
1666
+ #
1667
+ # # Call the delete_task method.
1668
+ # result = client.delete_task request
1669
+ #
1670
+ # # The returned object is of type Google::Protobuf::Empty.
1671
+ # p result
1672
+ #
1406
1673
  def delete_task request, options = nil
1407
1674
  raise ::ArgumentError, "request must be provided" if request.nil?
1408
1675
 
@@ -1506,6 +1773,22 @@ module Google
1506
1773
  # @return [::Google::Cloud::Tasks::V2beta3::Task]
1507
1774
  #
1508
1775
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1776
+ #
1777
+ # @example Basic example
1778
+ # require "google/cloud/tasks/v2beta3"
1779
+ #
1780
+ # # Create a client object. The client can be reused for multiple calls.
1781
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
1782
+ #
1783
+ # # Create a request. To set request fields, pass in keyword arguments.
1784
+ # request = Google::Cloud::Tasks::V2beta3::RunTaskRequest.new
1785
+ #
1786
+ # # Call the run_task method.
1787
+ # result = client.run_task request
1788
+ #
1789
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::Task.
1790
+ # p result
1791
+ #
1509
1792
  def run_task request, options = nil
1510
1793
  raise ::ArgumentError, "request must be provided" if request.nil?
1511
1794
 
@@ -1589,6 +1872,22 @@ module Google
1589
1872
  # @return [::Google::Cloud::Tasks::V2beta3::BufferTaskResponse]
1590
1873
  #
1591
1874
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1875
+ #
1876
+ # @example Basic example
1877
+ # require "google/cloud/tasks/v2beta3"
1878
+ #
1879
+ # # Create a client object. The client can be reused for multiple calls.
1880
+ # client = Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new
1881
+ #
1882
+ # # Create a request. To set request fields, pass in keyword arguments.
1883
+ # request = Google::Cloud::Tasks::V2beta3::BufferTaskRequest.new
1884
+ #
1885
+ # # Call the buffer_task method.
1886
+ # result = client.buffer_task request
1887
+ #
1888
+ # # The returned object is of type Google::Cloud::Tasks::V2beta3::BufferTaskResponse.
1889
+ # p result
1890
+ #
1592
1891
  def buffer_task request, options = nil
1593
1892
  raise ::ArgumentError, "request must be provided" if request.nil?
1594
1893
 
@@ -1654,9 +1953,9 @@ module Google
1654
1953
  # end
1655
1954
  #
1656
1955
  # @!attribute [rw] endpoint
1657
- # The hostname or hostname:port of the service endpoint.
1658
- # Defaults to `"cloudtasks.googleapis.com"`.
1659
- # @return [::String]
1956
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1957
+ # nil, indicating to use the default endpoint in the current universe domain.
1958
+ # @return [::String,nil]
1660
1959
  # @!attribute [rw] credentials
1661
1960
  # Credentials to send with calls. You may provide any of the following types:
1662
1961
  # * (`String`) The path to a service account key file in JSON format
@@ -1693,13 +1992,20 @@ module Google
1693
1992
  # @!attribute [rw] quota_project
1694
1993
  # A separate project against which to charge quota.
1695
1994
  # @return [::String]
1995
+ # @!attribute [rw] universe_domain
1996
+ # The universe domain within which to make requests. This determines the
1997
+ # default endpoint URL. The default value of nil uses the environment
1998
+ # universe (usually the default "googleapis.com" universe).
1999
+ # @return [::String,nil]
1696
2000
  #
1697
2001
  class Configuration
1698
2002
  extend ::Gapic::Config
1699
2003
 
2004
+ # @private
2005
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1700
2006
  DEFAULT_ENDPOINT = "cloudtasks.googleapis.com"
1701
2007
 
1702
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2008
+ config_attr :endpoint, nil, ::String, nil
1703
2009
  config_attr :credentials, nil do |value|
1704
2010
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1705
2011
  allowed.any? { |klass| klass === value }
@@ -1711,6 +2017,7 @@ module Google
1711
2017
  config_attr :metadata, nil, ::Hash, nil
1712
2018
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1713
2019
  config_attr :quota_project, nil, ::String, nil
2020
+ config_attr :universe_domain, nil, ::String, nil
1714
2021
 
1715
2022
  # @private
1716
2023
  # 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 V2beta3
24
- VERSION = "0.10.2"
24
+ VERSION = "0.12.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-v2beta3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.2
4
+ version: 0.12.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
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
261
261
  - !ruby/object:Gem::Version
262
262
  version: '0'
263
263
  requirements: []
264
- rubygems_version: 3.4.2
264
+ rubygems_version: 3.5.3
265
265
  signing_key:
266
266
  specification_version: 4
267
267
  summary: Manages the execution of large numbers of distributed requests.