class Google::Apis::CloudtasksV2::CloudTasksService

Cloud Tasks API

Manages the execution of large numbers of distributed requests.

@example

require 'google/apis/cloudtasks_v2'

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

@see cloud.google.com/tasks/

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/cloudtasks_v2/service.rb, line 45
def initialize
  super('https://cloudtasks.googleapis.com/', '',
        client_name: 'google-apis-cloudtasks_v2',
        client_version: Google::Apis::CloudtasksV2::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

create_project_location_queue(parent, queue_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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](cloud.google.com/tasks/docs/queue-yaml) before using this method. @param [String] parent

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.

@param [Google::Apis::CloudtasksV2::Queue] queue_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Queue] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Queue]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 154
def create_project_location_queue(parent, queue_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/queues', options)
  command.request_representation = Google::Apis::CloudtasksV2::Queue::Representation
  command.request_object = queue_object
  command.response_representation = Google::Apis::CloudtasksV2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB. @param [String] parent

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

@param [Google::Apis::CloudtasksV2::CreateTaskRequest] create_task_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Task] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Task]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 587
def create_task(parent, create_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/tasks', options)
  command.request_representation = Google::Apis::CloudtasksV2::CreateTaskRequest::Representation
  command.request_object = create_task_request_object
  command.response_representation = Google::Apis::CloudtasksV2::Task::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

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](cloud.google.com/ tasks/docs/queue-yaml) before using this method. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 192
def delete_project_location_queue(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2::Empty::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

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. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 621
def delete_project_location_queue_task(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2::Empty::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

Gets information about a location. @param [String] name

Resource name for the location.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Location] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Location]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 72
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2::Location::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

Gets a queue. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Queue] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Queue]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 223
def get_project_location_queue(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

Gets a task. @param [String] name

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

@param [String] response_view

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](https://cloud.google.com/iam/) permission on the Task resource.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Task] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Task]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 659
def get_project_location_queue_task(name, response_view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::CloudtasksV2::Task::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

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](cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` @param [String] resource

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

@param [Google::Apis::CloudtasksV2::GetIamPolicyRequest] get_iam_policy_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Policy] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Policy]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 258
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, 'v2/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::CloudtasksV2::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::CloudtasksV2::Policy::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, page_size: nil, page_token: nil, response_view: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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. @param [String] parent

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

@param [Fixnum] page_size

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

@param [String] page_token

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 next_page_token returned from the previous
call to ListTasks method. The page token is valid for only 2 hours.

@param [String] response_view

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](https://cloud.google.com/iam/) permission on the Task resource.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::ListTasksResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::ListTasksResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 711
def list_project_location_queue_tasks(parent, page_size: nil, page_token: nil, response_view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/tasks', options)
  command.response_representation = Google::Apis::CloudtasksV2::ListTasksResponse::Representation
  command.response_class = Google::Apis::CloudtasksV2::ListTasksResponse
  command.params['parent'] = parent unless parent.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, &block) click to toggle source

Lists queues. Queues are returned in lexicographical order. @param [String] parent

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

@param [String] filter

`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](https://cloud.google.com/logging/docs/view/
advanced_filters). Sample filter "state: PAUSED". Note that using filters
might cause fewer queues than the requested page_size to be returned.

@param [Fixnum] page_size

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 the next_page_token in the response to determine if
more queues exist.

@param [String] page_token

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 next_page_token returned from the previous
call to ListQueues method. It is an error to switch the value of the filter
while iterating through pages.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::ListQueuesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::ListQueuesResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 309
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, 'v2/{+parent}/queues', options)
  command.response_representation = Google::Apis::CloudtasksV2::ListQueuesResponse::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

Lists information about the supported locations for this service. @param [String] name

The resource that owns the locations collection, if applicable.

@param [String] filter

A filter to narrow down results to a preferred subset. The filtering language
accepts strings like "displayName=tokyo", and is documented in more detail in [
AIP-160](https://google.aip.dev/160).

@param [Fixnum] page_size

The maximum number of results to return. If not set, the service selects a
default.

@param [String] page_token

A page token received from the `next_page_token` field in the response. Send
that page token to receive the subsequent page.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::ListLocationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::ListLocationsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 112
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, 'v2/{+name}/locations', options)
  command.response_representation = Google::Apis::CloudtasksV2::ListLocationsResponse::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

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](cloud.google.com/tasks/docs/queue-yaml) before using this method. @param [String] name

Caller-specified and required in CreateQueue, after which it becomes output
only. 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 (.).
For more information, see [Identifying projects](https://cloud.google.com/
resource-manager/docs/creating-managing-projects#identifying_projects) * `
LOCATION_ID` is the canonical ID for the queue's location. The list of
available locations can be obtained by calling 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.

@param [Google::Apis::CloudtasksV2::Queue] queue_object @param [String] update_mask

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Queue] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Queue]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 363
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, 'v2/{+name}', options)
  command.request_representation = Google::Apis::CloudtasksV2::Queue::Representation
  command.request_object = queue_object
  command.response_representation = Google::Apis::CloudtasksV2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

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. @param [String] name

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

@param [Google::Apis::CloudtasksV2::PauseQueueRequest] pause_queue_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Queue] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Queue]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 400
def pause_queue(name, pause_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:pause', options)
  command.request_representation = Google::Apis::CloudtasksV2::PauseQueueRequest::Representation
  command.request_object = pause_queue_request_object
  command.response_representation = Google::Apis::CloudtasksV2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2::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
purge_queue(name, purge_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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. @param [String] name

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

@param [Google::Apis::CloudtasksV2::PurgeQueueRequest] purge_queue_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Queue] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Queue]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 437
def purge_queue(name, purge_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:purge', options)
  command.request_representation = Google::Apis::CloudtasksV2::PurgeQueueRequest::Representation
  command.request_object = purge_queue_request_object
  command.response_representation = Google::Apis::CloudtasksV2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2::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
resume_queue(name, resume_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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](cloud.google.com/tasks/docs/manage-cloud-task-scaling). @param [String] name

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

@param [Google::Apis::CloudtasksV2::ResumeQueueRequest] resume_queue_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Queue] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Queue]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 476
def resume_queue(name, resume_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:resume', options)
  command.request_representation = Google::Apis::CloudtasksV2::ResumeQueueRequest::Representation
  command.request_object = resume_queue_request_object
  command.response_representation = Google::Apis::CloudtasksV2::Queue::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

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. @param [String] name

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

@param [Google::Apis::CloudtasksV2::RunTaskRequest] run_task_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Task] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Task]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 757
def run_task(name, run_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:run', options)
  command.request_representation = Google::Apis::CloudtasksV2::RunTaskRequest::Representation
  command.request_object = run_task_request_object
  command.response_representation = Google::Apis::CloudtasksV2::Task::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

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](cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy` @param [String] resource

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

@param [Google::Apis::CloudtasksV2::SetIamPolicyRequest] set_iam_policy_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::Policy] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::Policy]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 514
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, 'v2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::CloudtasksV2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::CloudtasksV2::Policy::Representation
  command.response_class = Google::Apis::CloudtasksV2::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, &block) click to toggle source

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. @param [String] resource

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

@param [Google::Apis::CloudtasksV2::TestIamPermissionsRequest] test_iam_permissions_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudtasksV2::TestIamPermissionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudtasksV2::TestIamPermissionsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/cloudtasks_v2/service.rb, line 552
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, 'v2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::CloudtasksV2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::CloudtasksV2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::CloudtasksV2::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

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/cloudtasks_v2/service.rb, line 771
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end