Cloud Tasks V2 API - Class Google::Cloud::Tasks::V2::CloudTasks::Client (v1.0.1)

Reference documentation and code samples for the Cloud Tasks V2 API class Google::Cloud::Tasks::V2::CloudTasks::Client.

Client for the CloudTasks service.

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

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the CloudTasks Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all CloudTasks clients
::Google::Cloud::Tasks::V2::CloudTasks::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the CloudTasks Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_queue

def create_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
def create_queue(parent: nil, queue: nil) -> ::Google::Cloud::Tasks::V2::Queue

Creates a queue.

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

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

Overloads 
def create_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to create_queue via a request object, either of type Google::Cloud::Tasks::V2::CreateQueueRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::CreateQueueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_queue(parent: nil, queue: nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to create_queue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
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::Client#list_locations.

  • queue (::Google::Cloud::Tasks::V2::Queue, ::Hash) — Required. The queue to create.

    [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an existing queue.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::CreateQueueRequest.new

# Call the create_queue method.
result = client.create_queue request

# The returned object is of type Google::Cloud::Tasks::V2::Queue.
p result

#create_task

def create_task(request, options = nil) -> ::Google::Cloud::Tasks::V2::Task
def create_task(parent: nil, task: nil, response_view: nil) -> ::Google::Cloud::Tasks::V2::Task

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.
Overloads 
def create_task(request, options = nil) -> ::Google::Cloud::Tasks::V2::Task
Pass arguments to create_task via a request object, either of type Google::Cloud::Tasks::V2::CreateTaskRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::CreateTaskRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_task(parent: nil, task: nil, response_view: nil) -> ::Google::Cloud::Tasks::V2::Task
Pass arguments to create_task via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

    The queue must already exist.

  • task (::Google::Cloud::Tasks::V2::Task, ::Hash) — Required. The task to add.

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

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

    Task De-duplication:

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

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

  • response_view (::Google::Cloud::Tasks::V2::Task::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 permission on the Task resource.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::CreateTaskRequest.new

# Call the create_task method.
result = client.create_task request

# The returned object is of type Google::Cloud::Tasks::V2::Task.
p result

#delete_queue

def delete_queue(request, options = nil) -> ::Google::Protobuf::Empty
def delete_queue(name: nil) -> ::Google::Protobuf::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 before using this method.

Overloads 
def delete_queue(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_queue via a request object, either of type DeleteQueueRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::DeleteQueueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_queue(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_queue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::DeleteQueueRequest.new

# Call the delete_queue method.
result = client.delete_queue request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_task

def delete_task(request, options = nil) -> ::Google::Protobuf::Empty
def delete_task(name: nil) -> ::Google::Protobuf::Empty

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.

Overloads 
def delete_task(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_task via a request object, either of type DeleteTaskRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::DeleteTaskRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_task(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_task via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::DeleteTaskRequest.new

# Call the delete_task method.
result = client.delete_task request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

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

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

  • cloudtasks.queues.getIamPolicy
Overloads 
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::GetIamPolicyRequest.new

# Call the get_iam_policy method.
result = client.get_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#get_queue

def get_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
def get_queue(name: nil) -> ::Google::Cloud::Tasks::V2::Queue

Gets a queue.

Overloads 
def get_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to get_queue via a request object, either of type GetQueueRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::GetQueueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_queue(name: nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to get_queue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The resource name of the queue. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::GetQueueRequest.new

# Call the get_queue method.
result = client.get_queue request

# The returned object is of type Google::Cloud::Tasks::V2::Queue.
p result

#get_task

def get_task(request, options = nil) -> ::Google::Cloud::Tasks::V2::Task
def get_task(name: nil, response_view: nil) -> ::Google::Cloud::Tasks::V2::Task

Gets a task.

Overloads 
def get_task(request, options = nil) -> ::Google::Cloud::Tasks::V2::Task
Pass arguments to get_task via a request object, either of type GetTaskRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::GetTaskRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_task(name: nil, response_view: nil) -> ::Google::Cloud::Tasks::V2::Task
Pass arguments to get_task via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
  • response_view (::Google::Cloud::Tasks::V2::Task::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 permission on the Task resource.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::GetTaskRequest.new

# Call the get_task method.
result = client.get_task request

# The returned object is of type Google::Cloud::Tasks::V2::Task.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new CloudTasks client object.

Yields
  • (config) — Configure the CloudTasks client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Tasks::V2::CloudTasks::Client.new do |config|
  config.timeout = 10.0
end

#list_queues

def list_queues(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2::Queue>
def list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2::Queue>

Lists queues.

Queues are returned in lexicographical order.

Overloads 
def list_queues(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2::Queue>
Pass arguments to list_queues via a request object, either of type ListQueuesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::ListQueuesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2::Queue>
Pass arguments to list_queues via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
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 "state: PAUSED".

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

  • page_size (::Integer) — 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.

  • 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 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.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::ListQueuesRequest.new

# Call the list_queues method.
result = client.list_queues request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Tasks::V2::Queue.
  p item
end

#list_tasks

def list_tasks(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2::Task>
def list_tasks(parent: nil, response_view: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2::Task>

Lists the tasks in a queue.

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

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

Overloads 
def list_tasks(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2::Task>
Pass arguments to list_tasks via a request object, either of type ListTasksRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::ListTasksRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_tasks(parent: nil, response_view: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2::Task>
Pass arguments to list_tasks via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
  • response_view (::Google::Cloud::Tasks::V2::Task::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 permission on the Task resource.

  • page_size (::Integer) — 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.

  • 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 next_page_token returned from the previous call to ListTasks method.

    The page token is valid for only 2 hours.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::ListTasksRequest.new

# Call the list_tasks method.
result = client.list_tasks request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Tasks::V2::Task.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#pause_queue

def pause_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
def pause_queue(name: nil) -> ::Google::Cloud::Tasks::V2::Queue

Pauses the queue.

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

Overloads 
def pause_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to pause_queue via a request object, either of type PauseQueueRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::PauseQueueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def pause_queue(name: nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to pause_queue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::PauseQueueRequest.new

# Call the pause_queue method.
result = client.pause_queue request

# The returned object is of type Google::Cloud::Tasks::V2::Queue.
p result

#purge_queue

def purge_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
def purge_queue(name: nil) -> ::Google::Cloud::Tasks::V2::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.

Overloads 
def purge_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to purge_queue via a request object, either of type PurgeQueueRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::PurgeQueueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def purge_queue(name: nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to purge_queue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::PurgeQueueRequest.new

# Call the purge_queue method.
result = client.purge_queue request

# The returned object is of type Google::Cloud::Tasks::V2::Queue.
p result

#resume_queue

def resume_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
def resume_queue(name: nil) -> ::Google::Cloud::Tasks::V2::Queue

Resume a queue.

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

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

Overloads 
def resume_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to resume_queue via a request object, either of type ResumeQueueRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::ResumeQueueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def resume_queue(name: nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to resume_queue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::ResumeQueueRequest.new

# Call the resume_queue method.
result = client.resume_queue request

# The returned object is of type Google::Cloud::Tasks::V2::Queue.
p result

#run_task

def run_task(request, options = nil) -> ::Google::Cloud::Tasks::V2::Task
def run_task(name: nil, response_view: nil) -> ::Google::Cloud::Tasks::V2::Task

Forces a task to run now.

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

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

The dispatched task is returned. That is, the task that is returned contains the [status][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 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][google.rpc.Code.NOT_FOUND] when it is called on a task that has already succeeded or permanently failed.

Overloads 
def run_task(request, options = nil) -> ::Google::Cloud::Tasks::V2::Task
Pass arguments to run_task via a request object, either of type RunTaskRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::RunTaskRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def run_task(name: nil, response_view: nil) -> ::Google::Cloud::Tasks::V2::Task
Pass arguments to run_task via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
  • response_view (::Google::Cloud::Tasks::V2::Task::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 permission on the Task resource.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::RunTaskRequest.new

# Call the run_task method.
result = client.run_task request

# The returned object is of type Google::Cloud::Tasks::V2::Task.
p result

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

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

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

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

  • cloudtasks.queues.setIamPolicy
Overloads 
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

    paths: "bindings, etag"

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

# Call the set_iam_policy method.
result = client.set_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a [NOT_FOUND][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.

Overloads 
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
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.
  • permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::TestIamPermissionsRequest.new

# Call the test_iam_permissions method.
result = client.test_iam_permissions request

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_queue

def update_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
def update_queue(queue: nil, update_mask: nil) -> ::Google::Cloud::Tasks::V2::Queue

Updates a queue.

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

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

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

Overloads 
def update_queue(request, options = nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to update_queue via a request object, either of type UpdateQueueRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Tasks::V2::UpdateQueueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_queue(queue: nil, update_mask: nil) -> ::Google::Cloud::Tasks::V2::Queue
Pass arguments to update_queue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • queue (::Google::Cloud::Tasks::V2::Queue, ::Hash) — Required. The queue to create or update.

    The queue's name must be specified.

    Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed.

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — A mask used to specify which fields of the queue are being updated.

    If empty, then all fields will be updated.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/tasks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Tasks::V2::CloudTasks::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Tasks::V2::UpdateQueueRequest.new

# Call the update_queue method.
result = client.update_queue request

# The returned object is of type Google::Cloud::Tasks::V2::Queue.
p result