Send feedback
Class v2beta3.CloudTasksClient (2.3.6) Stay organized with collections
Save and categorize content based on your preferences.
Version 2.3.6 keyboard_arrow_down
Cloud Tasks allows developers to manage the execution of background work in their applications. v2beta3
Package
@google-cloud/tasks!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of CloudTasksClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
cloudTasksStub
cloudTasksStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
> void
;
Property Value
Methods
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 Type
Description
Promise
<void>
{Promise} A promise that resolves when the client is closed.
createQueue(request, options)
createQueue
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateQueueRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateQueueRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.ICreateQueueRequest
options
CallOptions
Returns
createQueue(request, options, callback)
createQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateQueueRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.ICreateQueueRequest
options
CallOptions
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.ICreateQueueRequest
| null | undefined, {} | null | undefined>
Returns
createQueue(request, callback)
createQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateQueueRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.ICreateQueueRequest
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.ICreateQueueRequest
| null | undefined, {} | null | undefined>
Returns
createTask(request, options)
createTask
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateTaskRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateTaskRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.ICreateTaskRequest
options
CallOptions
Returns
createTask(request, options, callback)
createTask
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateTaskRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.ICreateTaskRequest
options
CallOptions
callback
Callback
<protos. google.cloud.tasks.v2beta3.ITask
, protos. google.cloud.tasks.v2beta3.ICreateTaskRequest
| null | undefined, {} | null | undefined>
Returns
createTask(request, callback)
createTask
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateTaskRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ICreateTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.ICreateTaskRequest
callback
Callback
<protos. google.cloud.tasks.v2beta3.ITask
, protos. google.cloud.tasks.v2beta3.ICreateTaskRequest
| null | undefined, {} | null | undefined>
Returns
deleteQueue(request, options)
deleteQueue
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteQueueRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteQueueRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IDeleteQueueRequest
options
CallOptions
Returns
deleteQueue(request, options, callback)
deleteQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteQueueRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IDeleteQueueRequest
options
CallOptions
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.tasks.v2beta3.IDeleteQueueRequest
| null | undefined, {} | null | undefined>
Returns
deleteQueue(request, callback)
deleteQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteQueueRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IDeleteQueueRequest
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.tasks.v2beta3.IDeleteQueueRequest
| null | undefined, {} | null | undefined>
Returns
deleteTask(request, options)
deleteTask
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteTaskRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteTaskRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IDeleteTaskRequest
options
CallOptions
Returns
deleteTask(request, options, callback)
deleteTask
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteTaskRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IDeleteTaskRequest
options
CallOptions
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.tasks.v2beta3.IDeleteTaskRequest
| null | undefined, {} | null | undefined>
Returns
deleteTask(request, callback)
deleteTask
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteTaskRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IDeleteTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IDeleteTaskRequest
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.tasks.v2beta3.IDeleteTaskRequest
| null | undefined, {} | null | undefined>
Returns
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 Name
Description
request
protos. google.iam.v1.IGetIamPolicyRequest
options
CallOptions
Returns
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 Name
Description
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
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 Name
Description
request
protos. google.iam.v1.IGetIamPolicyRequest
callback
Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.IGetIamPolicyRequest
| null | undefined, {} | null | undefined>
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter Name
Description
callback
Callback
<string, undefined, undefined>
Returns
getQueue(request, options)
getQueue
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetQueueRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetQueueRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IGetQueueRequest
options
CallOptions
Returns
getQueue(request, options, callback)
getQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetQueueRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IGetQueueRequest
options
CallOptions
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IGetQueueRequest
| null | undefined, {} | null | undefined>
Returns
getQueue(request, callback)
getQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetQueueRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IGetQueueRequest
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IGetQueueRequest
| null | undefined, {} | null | undefined>
Returns
getTask(request, options)
getTask
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetTaskRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetTaskRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IGetTaskRequest
options
CallOptions
Returns
getTask(request, options, callback)
getTask
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetTaskRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IGetTaskRequest
options
CallOptions
callback
Callback
<protos. google.cloud.tasks.v2beta3.ITask
, protos. google.cloud.tasks.v2beta3.IGetTaskRequest
| null | undefined, {} | null | undefined>
Returns
getTask(request, callback)
getTask
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetTaskRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IGetTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IGetTaskRequest
callback
Callback
<protos. google.cloud.tasks.v2beta3.ITask
, protos. google.cloud.tasks.v2beta3.IGetTaskRequest
| null | undefined, {} | null | undefined>
Returns
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 Type
Description
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listQueues(request, options)
listQueues
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
[],
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesRequest
|
null
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesResponse
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IListQueuesRequest
options
CallOptions
Returns
listQueues(request, options, callback)
listQueues
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesRequest
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IListQueuesRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.tasks.v2beta3.IListQueuesRequest
, protos. google.cloud.tasks.v2beta3.IListQueuesResponse
| null | undefined, protos. google.cloud.tasks.v2beta3.IQueue
>
Returns
listQueues(request, callback)
listQueues
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesRequest
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IListQueuesRequest
callback
PaginationCallback
<protos. google.cloud.tasks.v2beta3.IListQueuesRequest
, protos. google.cloud.tasks.v2beta3.IListQueuesResponse
| null | undefined, protos. google.cloud.tasks.v2beta3.IQueue
>
Returns
listQueuesAsync(request, options)
listQueuesAsync
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListQueuesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
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 Name
Description
request
protos. google.cloud.tasks.v2beta3.IListQueuesRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
AsyncIterable
<protos. google.cloud.tasks.v2beta3.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
.
v2beta3
.
IListQueuesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IListQueuesRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
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
.
v2beta3
.
IListTasksRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
[],
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListTasksRequest
|
null
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListTasksResponse
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IListTasksRequest
options
CallOptions
Returns
listTasks(request, options, callback)
listTasks
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListTasksRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListTasksRequest
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListTasksResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IListTasksRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.tasks.v2beta3.IListTasksRequest
, protos. google.cloud.tasks.v2beta3.IListTasksResponse
| null | undefined, protos. google.cloud.tasks.v2beta3.ITask
>
Returns
listTasks(request, callback)
listTasks
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListTasksRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListTasksRequest
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListTasksResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IListTasksRequest
callback
PaginationCallback
<protos. google.cloud.tasks.v2beta3.IListTasksRequest
, protos. google.cloud.tasks.v2beta3.IListTasksResponse
| null | undefined, protos. google.cloud.tasks.v2beta3.ITask
>
Returns
listTasksAsync(request, options)
listTasksAsync
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IListTasksRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
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 Name
Description
request
protos. google.cloud.tasks.v2beta3.IListTasksRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
AsyncIterable
<protos. google.cloud.tasks.v2beta3.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
.
v2beta3
.
IListTasksRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IListTasksRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
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
Returns Type
Description
string
{string} Resource name string.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
Parameter Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns Type
Description
string | number
{string} A string representing the location.
matchLocationFromQueueName(queueName)
matchLocationFromQueueName
(
queueName
:
string
)
:
string
|
number
;
Parse the location from Queue resource.
Parameter Name
Description
queueName
string
A fully-qualified path representing Queue resource.
Returns Type
Description
string | number
{string} A string representing the location.
matchLocationFromTaskName(taskName)
matchLocationFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the location from Task resource.
Parameter Name
Description
taskName
string
A fully-qualified path representing Task resource.
Returns Type
Description
string | number
{string} A string representing the location.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
Parameter Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
Parameter Name
Description
projectName
string
A fully-qualified path representing Project resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromQueueName(queueName)
matchProjectFromQueueName
(
queueName
:
string
)
:
string
|
number
;
Parse the project from Queue resource.
Parameter Name
Description
queueName
string
A fully-qualified path representing Queue resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromTaskName(taskName)
matchProjectFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the project from Task resource.
Parameter Name
Description
taskName
string
A fully-qualified path representing Task resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchQueueFromQueueName(queueName)
matchQueueFromQueueName
(
queueName
:
string
)
:
string
|
number
;
Parse the queue from Queue resource.
Parameter Name
Description
queueName
string
A fully-qualified path representing Queue resource.
Returns Type
Description
string | number
{string} A string representing the queue.
matchQueueFromTaskName(taskName)
matchQueueFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the queue from Task resource.
Parameter Name
Description
taskName
string
A fully-qualified path representing Task resource.
Returns Type
Description
string | number
{string} A string representing the queue.
matchTaskFromTaskName(taskName)
matchTaskFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the task from Task resource.
Parameter Name
Description
taskName
string
A fully-qualified path representing Task resource.
Returns Type
Description
string | number
{string} A string representing the task.
pauseQueue(request, options)
pauseQueue
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPauseQueueRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPauseQueueRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IPauseQueueRequest
options
CallOptions
Returns
pauseQueue(request, options, callback)
pauseQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPauseQueueRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPauseQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IPauseQueueRequest
options
CallOptions
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IPauseQueueRequest
| null | undefined, {} | null | undefined>
Returns
pauseQueue(request, callback)
pauseQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPauseQueueRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPauseQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IPauseQueueRequest
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IPauseQueueRequest
| null | undefined, {} | null | undefined>
Returns
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
Parameter
Returns Type
Description
string
{string} Resource name string.
purgeQueue(request, options)
purgeQueue
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPurgeQueueRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPurgeQueueRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IPurgeQueueRequest
options
CallOptions
Returns
purgeQueue(request, options, callback)
purgeQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPurgeQueueRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPurgeQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IPurgeQueueRequest
options
CallOptions
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IPurgeQueueRequest
| null | undefined, {} | null | undefined>
Returns
purgeQueue(request, callback)
purgeQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPurgeQueueRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IPurgeQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IPurgeQueueRequest
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IPurgeQueueRequest
| null | undefined, {} | null | undefined>
Returns
queuePath(project, location, queue)
queuePath
(
project
:
string
,
location
:
string
,
queue
:
string
)
:
string
;
Return a fully-qualified queue resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
resumeQueue(request, options)
resumeQueue
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IResumeQueueRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IResumeQueueRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IResumeQueueRequest
options
CallOptions
Returns
resumeQueue(request, options, callback)
resumeQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IResumeQueueRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IResumeQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IResumeQueueRequest
options
CallOptions
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IResumeQueueRequest
| null | undefined, {} | null | undefined>
Returns
resumeQueue(request, callback)
resumeQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IResumeQueueRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IResumeQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IResumeQueueRequest
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IResumeQueueRequest
| null | undefined, {} | null | undefined>
Returns
runTask(request, options)
runTask
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IRunTaskRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IRunTaskRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IRunTaskRequest
options
CallOptions
Returns
runTask(request, options, callback)
runTask
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IRunTaskRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IRunTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IRunTaskRequest
options
CallOptions
callback
Callback
<protos. google.cloud.tasks.v2beta3.ITask
, protos. google.cloud.tasks.v2beta3.IRunTaskRequest
| null | undefined, {} | null | undefined>
Returns
runTask(request, callback)
runTask
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IRunTaskRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
ITask
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IRunTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IRunTaskRequest
callback
Callback
<protos. google.cloud.tasks.v2beta3.ITask
, protos. google.cloud.tasks.v2beta3.IRunTaskRequest
| null | undefined, {} | null | undefined>
Returns
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 Name
Description
request
protos. google.iam.v1.ISetIamPolicyRequest
options
CallOptions
Returns
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 Name
Description
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
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 Name
Description
request
protos. google.iam.v1.ISetIamPolicyRequest
callback
Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.ISetIamPolicyRequest
| null | undefined, {} | null | undefined>
Returns
taskPath(project, location, queue, task)
taskPath
(
project
:
string
,
location
:
string
,
queue
:
string
,
task
:
string
)
:
string
;
Return a fully-qualified task resource name string.
Parameters
Returns Type
Description
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 Name
Description
request
protos. google.iam.v1.ITestIamPermissionsRequest
options
CallOptions
Returns
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 Name
Description
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
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 Name
Description
request
protos. google.iam.v1.ITestIamPermissionsRequest
callback
Callback
<protos. google.iam.v1.ITestIamPermissionsResponse
, protos. google.iam.v1.ITestIamPermissionsRequest
| null | undefined, {} | null | undefined>
Returns
updateQueue(request, options)
updateQueue
(
request
?:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IUpdateQueueRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IUpdateQueueRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IUpdateQueueRequest
options
CallOptions
Returns
updateQueue(request, options, callback)
updateQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IUpdateQueueRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IUpdateQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IUpdateQueueRequest
options
CallOptions
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IUpdateQueueRequest
| null | undefined, {} | null | undefined>
Returns
updateQueue(request, callback)
updateQueue
(
request
:
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IUpdateQueueRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IQueue
,
protos
.
google
.
cloud
.
tasks
.
v2beta3
.
IUpdateQueueRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.tasks.v2beta3.IUpdateQueueRequest
callback
Callback
<protos. google.cloud.tasks.v2beta3.IQueue
, protos. google.cloud.tasks.v2beta3.IUpdateQueueRequest
| null | undefined, {} | null | undefined>
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
