Google Cloud Tasks v2 API - Class CloudTasks.CloudTasksBase (3.4.0)

[BindServiceMethod(typeof(CloudTasks), "BindService")]
public abstract class CloudTasks.CloudTasksBase

Reference documentation and code samples for the Google Cloud Tasks v2 API class CloudTasks.CloudTasksBase.

Base class for server-side implementations of CloudTasks

Inheritance

object > CloudTasks.CloudTasksBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Tasks.V2

Assembly

Google.Cloud.Tasks.V2.dll

Methods

CreateQueue(CreateQueueRequest, ServerCallContext)

public virtual Task<Queue> CreateQueue(CreateQueueRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`CreateQueueRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueue`	The response to send back to the client (wrapped by a task).

CreateTask(CreateTaskRequest, ServerCallContext)

public virtual Task<Task> CreateTask(CreateTaskRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`CreateTaskRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTask`	The response to send back to the client (wrapped by a task).

DeleteQueue(DeleteQueueRequest, ServerCallContext)

public virtual Task<Empty> DeleteQueue(DeleteQueueRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`DeleteQueueRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteTask(DeleteTaskRequest, ServerCallContext)

public virtual Task<Empty> DeleteTask(DeleteTaskRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`DeleteTaskRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

Gets the access control policy for a [Queue][google.cloud.tasks.v2.Queue]. Returns an empty policy if the resource exists and does not have a policy set.

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

cloudtasks.queues.getIamPolicy

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPolicy`	The response to send back to the client (wrapped by a task).

GetQueue(GetQueueRequest, ServerCallContext)

public virtual Task<Queue> GetQueue(GetQueueRequest request, ServerCallContext context)

Gets a queue.

Parameters
Name	Description
`request`	`GetQueueRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueue`	The response to send back to the client (wrapped by a task).

GetTask(GetTaskRequest, ServerCallContext)

public virtual Task<Task> GetTask(GetTaskRequest request, ServerCallContext context)

Gets a task.

Parameters
Name	Description
`request`	`GetTaskRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTask`	The response to send back to the client (wrapped by a task).

ListQueues(ListQueuesRequest, ServerCallContext)

public virtual Task<ListQueuesResponse> ListQueues(ListQueuesRequest request, ServerCallContext context)

Lists queues.

Queues are returned in lexicographical order.

Parameters
Name	Description
`request`	`ListQueuesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListQueuesResponse`	The response to send back to the client (wrapped by a task).

ListTasks(ListTasksRequest, ServerCallContext)

public virtual Task<ListTasksResponse> ListTasks(ListTasksRequest request, ServerCallContext context)

Lists the tasks in a queue.

By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is retrieved due to performance considerations; [response_view][google.cloud.tasks.v2.ListTasksRequest.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.

Parameters
Name	Description
`request`	`ListTasksRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListTasksResponse`	The response to send back to the client (wrapped by a task).

PauseQueue(PauseQueueRequest, ServerCallContext)

public virtual Task<Queue> PauseQueue(PauseQueueRequest request, ServerCallContext context)

Pauses the queue.

If a queue is paused then the system will stop dispatching tasks until the queue is resumed via [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can still be added when the queue is paused. A queue is paused if its [state][google.cloud.tasks.v2.Queue.state] is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].

Parameters
Name	Description
`request`	`PauseQueueRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueue`	The response to send back to the client (wrapped by a task).

PurgeQueue(PurgeQueueRequest, ServerCallContext)

public virtual Task<Queue> PurgeQueue(PurgeQueueRequest request, ServerCallContext context)

Purges a queue by deleting all of its tasks.

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

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

Parameters
Name	Description
`request`	`PurgeQueueRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueue`	The response to send back to the client (wrapped by a task).

ResumeQueue(ResumeQueueRequest, ServerCallContext)

public virtual Task<Queue> ResumeQueue(ResumeQueueRequest request, ServerCallContext context)

Resume a queue.

This method resumes a queue after it has been [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED] or [DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a queue is stored in the queue's [state][google.cloud.tasks.v2.Queue.state]; after calling this method it will be set to [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].

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

Parameters
Name	Description
`request`	`ResumeQueueRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueue`	The response to send back to the client (wrapped by a task).

RunTask(RunTaskRequest, ServerCallContext)

public virtual Task<Task> RunTask(RunTaskRequest request, ServerCallContext context)

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][google.cloud.tasks.v2.RateLimits] or is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].

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

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][google.cloud.tasks.v2.Task.schedule_time] will be reset to the time that [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was called plus the retry delay specified in the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig].

[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a task that has already succeeded or permanently failed.

Parameters
Name	Description
`request`	`RunTaskRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTask`	The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue]. Replaces any existing policy.

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

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

cloudtasks.queues.setIamPolicy

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPolicy`	The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.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.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTestIamPermissionsResponse`	The response to send back to the client (wrapped by a task).

UpdateQueue(UpdateQueueRequest, ServerCallContext)

public virtual Task<Queue> UpdateQueue(UpdateQueueRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`UpdateQueueRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueue`	The response to send back to the client (wrapped by a task).