Struct CloudTasks 

pub struct CloudTasks { /* private fields */ }

Implements a client for the Cloud Tasks API.

Example

let client = CloudTasks::builder().build().await?;
// use `client` to make requests to the Cloud Tasks API.

Service Description

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

Configuration

To configure CloudTasks use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://cloudtasks.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

CloudTasks holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap CloudTasks in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl CloudTasks

pub fn builder() -> ClientBuilder

Returns a builder for CloudTasks.

let client = CloudTasks::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: CloudTasks + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn list_queues(&self) -> ListQueues

Lists queues.

Queues are returned in lexicographical order.

pub fn get_queue(&self) -> GetQueue

Gets a queue.

pub fn create_queue(&self) -> CreateQueue

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.

pub fn update_queue(&self) -> UpdateQueue

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.

pub fn delete_queue(&self) -> DeleteQueue

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.

pub fn purge_queue(&self) -> PurgeQueue

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.

pub fn pause_queue(&self) -> PauseQueue

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.

pub fn resume_queue(&self) -> ResumeQueue

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.

pub fn get_iam_policy(&self) -> GetIamPolicy

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

pub fn set_iam_policy(&self) -> SetIamPolicy

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

pub fn test_iam_permissions(&self) -> TestIamPermissions

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.

pub fn list_tasks(&self) -> ListTasks

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.

pub fn get_task(&self) -> GetTask

Gets a task.

pub fn create_task(&self) -> CreateTask

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.

pub fn delete_task(&self) -> DeleteTask

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.

pub fn run_task(&self) -> RunTask

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.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

Trait Implementations

impl Clone for CloudTasks

fn clone(&self) -> CloudTasks

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CloudTasks

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.