Class v2beta2.CloudTasksClient (2.3.6)

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

Package

@google-cloud/tasks!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of CloudTasksClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
TypeDescription
string

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

cloudTasksStub

cloudTasksStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
TypeDescription
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
TypeDescription
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
TypeDescription
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
TypeDescription
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
TypeDescription
(code: string, message: string, warnType?: string) => void

Methods

acknowledgeTask(request, options)

acknowledgeTask(request?: protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest | undefined, {} | undefined]>

acknowledgeTask(request, options, callback)

acknowledgeTask(request: protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

acknowledgeTask(request, callback)

acknowledgeTask(request: protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

cancelLease(request, options)

cancelLease(request?: protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest | undefined, {} | undefined]>

cancelLease(request, options, callback)

cancelLease(request: protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

cancelLease(request, callback)

cancelLease(request: protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICancelLeaseRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createQueue(request, options)

createQueue(request?: protos.google.cloud.tasks.v2beta2.ICreateQueueRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.ICreateQueueRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ICreateQueueRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.ICreateQueueRequest | undefined, {} | undefined]>

createQueue(request, options, callback)

createQueue(request: protos.google.cloud.tasks.v2beta2.ICreateQueueRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.ICreateQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ICreateQueueRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.ICreateQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createQueue(request, callback)

createQueue(request: protos.google.cloud.tasks.v2beta2.ICreateQueueRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.ICreateQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ICreateQueueRequest
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.ICreateQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createTask(request, options)

createTask(request?: protos.google.cloud.tasks.v2beta2.ICreateTaskRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICreateTaskRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ICreateTaskRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICreateTaskRequest | undefined, {} | undefined]>

createTask(request, options, callback)

createTask(request: protos.google.cloud.tasks.v2beta2.ICreateTaskRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICreateTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ICreateTaskRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICreateTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createTask(request, callback)

createTask(request: protos.google.cloud.tasks.v2beta2.ICreateTaskRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICreateTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ICreateTaskRequest
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.ICreateTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteQueue(request, options)

deleteQueue(request?: protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest | undefined, {} | undefined]>

deleteQueue(request, options, callback)

deleteQueue(request: protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteQueue(request, callback)

deleteQueue(request: protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteTask(request, options)

deleteTask(request?: protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest | undefined, {} | undefined]>

deleteTask(request, options, callback)

deleteTask(request: protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteTask(request, callback)

deleteTask(request: protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.tasks.v2beta2.IDeleteTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.iam.v1.IGetIamPolicyRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.iam.v1.IGetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.iam.v1.IGetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

getQueue(request, options)

getQueue(request?: protos.google.cloud.tasks.v2beta2.IGetQueueRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IGetQueueRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IGetQueueRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IGetQueueRequest | undefined, {} | undefined]>

getQueue(request, options, callback)

getQueue(request: protos.google.cloud.tasks.v2beta2.IGetQueueRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IGetQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IGetQueueRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IGetQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getQueue(request, callback)

getQueue(request: protos.google.cloud.tasks.v2beta2.IGetQueueRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IGetQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IGetQueueRequest
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IGetQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getTask(request, options)

getTask(request?: protos.google.cloud.tasks.v2beta2.IGetTaskRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IGetTaskRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IGetTaskRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IGetTaskRequest | undefined, {} | undefined]>

getTask(request, options, callback)

getTask(request: protos.google.cloud.tasks.v2beta2.IGetTaskRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IGetTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IGetTaskRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IGetTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getTask(request, callback)

getTask(request: protos.google.cloud.tasks.v2beta2.IGetTaskRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IGetTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IGetTaskRequest
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IGetTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

leaseTasks(request, options)

leaseTasks(request?: protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.ILeaseTasksResponse, protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.ILeaseTasksResponse, protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest | undefined, {} | undefined]>

leaseTasks(request, options, callback)

leaseTasks(request: protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.ILeaseTasksResponse, protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.ILeaseTasksResponse, protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

leaseTasks(request, callback)

leaseTasks(request: protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.ILeaseTasksResponse, protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest
callback Callback<protos.google.cloud.tasks.v2beta2.ILeaseTasksResponse, protos.google.cloud.tasks.v2beta2.ILeaseTasksRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

listQueues(request, options)

listQueues(request?: protos.google.cloud.tasks.v2beta2.IListQueuesRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.IQueue[], protos.google.cloud.tasks.v2beta2.IListQueuesRequest | null, protos.google.cloud.tasks.v2beta2.IListQueuesResponse]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListQueuesRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.IQueue[], protos.google.cloud.tasks.v2beta2.IListQueuesRequest | null, protos.google.cloud.tasks.v2beta2.IListQueuesResponse]>

listQueues(request, options, callback)

listQueues(request: protos.google.cloud.tasks.v2beta2.IListQueuesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.tasks.v2beta2.IListQueuesRequest, protos.google.cloud.tasks.v2beta2.IListQueuesResponse | null | undefined, protos.google.cloud.tasks.v2beta2.IQueue>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListQueuesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.tasks.v2beta2.IListQueuesRequest, protos.google.cloud.tasks.v2beta2.IListQueuesResponse | null | undefined, protos.google.cloud.tasks.v2beta2.IQueue>
Returns
TypeDescription
void

listQueues(request, callback)

listQueues(request: protos.google.cloud.tasks.v2beta2.IListQueuesRequest, callback: PaginationCallback<protos.google.cloud.tasks.v2beta2.IListQueuesRequest, protos.google.cloud.tasks.v2beta2.IListQueuesResponse | null | undefined, protos.google.cloud.tasks.v2beta2.IQueue>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListQueuesRequest
callback PaginationCallback<protos.google.cloud.tasks.v2beta2.IListQueuesRequest, protos.google.cloud.tasks.v2beta2.IListQueuesResponse | null | undefined, protos.google.cloud.tasks.v2beta2.IQueue>
Returns
TypeDescription
void

listQueuesAsync(request, options)

listQueuesAsync(request?: protos.google.cloud.tasks.v2beta2.IListQueuesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.tasks.v2beta2.IQueue>;

Equivalent to listQueues, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListQueuesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.tasks.v2beta2.IQueue>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Queue]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listQueuesStream(request, options)

listQueuesStream(request?: protos.google.cloud.tasks.v2beta2.IListQueuesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListQueuesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Queue] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listQueuesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTasks(request, options)

listTasks(request?: protos.google.cloud.tasks.v2beta2.IListTasksRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.ITask[], protos.google.cloud.tasks.v2beta2.IListTasksRequest | null, protos.google.cloud.tasks.v2beta2.IListTasksResponse]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListTasksRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.ITask[], protos.google.cloud.tasks.v2beta2.IListTasksRequest | null, protos.google.cloud.tasks.v2beta2.IListTasksResponse]>

listTasks(request, options, callback)

listTasks(request: protos.google.cloud.tasks.v2beta2.IListTasksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.tasks.v2beta2.IListTasksRequest, protos.google.cloud.tasks.v2beta2.IListTasksResponse | null | undefined, protos.google.cloud.tasks.v2beta2.ITask>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListTasksRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.tasks.v2beta2.IListTasksRequest, protos.google.cloud.tasks.v2beta2.IListTasksResponse | null | undefined, protos.google.cloud.tasks.v2beta2.ITask>
Returns
TypeDescription
void

listTasks(request, callback)

listTasks(request: protos.google.cloud.tasks.v2beta2.IListTasksRequest, callback: PaginationCallback<protos.google.cloud.tasks.v2beta2.IListTasksRequest, protos.google.cloud.tasks.v2beta2.IListTasksResponse | null | undefined, protos.google.cloud.tasks.v2beta2.ITask>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListTasksRequest
callback PaginationCallback<protos.google.cloud.tasks.v2beta2.IListTasksRequest, protos.google.cloud.tasks.v2beta2.IListTasksResponse | null | undefined, protos.google.cloud.tasks.v2beta2.ITask>
Returns
TypeDescription
void

listTasksAsync(request, options)

listTasksAsync(request?: protos.google.cloud.tasks.v2beta2.IListTasksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.tasks.v2beta2.ITask>;

Equivalent to listTasks, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListTasksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.tasks.v2beta2.ITask>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Task]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTasksStream(request, options)

listTasksStream(request?: protos.google.cloud.tasks.v2beta2.IListTasksRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IListTasksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Task] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTasksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromQueueName(queueName)

matchLocationFromQueueName(queueName: string): string | number;

Parse the location from Queue resource.

Parameter
NameDescription
queueName string

A fully-qualified path representing Queue resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTaskName(taskName)

matchLocationFromTaskName(taskName: string): string | number;

Parse the location from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromQueueName(queueName)

matchProjectFromQueueName(queueName: string): string | number;

Parse the project from Queue resource.

Parameter
NameDescription
queueName string

A fully-qualified path representing Queue resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTaskName(taskName)

matchProjectFromTaskName(taskName: string): string | number;

Parse the project from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchQueueFromQueueName(queueName)

matchQueueFromQueueName(queueName: string): string | number;

Parse the queue from Queue resource.

Parameter
NameDescription
queueName string

A fully-qualified path representing Queue resource.

Returns
TypeDescription
string | number

{string} A string representing the queue.

matchQueueFromTaskName(taskName)

matchQueueFromTaskName(taskName: string): string | number;

Parse the queue from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the queue.

matchTaskFromTaskName(taskName)

matchTaskFromTaskName(taskName: string): string | number;

Parse the task from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the task.

pauseQueue(request, options)

pauseQueue(request?: protos.google.cloud.tasks.v2beta2.IPauseQueueRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPauseQueueRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IPauseQueueRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPauseQueueRequest | undefined, {} | undefined]>

pauseQueue(request, options, callback)

pauseQueue(request: protos.google.cloud.tasks.v2beta2.IPauseQueueRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPauseQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IPauseQueueRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPauseQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

pauseQueue(request, callback)

pauseQueue(request: protos.google.cloud.tasks.v2beta2.IPauseQueueRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPauseQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IPauseQueueRequest
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPauseQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

purgeQueue(request, options)

purgeQueue(request?: protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest | undefined, {} | undefined]>

purgeQueue(request, options, callback)

purgeQueue(request: protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

purgeQueue(request, callback)

purgeQueue(request: protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IPurgeQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

queuePath(project, location, queue)

queuePath(project: string, location: string, queue: string): string;

Return a fully-qualified queue resource name string.

Parameters
NameDescription
project string
location string
queue string
Returns
TypeDescription
string

{string} Resource name string.

renewLease(request, options)

renewLease(request?: protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest | undefined, {} | undefined]>

renewLease(request, options, callback)

renewLease(request: protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

renewLease(request, callback)

renewLease(request: protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRenewLeaseRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

resumeQueue(request, options)

resumeQueue(request?: protos.google.cloud.tasks.v2beta2.IResumeQueueRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IResumeQueueRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IResumeQueueRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IResumeQueueRequest | undefined, {} | undefined]>

resumeQueue(request, options, callback)

resumeQueue(request: protos.google.cloud.tasks.v2beta2.IResumeQueueRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IResumeQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IResumeQueueRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IResumeQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

resumeQueue(request, callback)

resumeQueue(request: protos.google.cloud.tasks.v2beta2.IResumeQueueRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IResumeQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IResumeQueueRequest
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IResumeQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

runTask(request, options)

runTask(request?: protos.google.cloud.tasks.v2beta2.IRunTaskRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRunTaskRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IRunTaskRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRunTaskRequest | undefined, {} | undefined]>

runTask(request, options, callback)

runTask(request: protos.google.cloud.tasks.v2beta2.IRunTaskRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRunTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IRunTaskRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRunTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

runTask(request, callback)

runTask(request: protos.google.cloud.tasks.v2beta2.IRunTaskRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRunTaskRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IRunTaskRequest
callback Callback<protos.google.cloud.tasks.v2beta2.ITask, protos.google.cloud.tasks.v2beta2.IRunTaskRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.iam.v1.ISetIamPolicyRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.iam.v1.ISetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.iam.v1.ISetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

taskPath(project, location, queue, task)

taskPath(project: string, location: string, queue: string, task: string): string;

Return a fully-qualified task resource name string.

Parameters
NameDescription
project string
location string
queue string
task string
Returns
TypeDescription
string

{string} Resource name string.

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.iam.v1.ITestIamPermissionsRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.iam.v1.ITestIamPermissionsRequest
options CallOptions
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.iam.v1.ITestIamPermissionsRequest
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateQueue(request, options)

updateQueue(request?: protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest, options?: CallOptions): Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest | undefined, {} | undefined]>

updateQueue(request, options, callback)

updateQueue(request: protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest, options: CallOptions, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest
options CallOptions
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateQueue(request, callback)

updateQueue(request: protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest, callback: Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest
callback Callback<protos.google.cloud.tasks.v2beta2.IQueue, protos.google.cloud.tasks.v2beta2.IUpdateQueueRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void