CloudTasks

import { CloudTasks } from "https://googleapis.deno.dev/v1/cloudtasks:v2.ts";

Manages the execution of large numbers of distributed requests.

class CloudTasks {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsGetCmekConfig(name: string): Promise<CmekConfig>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsQueuesCreate(parent: string, req: Queue): Promise<Queue>;

async projectsLocationsQueuesDelete(name: string): Promise<Empty>;

async projectsLocationsQueuesGet(name: string): Promise<Queue>;

async projectsLocationsQueuesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsQueuesList(parent: string, opts?: ProjectsLocationsQueuesListOptions): Promise<ListQueuesResponse>;

async projectsLocationsQueuesPatch(

name: string,

req: Queue,

opts?: ProjectsLocationsQueuesPatchOptions,

): Promise<Queue>;

async projectsLocationsQueuesPause(name: string, req: PauseQueueRequest): Promise<Queue>;

async projectsLocationsQueuesPurge(name: string, req: PurgeQueueRequest): Promise<Queue>;

async projectsLocationsQueuesResume(name: string, req: ResumeQueueRequest): Promise<Queue>;

async projectsLocationsQueuesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsQueuesTasksBuffer(

queue: string,

taskId: string,

req: BufferTaskRequest,

): Promise<BufferTaskResponse>;

async projectsLocationsQueuesTasksCreate(parent: string, req: CreateTaskRequest): Promise<Task>;

async projectsLocationsQueuesTasksDelete(name: string): Promise<Empty>;

async projectsLocationsQueuesTasksGet(name: string, opts?: ProjectsLocationsQueuesTasksGetOptions): Promise<Task>;

async projectsLocationsQueuesTasksList(parent: string, opts?: ProjectsLocationsQueuesTasksListOptions): Promise<ListTasksResponse>;

async projectsLocationsQueuesTasksRun(name: string, req: RunTaskRequest): Promise<Task>;

async projectsLocationsQueuesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsUpdateCmekConfig(

name: string,

req: CmekConfig,

opts?: ProjectsLocationsUpdateCmekConfigOptions,

): Promise<CmekConfig>;

}

§Constructors

new CloudTasks(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsGetCmekConfig(name: string): Promise<CmekConfig>

[src]

Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.

@param name

Required. The config. For example: projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig`

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsQueuesCreate(parent: string, req: Queue): Promise<Queue>

[src]

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.

@param 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.

projectsLocationsQueuesDelete(name: string): Promise<Empty>

[src]

Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, you may be prevented from creating a new queue with the same name as the deleted queue for a tombstone window of up to 3 days. During this window, the CreateQueue operation may appear to recreate the queue, but this can be misleading. If you attempt to create a queue with the same name as one that is in the tombstone window, run GetQueue to confirm that the queue creation was successful. If GetQueue returns 200 response code, your queue was successfully created with the name of the previously deleted queue. Otherwise, your queue did not successfully recreate. 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.

@param name

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

projectsLocationsQueuesGet(name: string): Promise<Queue>

[src]

Gets a queue.

@param name

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

projectsLocationsQueuesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

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

@param resource

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

projectsLocationsQueuesList(parent: string, opts?: ProjectsLocationsQueuesListOptions): Promise<ListQueuesResponse>

[src]

Lists queues. Queues are returned in lexicographical order.

@param parent

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

projectsLocationsQueuesPatch(name: string, req: Queue, opts?: ProjectsLocationsQueuesPatchOptions): Promise<Queue>

[src]

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.

@param 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 * 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.

projectsLocationsQueuesPause(name: string, req: PauseQueueRequest): Promise<Queue>

[src]

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 name

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

projectsLocationsQueuesPurge(name: string, req: PurgeQueueRequest): Promise<Queue>

[src]

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 name

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

projectsLocationsQueuesResume(name: string, req: ResumeQueueRequest): Promise<Queue>

[src]

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.

@param name

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

projectsLocationsQueuesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

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

@param resource

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

projectsLocationsQueuesTasksBuffer(queue: string, taskId: string, req: BufferTaskRequest): Promise<BufferTaskResponse>

[src]

Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.

@param queue

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

@param taskId

Optional. Task ID for the task being created. If not provided, Cloud Tasks generates an ID for the task.

projectsLocationsQueuesTasksCreate(parent: string, req: CreateTaskRequest): Promise<Task>

[src]

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 parent

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

projectsLocationsQueuesTasksDelete(name: string): Promise<Empty>

[src]

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 name

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

projectsLocationsQueuesTasksGet(name: string, opts?: ProjectsLocationsQueuesTasksGetOptions): Promise<Task>

[src]

Gets a task.

@param name

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

projectsLocationsQueuesTasksList(parent: string, opts?: ProjectsLocationsQueuesTasksListOptions): Promise<ListTasksResponse>

[src]

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 parent

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

projectsLocationsQueuesTasksRun(name: string, req: RunTaskRequest): Promise<Task>

[src]

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 name

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

projectsLocationsQueuesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

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 resource

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

projectsLocationsUpdateCmekConfig(name: string, req: CmekConfig, opts?: ProjectsLocationsUpdateCmekConfigOptions): Promise<CmekConfig>

[src]

Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.

@param name

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`