Class: Google::Cloud::Tasks::V2beta3::CloudTasksClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb,
lib/google/cloud/tasks/v2beta3/helpers.rb

Overview

Cloud Tasks allows developers to manage the execution of background work in their applications.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"cloudtasks.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ CloudTasksClient

Returns a new instance of CloudTasksClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 176

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/cloud/tasks/v2beta3/cloudtasks_services_pb"

  credentials ||= Google::Cloud::Tasks::V2beta3::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Tasks::V2beta3::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-tasks'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "cloud_tasks_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.tasks.v2beta3.CloudTasks",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @cloud_tasks_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Tasks::V2beta3::CloudTasks::Stub.method(:new)
  )

  @list_queues = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:list_queues),
    defaults["list_queues"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_queue = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:get_queue),
    defaults["get_queue"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_queue = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:create_queue),
    defaults["create_queue"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_queue = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:update_queue),
    defaults["update_queue"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'queue.name' => request.queue.name}
    end
  )
  @delete_queue = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:delete_queue),
    defaults["delete_queue"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @purge_queue = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:purge_queue),
    defaults["purge_queue"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @pause_queue = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:pause_queue),
    defaults["pause_queue"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @resume_queue = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:resume_queue),
    defaults["resume_queue"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_iam_policy = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:get_iam_policy),
    defaults["get_iam_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @set_iam_policy = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:set_iam_policy),
    defaults["set_iam_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @test_iam_permissions = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:test_iam_permissions),
    defaults["test_iam_permissions"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @list_tasks = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:list_tasks),
    defaults["list_tasks"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_task = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:get_task),
    defaults["get_task"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_task = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:create_task),
    defaults["create_task"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @delete_task = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:delete_task),
    defaults["delete_task"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @run_task = Google::Gax.create_api_call(
    @cloud_tasks_stub.method(:run_task),
    defaults["run_task"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
end

Class Method Details

.location_path(project, location) ⇒ String

Returns a fully-qualified location resource name string.

Parameters:

  • project (String)
  • location (String)

Returns:

  • (String) 


103
104
105
106
107
108
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 103

def self.location_path project, location
  LOCATION_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


113
114
115
116
117
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 113

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

.queue_path(project, location, queue) ⇒ String

Returns a fully-qualified queue resource name string.

Parameters:

  • project (String)
  • location (String)
  • queue (String)

Returns:

  • (String) 


124
125
126
127
128
129
130
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 124

def self.queue_path project, location, queue
  QUEUE_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location,
    :"queue" => queue
  )
end

.task_path(project, location, queue, task) ⇒ String

Returns a fully-qualified task resource name string.

Parameters:

  • project (String)
  • location (String)
  • queue (String)
  • task (String)

Returns:

  • (String) 


138
139
140
141
142
143
144
145
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 138

def self.task_path project, location, queue, task
  TASK_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location,
    :"queue" => queue,
    :"task" => task
  )
end

Instance Method Details

#create_queue(parent, queue, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Tasks::V2beta3::Queue

Creates a queue.

Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not.

WARNING: Using this method may have unintended side effects if you are using an App Engine queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_parent = Google::Cloud::Tasks::V2beta3::CloudTasksClient.location_path("[PROJECT]", "[LOCATION]")

# TODO: Initialize `queue`:
queue = {}
response = cloud_tasks_client.create_queue(formatted_parent, queue)

Parameters:

  • parent (String) —

    Required.

    The location name in which the queue will be created. For example: projects/PROJECT_ID/locations/LOCATION_ID

    The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations.

  • queue (Google::Cloud::Tasks::V2beta3::Queue | Hash) —

    Required.

    The queue to create.

    Queue's name cannot be the same as an existing queue. A hash of the same form as Google::Cloud::Tasks::V2beta3::Queue can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 534

def create_queue \
    parent,
    queue,
    options: nil,
    &block
  req = {
    parent: parent,
    queue: queue
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::CreateQueueRequest)
  @create_queue.call(req, options, &block)
end

#create_task(parent, task, response_view: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Tasks::V2beta3::Task

Creates a task and adds it to a queue.

Tasks cannot be updated after creation; there is no UpdateTask command.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_parent = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")

# TODO: Initialize `task`:
task = {}
response = cloud_tasks_client.create_task(formatted_parent, task)

Parameters:

  • parent (String) —

    Required.

    The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

    The queue must already exist.

  • task (Google::Cloud::Tasks::V2beta3::Task | Hash) —

    Required.

    The task to add.

    Task names have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response.

    If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time.

    Task De-duplication:

    Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed.

    Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. A hash of the same form as Google::Cloud::Tasks::V2beta3::Task can also be provided.

  • response_view (Google::Cloud::Tasks::V2beta3::Task::View) (defaults to: nil) —

    The response_view specifies which subset of the Task will be returned.

    By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

    Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 1128

def create_task \
    parent,
    task,
    response_view: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    task: task,
    response_view: response_view
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::CreateTaskRequest)
  @create_task.call(req, options, &block)
end

#delete_queue(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes a queue.

This command will delete the queue even if it has tasks in it.

Note: If you delete a queue, a queue with the same name can't be created for 7 days.

WARNING: Using this method may have unintended side effects if you are using an App Engine queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_name = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
cloud_tasks_client.delete_queue(formatted_name)

Parameters:

  • name (String) —

    Required.

    The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 642

def delete_queue \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::DeleteQueueRequest)
  @delete_queue.call(req, options, &block)
  nil
end

#delete_task(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes a task.

A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_name = Google::Cloud::Tasks::V2beta3::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
cloud_tasks_client.delete_task(formatted_name)

Parameters:

  • name (String) —

    Required.

    The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 1168

def delete_task \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::DeleteTaskRequest)
  @delete_task.call(req, options, &block)
  nil
end

#get_iam_policy(resource, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::Policy

Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set.

Authorization requires the following Google IAM permission on the specified resource parent:

  • cloudtasks.queues.getIamPolicy

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_resource = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
response = cloud_tasks_client.get_iam_policy(formatted_resource)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



804
805
806
807
808
809
810
811
812
813
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 804

def get_iam_policy \
    resource,
    options: nil,
    &block
  req = {
    resource: resource
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::GetIamPolicyRequest)
  @get_iam_policy.call(req, options, &block)
end

#get_queue(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Tasks::V2beta3::Queue

Gets a queue.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_name = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
response = cloud_tasks_client.get_queue(formatted_name)

Parameters:

  • name (String) —

    Required.

    The resource name of the queue. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



476
477
478
479
480
481
482
483
484
485
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 476

def get_queue \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::GetQueueRequest)
  @get_queue.call(req, options, &block)
end

#get_task(name, response_view: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Tasks::V2beta3::Task

Gets a task.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_name = Google::Cloud::Tasks::V2beta3::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
response = cloud_tasks_client.get_task(formatted_name)

Parameters:

  • name (String) —

    Required.

    The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

  • response_view (Google::Cloud::Tasks::V2beta3::Task::View) (defaults to: nil) —

    The response_view specifies which subset of the Task will be returned.

    By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

    Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 1032

def get_task \
    name,
    response_view: nil,
    options: nil,
    &block
  req = {
    name: name,
    response_view: response_view
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::GetTaskRequest)
  @get_task.call(req, options, &block)
end

#list_queues(parent, filter: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Tasks::V2beta3::Queue>

Lists queues.

Queues are returned in lexicographical order.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_parent = Google::Cloud::Tasks::V2beta3::CloudTasksClient.location_path("[PROJECT]", "[LOCATION]")

# Iterate over all results.
cloud_tasks_client.list_queues(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
cloud_tasks_client.list_queues(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required.

    The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID

  • filter (String) (defaults to: nil) —

    filter can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: <=, <, >=, >, !=, =, :. The filter syntax is the same as described in Stackdriver's Advanced Logs Filters.

    Sample filter "state: PAUSED".

    Note that using filters might cause fewer queues than the requested page_size to be returned.

  • page_size (Integer) (defaults to: nil) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Tasks::V2beta3::Queue>) —

    An enumerable of Google::Cloud::Tasks::V2beta3::Queue instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 439

def list_queues \
    parent,
    filter: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    filter: filter,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::ListQueuesRequest)
  @list_queues.call(req, options, &block)
end

#list_tasks(parent, response_view: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Tasks::V2beta3::Task>

Lists the tasks in a queue.

By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned.

The tasks may be returned in any order. The ordering may change at any time.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_parent = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")

# Iterate over all results.
cloud_tasks_client.list_tasks(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
cloud_tasks_client.list_tasks(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required.

    The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

  • response_view (Google::Cloud::Tasks::V2beta3::Task::View) (defaults to: nil) —

    The response_view specifies which subset of the Task will be returned.

    By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

    Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

  • page_size (Integer) (defaults to: nil) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Tasks::V2beta3::Task>) —

    An enumerable of Google::Cloud::Tasks::V2beta3::Task instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 982

def list_tasks \
    parent,
    response_view: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    response_view: response_view,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::ListTasksRequest)
  @list_tasks.call(req, options, &block)
end

#location_path(project, location) ⇒ String

Alias for Google::Cloud::Tasks::V2beta3::CloudTasksClient.location_path.

Parameters:

  • project (String)
  • location (String)

Returns:

  • (String) 


23
24
25
 
# File 'lib/google/cloud/tasks/v2beta3/helpers.rb', line 23

def location_path project, location
  self.class.location_path project, location
end

#pause_queue(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Tasks::V2beta3::Queue

Pauses the queue.

If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_name = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
response = cloud_tasks_client.pause_queue(formatted_name)

Parameters:

  • name (String) —

    Required.

    The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



720
721
722
723
724
725
726
727
728
729
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 720

def pause_queue \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::PauseQueueRequest)
  @pause_queue.call(req, options, &block)
end

#project_path(project) ⇒ String

Alias for Google::Cloud::Tasks::V2beta3::CloudTasksClient.project_path.

Parameters:

  • project (String)

Returns:

  • (String) 


30
31
32
 
# File 'lib/google/cloud/tasks/v2beta3/helpers.rb', line 30

def project_path project
  self.class.project_path project
end

#purge_queue(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Tasks::V2beta3::Queue

Purges a queue by deleting all of its tasks.

All tasks created before this method is called are permanently deleted.

Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_name = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
response = cloud_tasks_client.purge_queue(formatted_name)

Parameters:

  • name (String) —

    Required.

    The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



681
682
683
684
685
686
687
688
689
690
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 681

def purge_queue \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::PurgeQueueRequest)
  @purge_queue.call(req, options, &block)
end

#queue_path(project, location, queue) ⇒ String

Alias for Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path.

Parameters:

  • project (String)
  • location (String)
  • queue (String)

Returns:

  • (String) 


39
40
41
 
# File 'lib/google/cloud/tasks/v2beta3/helpers.rb', line 39

def queue_path project, location, queue
  self.class.queue_path project, location, queue
end

#resume_queue(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Tasks::V2beta3::Queue

Resume a queue.

This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING.

WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in Managing Cloud Tasks Scaling Risks.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_name = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
response = cloud_tasks_client.resume_queue(formatted_name)

Parameters:

  • name (String) —

    Required.

    The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



764
765
766
767
768
769
770
771
772
773
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 764

def resume_queue \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::ResumeQueueRequest)
  @resume_queue.call(req, options, &block)
end

#run_task(name, response_view: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Tasks::V2beta3::Task

Forces a task to run now.

When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED.

This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now.

The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target.

If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig.

RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_name = Google::Cloud::Tasks::V2beta3::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
response = cloud_tasks_client.run_task(formatted_name)

Parameters:

  • name (String) —

    Required.

    The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

  • response_view (Google::Cloud::Tasks::V2beta3::Task::View) (defaults to: nil) —

    The response_view specifies which subset of the Task will be returned.

    By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

    Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 1238

def run_task \
    name,
    response_view: nil,
    options: nil,
    &block
  req = {
    name: name,
    response_view: response_view
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::RunTaskRequest)
  @run_task.call(req, options, &block)
end

#set_iam_policy(resource, policy, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::Policy

Sets the access control policy for a Queue. Replaces any existing policy.

Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console.

Authorization requires the following Google IAM permission on the specified resource parent:

  • cloudtasks.queues.setIamPolicy

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_resource = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")

# TODO: Initialize `policy`:
policy = {}
response = cloud_tasks_client.set_iam_policy(formatted_resource, policy)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

  • policy (Google::Iam::V1::Policy | Hash) —

    REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. A hash of the same form as Google::Iam::V1::Policy can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



856
857
858
859
860
861
862
863
864
865
866
867
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 856

def set_iam_policy \
    resource,
    policy,
    options: nil,
    &block
  req = {
    resource: resource,
    policy: policy
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::SetIamPolicyRequest)
  @set_iam_policy.call(req, options, &block)
end

#task_path(project, location, queue, task) ⇒ String

Alias for Google::Cloud::Tasks::V2beta3::CloudTasksClient.task_path.

Parameters:

  • project (String)
  • location (String)
  • queue (String)
  • task (String)

Returns:

  • (String) 


49
50
51
 
# File 'lib/google/cloud/tasks/v2beta3/helpers.rb', line 49

def task_path project, location, queue, task
  self.class.task_path project, location, queue, task
end

#test_iam_permissions(resource, permissions, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
formatted_resource = Google::Cloud::Tasks::V2beta3::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")

# TODO: Initialize `permissions`:
permissions = []
response = cloud_tasks_client.test_iam_permissions(formatted_resource, permissions)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

  • permissions (Array<String>) —

    The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



904
905
906
907
908
909
910
911
912
913
914
915
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 904

def test_iam_permissions \
    resource,
    permissions,
    options: nil,
    &block
  req = {
    resource: resource,
    permissions: permissions
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::TestIamPermissionsRequest)
  @test_iam_permissions.call(req, options, &block)
end

#update_queue(queue, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Tasks::V2beta3::Queue

Updates a queue.

This method creates the queue if it does not exist and updates the queue if it does exist.

Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not.

WARNING: Using this method may have unintended side effects if you are using an App Engine queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.

Examples:

require "google/cloud/tasks"

cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)

# TODO: Initialize `queue`:
queue = {}
response = cloud_tasks_client.update_queue(queue)

Parameters:

  • queue (Google::Cloud::Tasks::V2beta3::Queue | Hash) —

    Required.

    The queue to create or update.

    The queue's name must be specified.

    Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed. A hash of the same form as Google::Cloud::Tasks::V2beta3::Queue can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) (defaults to: nil) —

    A mask used to specify which fields of the queue are being updated.

    If empty, then all fields will be updated. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb', line 597

def update_queue \
    queue,
    update_mask: nil,
    options: nil,
    &block
  req = {
    queue: queue,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Tasks::V2beta3::UpdateQueueRequest)
  @update_queue.call(req, options, &block)
end