Console
    Contact Us Start free

    Class v2.CloudTasksClient (2.3.6)

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

    Package

    @google-cloud/tasks!

    Constructors

    (constructor)(opts)

      constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

    Construct an instance of CloudTasksClient.

    Parameter
    Name Description
    opts ClientOptions

    Properties

    apiEndpoint

      static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

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

    Property Value
    Type Description
    string

    auth

      auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;
    Property Value
    Type Description
    gax. GoogleAuth

    cloudTasksStub

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

    descriptors

      descriptors 
 : 
  
 Descriptors 
 ;
    Property Value
    Type Description
    Descriptors

    innerApiCalls

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

    pathTemplates

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

    port

      static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

    The port for this API service.

    Property Value
    Type Description
    number

    scopes

      static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

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

    Property Value
    Type Description
    string[]

    servicePath

      static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ;

    The DNS address for this API service.

    Property Value
    Type Description
    string

    warn

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

    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 
 . 
 v2 
 . 
 ICreateQueueRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ICreateQueueRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.ICreateQueueRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.tasks.v2.IQueue , protos. google.cloud.tasks.v2.ICreateQueueRequest | undefined, {} | undefined]>

    createQueue(request, options, callback)

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

    createQueue(request, callback)

      createQueue 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ICreateQueueRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ICreateQueueRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.ICreateQueueRequest
    callback Callback <protos. google.cloud.tasks.v2.IQueue , protos. google.cloud.tasks.v2.ICreateQueueRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    createTask(request, options)

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

    createTask(request, options, callback)

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

    createTask(request, callback)

      createTask 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ICreateTaskRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ITask 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ICreateTaskRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.ICreateTaskRequest
    callback Callback <protos. google.cloud.tasks.v2.ITask , protos. google.cloud.tasks.v2.ICreateTaskRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    deleteQueue(request, options)

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

    deleteQueue(request, options, callback)

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

    deleteQueue(request, callback)

      deleteQueue 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IDeleteQueueRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IDeleteQueueRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IDeleteQueueRequest
    callback Callback <protos. google.protobuf.IEmpty , protos. google.cloud.tasks.v2.IDeleteQueueRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    deleteTask(request, options)

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

    deleteTask(request, options, callback)

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

    deleteTask(request, callback)

      deleteTask 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IDeleteTaskRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IDeleteTaskRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IDeleteTaskRequest
    callback Callback <protos. google.protobuf.IEmpty , protos. google.cloud.tasks.v2.IDeleteTaskRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    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
    Name Description
    request protos. google.iam.v1.IGetIamPolicyRequest
    options CallOptions
    Returns
    Type Description
    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
    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
    Type Description
    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
    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
    Type Description
    void

    getProjectId()

      getProjectId 
 () 
 : 
  
 Promise<string> 
 ;
    Returns
    Type Description
    Promise <string>

    getProjectId(callback)

      getProjectId 
 ( 
 callback 
 : 
  
 Callback<string 
 , 
  
 undefined 
 , 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback Callback <string, undefined, undefined>
    Returns
    Type Description
    void

    getQueue(request, options)

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

    getQueue(request, options, callback)

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

    getQueue(request, callback)

      getQueue 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IGetQueueRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IGetQueueRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IGetQueueRequest
    callback Callback <protos. google.cloud.tasks.v2.IQueue , protos. google.cloud.tasks.v2.IGetQueueRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    getTask(request, options)

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

    getTask(request, options, callback)

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

    getTask(request, callback)

      getTask 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IGetTaskRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ITask 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IGetTaskRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IGetTaskRequest
    callback Callback <protos. google.cloud.tasks.v2.ITask , protos. google.cloud.tasks.v2.IGetTaskRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    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
    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 
 . 
 v2 
 . 
 IListQueuesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
 [], 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListQueuesRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListQueuesResponse 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IListQueuesRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.tasks.v2.IQueue [], protos. google.cloud.tasks.v2.IListQueuesRequest | null, protos. google.cloud.tasks.v2.IListQueuesResponse ]>

    listQueues(request, options, callback)

      listQueues 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListQueuesRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListQueuesRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListQueuesResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IListQueuesRequest
    options CallOptions
    callback PaginationCallback <protos. google.cloud.tasks.v2.IListQueuesRequest , protos. google.cloud.tasks.v2.IListQueuesResponse | null | undefined, protos. google.cloud.tasks.v2.IQueue >
    Returns
    Type Description
    void

    listQueues(request, callback)

      listQueues 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListQueuesRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListQueuesRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListQueuesResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IListQueuesRequest
    callback PaginationCallback <protos. google.cloud.tasks.v2.IListQueuesRequest , protos. google.cloud.tasks.v2.IListQueuesResponse | null | undefined, protos. google.cloud.tasks.v2.IQueue >
    Returns
    Type Description
    void

    listQueuesAsync(request, options)

      listQueuesAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListQueuesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 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.v2.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.v2.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 
 . 
 v2 
 . 
 IListQueuesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ;

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

    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.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 
 . 
 v2 
 . 
 IListTasksRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ITask 
 [], 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListTasksRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListTasksResponse 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IListTasksRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.tasks.v2.ITask [], protos. google.cloud.tasks.v2.IListTasksRequest | null, protos. google.cloud.tasks.v2.IListTasksResponse ]>

    listTasks(request, options, callback)

      listTasks 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListTasksRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListTasksRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListTasksResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ITask 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IListTasksRequest
    options CallOptions
    callback PaginationCallback <protos. google.cloud.tasks.v2.IListTasksRequest , protos. google.cloud.tasks.v2.IListTasksResponse | null | undefined, protos. google.cloud.tasks.v2.ITask >
    Returns
    Type Description
    void

    listTasks(request, callback)

      listTasks 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListTasksRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListTasksRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListTasksResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ITask 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IListTasksRequest
    callback PaginationCallback <protos. google.cloud.tasks.v2.IListTasksRequest , protos. google.cloud.tasks.v2.IListTasksResponse | null | undefined, protos. google.cloud.tasks.v2.ITask >
    Returns
    Type Description
    void

    listTasksAsync(request, options)

      listTasksAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IListTasksRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 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.v2.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.v2.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 
 . 
 v2 
 . 
 IListTasksRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ;

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

    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.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
    Name Description
    project string
    location string
    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 
 . 
 v2 
 . 
 IPauseQueueRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IPauseQueueRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IPauseQueueRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.tasks.v2.IQueue , protos. google.cloud.tasks.v2.IPauseQueueRequest | undefined, {} | undefined]>

    pauseQueue(request, options, callback)

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

    pauseQueue(request, callback)

      pauseQueue 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IPauseQueueRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IPauseQueueRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IPauseQueueRequest
    callback Callback <protos. google.cloud.tasks.v2.IQueue , protos. google.cloud.tasks.v2.IPauseQueueRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    projectPath(project)

      projectPath 
 ( 
 project 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified project resource name string.

    Parameter
    Name Description
    project string
    Returns
    Type Description
    string

    {string} Resource name string.

    purgeQueue(request, options)

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

    purgeQueue(request, options, callback)

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

    purgeQueue(request, callback)

      purgeQueue 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IPurgeQueueRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IPurgeQueueRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IPurgeQueueRequest
    callback Callback <protos. google.cloud.tasks.v2.IQueue , protos. google.cloud.tasks.v2.IPurgeQueueRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    queuePath(project, location, queue)

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

    Return a fully-qualified queue resource name string.

    Parameters
    Name Description
    project string
    location string
    queue string
    Returns
    Type Description
    string

    {string} Resource name string.

    resumeQueue(request, options)

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

    resumeQueue(request, options, callback)

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

    resumeQueue(request, callback)

      resumeQueue 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IResumeQueueRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IResumeQueueRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IResumeQueueRequest
    callback Callback <protos. google.cloud.tasks.v2.IQueue , protos. google.cloud.tasks.v2.IResumeQueueRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    runTask(request, options)

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

    runTask(request, options, callback)

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

    runTask(request, callback)

      runTask 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IRunTaskRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 ITask 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IRunTaskRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IRunTaskRequest
    callback Callback <protos. google.cloud.tasks.v2.ITask , protos. google.cloud.tasks.v2.IRunTaskRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    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
    Name Description
    request protos. google.iam.v1.ISetIamPolicyRequest
    options CallOptions
    Returns
    Type Description
    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
    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
    Type Description
    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
    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
    Type Description
    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
    Name Description
    project string
    location string
    queue string
    task string
    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
    Type Description
    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
    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
    Type Description
    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
    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
    Type Description
    void

    updateQueue(request, options)

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

    updateQueue(request, options, callback)

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

    updateQueue(request, callback)

      updateQueue 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IUpdateQueueRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IQueue 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 tasks 
 . 
 v2 
 . 
 IUpdateQueueRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.tasks.v2.IUpdateQueueRequest
    callback Callback <protos. google.cloud.tasks.v2.IQueue , protos. google.cloud.tasks.v2.IUpdateQueueRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: