Class: Google::Apis::CloudtasksV2beta2::CloudTasksService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudtasks_v2beta2/service.rb

Overview

Cloud Tasks API

Manages the execution of large numbers of distributed requests. Cloud Tasks is in Alpha.

Examples:

require 'google/apis/cloudtasks_v2beta2'

Cloudtasks = Google::Apis::CloudtasksV2beta2 # Alias the module
service = Cloudtasks::CloudTasksService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initialize ⇒ CloudTasksService

Returns a new instance of CloudTasksService



46
47
48
49
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 46

def initialize
  super('https://cloudtasks.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#acknowledge_task(name, acknowledge_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Empty

Acknowledges a pull task. The lease holder, that is, the entity that received this task in a PullTasksResponse, must call this method to indicate that the work associated with the task has finished. The lease holder must acknowledge a task within the PullTasksRequest.lease_duration or the lease will expire and the task will become ready to be returned in a different PullTasksResponse. After the task is acknowledged, it will not be returned by a later CloudTasks.PullTasks, CloudTasks.GetTask, or CloudTasks.ListTasks. To acknowledge multiple tasks at the same time, use HTTP batching or the batching documentation for your client library, for example https://developers.google.com/api-client-library/python/guide/batch.

Parameters:

  • name (String) —

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

  • acknowledge_task_request_object (Google::Apis::CloudtasksV2beta2::AcknowledgeTaskRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



628
629
630
631
632
633
634
635
636
637
638
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 628

def acknowledge_task(name, acknowledge_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+name}:acknowledge', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::AcknowledgeTaskRequest::Representation
  command.request_object = acknowledge_task_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_task_lease(name, cancel_lease_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task

Cancel a pull task's lease. The lease holder can use this method to cancel a task's lease by setting Task.schedule_time to now. This will make the task available to be leased to the next caller of CloudTasks.PullTasks.

Parameters:

  • name (String) —

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

  • cancel_lease_request_object (Google::Apis::CloudtasksV2beta2::CancelLeaseRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



666
667
668
669
670
671
672
673
674
675
676
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 666

def cancel_task_lease(name, cancel_lease_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+name}:cancelLease', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::CancelLeaseRequest::Representation
  command.request_object = cancel_lease_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Task
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_queue(parent, queue_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue

Creates a queue. 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 carefully before using this method.

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 google.cloud.location.Locations.ListLocations.

  • queue_object (Google::Apis::CloudtasksV2beta2::Queue) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



151
152
153
154
155
156
157
158
159
160
161
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 151

def create_project_location_queue(parent, queue_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/queues', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
  command.request_object = queue_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Queue
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_task(parent, create_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task

Creates a task and adds it to a queue. To add multiple tasks at the same time, use HTTP batching or the batching documentation for your client library, for example https://developers.google.com/api-client-library/python/guide/batch. Tasks cannot be updated after creation; there is no UpdateTask command.

Parameters:

  • parent (String) —

    Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID The queue must already exist.

  • create_task_request_object (Google::Apis::CloudtasksV2beta2::CreateTaskRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



711
712
713
714
715
716
717
718
719
720
721
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 711

def create_task(parent, create_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/tasks', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::CreateTaskRequest::Representation
  command.request_object = create_task_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Task
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_queue(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Empty

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 carefully before using this method.

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



193
194
195
196
197
198
199
200
201
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 193

def delete_project_location_queue(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_queue_task(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Empty

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

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



748
749
750
751
752
753
754
755
756
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 748

def delete_project_location_queue_task(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Location

Get information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



71
72
73
74
75
76
77
78
79
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 71

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2beta2::Location::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_queue(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue

Gets a queue.

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



225
226
227
228
229
230
231
232
233
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 225

def get_project_location_queue(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Queue
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_queue_task(name, response_view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task

Gets a task.

Parameters:

  • name (String) —

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

  • response_view (String) —

    The response_view specifies which subset of the Task will be returned. By default response_view is Task.View.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 Task.View.FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task.name resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



791
792
793
794
795
796
797
798
799
800
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 791

def get_project_location_queue_task(name, response_view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Task
  command.params['name'] = name unless name.nil?
  command.query['responseView'] = response_view unless response_view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_queue_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::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

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::CloudtasksV2beta2::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



262
263
264
265
266
267
268
269
270
271
272
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 262

def get_queue_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Policy::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_queue_tasks(parent, order_by: nil, page_size: nil, page_token: nil, response_view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::ListTasksResponse

Lists the tasks in a queue. By default response_view is Task.View.BASIC; not all information is retrieved by default due to performance considerations; ListTasksRequest.response_view controls the subset of information which is returned.

Parameters:

  • parent (String) —

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

  • order_by (String) —

    Sort order used for the query. The only fields supported for sorting are schedule_time and pull_message.tag. All results will be returned in approximately ascending order. The default ordering is by schedule_time.

  • page_size (Fixnum) —

    Requested page size. Fewer tasks than requested might be returned. The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use ListTasksResponse.next_page_token to determine if more tasks exist.

  • page_token (String) —

    A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of ListTasksResponse.next_page_token returned from the previous call to CloudTasks.ListTasks method. The page token is valid for only 2 hours.

  • response_view (String) —

    The response_view specifies which subset of the Task will be returned. By default response_view is Task.View.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 Task.View.FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task.name resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 858

def list_project_location_queue_tasks(parent, order_by: nil, page_size: nil, page_token: nil, response_view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+parent}/tasks', options)
  command.response_representation = Google::Apis::CloudtasksV2beta2::ListTasksResponse::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::ListTasksResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['responseView'] = response_view unless response_view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_queues(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::ListQueuesResponse

Lists queues. Queues are returned in lexicographical order.

Parameters:

  • parent (String) —

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

  • filter (String) —

    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 "app_engine_http_target: *". Note that using filters might cause fewer queues than the requested_page size to be returned.

  • page_size (Fixnum) —

    Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use ListQueuesResponse.next_page_token to determine if more queues exist.

  • page_token (String) —

    A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of ListQueuesResponse.next_page_token returned from the previous call to CloudTasks.ListQueues method. It is an error to switch the value of ListQueuesRequest.filter while iterating through pages.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 321

def list_project_location_queues(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+parent}/queues', options)
  command.response_representation = Google::Apis::CloudtasksV2beta2::ListQueuesResponse::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::ListQueuesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • filter (String) —

    The standard list filter.

  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 107

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}/locations', options)
  command.response_representation = Google::Apis::CloudtasksV2beta2::ListLocationsResponse::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_queue(name, queue_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue

Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. 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 carefully before using this method.

Parameters:

  • name (String) —

    The queue name. The queue name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

    • PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.).
    • LOCATION_ID is the canonical ID for the queue's location. The list of available locations can be obtained by calling google.cloud.location.Locations.ListLocations. For more information, see https://cloud.google.com/about/locations/.
    • QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. Caller-specified and required in CreateQueueRequest, after which it becomes output only.
  • queue_object (Google::Apis::CloudtasksV2beta2::Queue) (defaults to: nil)
  • update_mask (String) —

    A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 377

def patch_project_location_queue(name, queue_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2beta2/{+name}', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
  command.request_object = queue_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Queue
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#pause_queue(name, pause_queue_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue

Pauses the queue. If a queue is paused then the system will stop executing the tasks in the queue until it is resumed via CloudTasks.ResumeQueue. Tasks can still be added when the queue is paused. The state of the queue is stored in Queue.state; if paused it will be set to Queue.State.PAUSED.

Parameters:

  • name (String) —

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

  • pause_queue_request_object (Google::Apis::CloudtasksV2beta2::PauseQueueRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



419
420
421
422
423
424
425
426
427
428
429
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 419

def pause_queue(name, pause_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+name}:pause', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::PauseQueueRequest::Representation
  command.request_object = pause_queue_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Queue
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#pull_tasks(name, pull_tasks_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::PullTasksResponse

Pulls tasks from a pull queue and acquires a lease on them for a specified PullTasksRequest.lease_duration. This method is invoked by the lease holder to obtain the lease. The lease holder must acknowledge the task via CloudTasks.AcknowledgeTask after they have performed the work associated with the task. The payload is intended to store data that the lease holder needs to perform the work associated with the task. To return the payloads in the PullTasksResponse, set PullTasksRequest.response_view to Task.View.FULL. A maximum of 10 qps of CloudTasks.PullTasks requests are allowed per queue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit is exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when RateLimits.max_tasks_dispatched_per_second is exceeded.

Parameters:

  • name (String) —

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

  • pull_tasks_request_object (Google::Apis::CloudtasksV2beta2::PullTasksRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



908
909
910
911
912
913
914
915
916
917
918
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 908

def pull_tasks(name, pull_tasks_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+name}/tasks:pull', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::PullTasksRequest::Representation
  command.request_object = pull_tasks_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::PullTasksResponse::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::PullTasksResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#purge_queue(name, purge_queue_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::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.

Parameters:

  • name (String) —

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

  • purge_queue_request_object (Google::Apis::CloudtasksV2beta2::PurgeQueueRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



457
458
459
460
461
462
463
464
465
466
467
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 457

def purge_queue(name, purge_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+name}:purge', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::PurgeQueueRequest::Representation
  command.request_object = purge_queue_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Queue
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#renew_task_lease(name, renew_lease_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task

Renew the current lease of a pull task. The lease holder can use this method to extend the lease by a new duration, starting from now. The new task lease will be returned in Task.schedule_time.

Parameters:

  • name (String) —

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

  • renew_lease_request_object (Google::Apis::CloudtasksV2beta2::RenewLeaseRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



946
947
948
949
950
951
952
953
954
955
956
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 946

def renew_task_lease(name, renew_lease_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+name}:renewLease', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::RenewLeaseRequest::Representation
  command.request_object = renew_lease_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Task
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resume_queue(name, resume_queue_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Queue

Resume a queue. This method resumes a queue after it has been Queue.State.PAUSED or Queue.State.DISABLED. The state of a queue is stored in Queue.state; after calling this method it will be set to Queue.State.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.

Parameters:

  • name (String) —

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

  • resume_queue_request_object (Google::Apis::CloudtasksV2beta2::ResumeQueueRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



501
502
503
504
505
506
507
508
509
510
511
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 501

def resume_queue(name, resume_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+name}:resume', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::ResumeQueueRequest::Representation
  command.request_object = resume_queue_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Queue
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_task(name, run_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::Task

Forces a task to run now. This command is meant to be used for manual debugging. For example, CloudTasks.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. When this method is called, Cloud Tasks will dispatch the task to its target, even if the queue is Queue.State.PAUSED. The dispatched task is returned. That is, the task that is returned contains the Task.task_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 handler, then the task will be deleted; otherwise the task's Task.schedule_time will be reset to the time that CloudTasks.RunTask was called plus the retry delay specified in the queue and task's RetryConfig. CloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when it is called on a task that has already succeeded or permanently failed. google.rpc.Code.FAILED_PRECONDITION is returned when CloudTasks.RunTask is called on task that is dispatched or already running. CloudTasks.RunTask cannot be called on pull tasks.

Parameters:

  • name (String) —

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

  • run_task_request_object (Google::Apis::CloudtasksV2beta2::RunTaskRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 1001

def run_task(name, run_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+name}:run', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::RunTaskRequest::Representation
  command.request_object = run_task_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Task
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_queue_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::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

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::CloudtasksV2beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



541
542
543
544
545
546
547
548
549
550
551
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 541

def set_queue_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::Policy::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_queue_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtasksV2beta2::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 google.rpc.Code.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.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::CloudtasksV2beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



580
581
582
583
584
585
586
587
588
589
590
 
# File 'generated/google/apis/cloudtasks_v2beta2/service.rb', line 580

def test_queue_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::CloudtasksV2beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end