Class v1.ExecutionsClient

Executions is used to start and manage running instances of called executions. v1

Package

@google-cloud/workflows!

Constructors

(constructor)(opts)

  constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 ); 
 

Construct an instance of ExecutionsClient.

Parameter
Type Name Description
ClientOptions
opts

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

descriptors

  descriptors 
 : 
  
 Descriptors 
 ; 
 
Property Value
Type Description
Descriptors

executionsStub

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

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

cancelExecution(request, options)

  cancelExecution 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICancelExecutionRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 , 
  
 ( 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICancelExecutionRequest 
  
 | 
  
 undefined 
 ), 
  
 {} 
  
 | 
  
 undefined 
 ]>; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest
request
CallOptions
options
Returns
Type Description
Promise <[protos. google.cloud.workflows.executions.v1.IExecution , (protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest | undefined), {} | undefined]>

cancelExecution(request, options, callback)

  cancelExecution 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICancelExecutionRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICancelExecutionRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest
request
CallOptions
options
Callback <protos. google.cloud.workflows.executions.v1.IExecution , protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest | null | undefined, {} | null | undefined>
callback
Returns
Type Description
void

cancelExecution(request, callback)

  cancelExecution 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICancelExecutionRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICancelExecutionRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest
request
Callback <protos. google.cloud.workflows.executions.v1.IExecution , protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest | null | undefined, {} | null | undefined>
callback
Returns
Type Description
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
Type Description
Promise <void>

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

createExecution(request, options)

  createExecution 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICreateExecutionRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 , 
  
 ( 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICreateExecutionRequest 
  
 | 
  
 undefined 
 ), 
  
 {} 
  
 | 
  
 undefined 
 ]>; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest
request
CallOptions
options
Returns
Type Description
Promise <[protos. google.cloud.workflows.executions.v1.IExecution , (protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest | undefined), {} | undefined]>

createExecution(request, options, callback)

  createExecution 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICreateExecutionRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICreateExecutionRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest
request
CallOptions
options
Callback <protos. google.cloud.workflows.executions.v1.IExecution , protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest | null | undefined, {} | null | undefined>
callback
Returns
Type Description
void

createExecution(request, callback)

  createExecution 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICreateExecutionRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 ICreateExecutionRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest
request
Callback <protos. google.cloud.workflows.executions.v1.IExecution , protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest | null | undefined, {} | null | undefined>
callback
Returns
Type Description
void

executionPath(project, location, workflow, execution)

  executionPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 workflow 
 : 
  
 string 
 , 
  
 execution 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified execution resource name string.

Parameters
Type Name Description
string
project
string
location
string
workflow
string
execution
Returns
Type Description
string

{string} Resource name string.

getExecution(request, options)

  getExecution 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IGetExecutionRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 , 
  
 ( 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IGetExecutionRequest 
  
 | 
  
 undefined 
 ), 
  
 {} 
  
 | 
  
 undefined 
 ]>; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.IGetExecutionRequest
request
CallOptions
options
Returns
Type Description
Promise <[protos. google.cloud.workflows.executions.v1.IExecution , (protos. google.cloud.workflows.executions.v1.IGetExecutionRequest | undefined), {} | undefined]>

getExecution(request, options, callback)

  getExecution 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IGetExecutionRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IGetExecutionRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.IGetExecutionRequest
request
CallOptions
options
Callback <protos. google.cloud.workflows.executions.v1.IExecution , protos. google.cloud.workflows.executions.v1.IGetExecutionRequest | null | undefined, {} | null | undefined>
callback
Returns
Type Description
void

getExecution(request, callback)

  getExecution 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IGetExecutionRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IGetExecutionRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.IGetExecutionRequest
request
Callback <protos. google.cloud.workflows.executions.v1.IExecution , protos. google.cloud.workflows.executions.v1.IGetExecutionRequest | null | undefined, {} | null | undefined>
callback
Returns
Type Description
void

getProjectId()

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

getProjectId(callback)

  getProjectId 
 ( 
 callback 
 : 
  
 Callback<string 
 , 
  
 undefined 
 , 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameter
Type Name Description
Callback <string, undefined, undefined>
callback
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.

listExecutions(request, options)

  listExecutions 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
 [], 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsResponse 
 ]>; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
request
CallOptions
options
Returns
Type Description
Promise <[protos. google.cloud.workflows.executions.v1.IExecution [], protos. google.cloud.workflows.executions.v1.IListExecutionsRequest | null, protos. google.cloud.workflows.executions.v1.IListExecutionsResponse ]>

listExecutions(request, options, callback)

  listExecutions 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
request
CallOptions
options
PaginationCallback <protos. google.cloud.workflows.executions.v1.IListExecutionsRequest , protos. google.cloud.workflows.executions.v1.IListExecutionsResponse | null | undefined, protos. google.cloud.workflows.executions.v1.IExecution >
callback
Returns
Type Description
void

listExecutions(request, callback)

  listExecutions 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
request
PaginationCallback <protos. google.cloud.workflows.executions.v1.IListExecutionsRequest , protos. google.cloud.workflows.executions.v1.IListExecutionsResponse | null | undefined, protos. google.cloud.workflows.executions.v1.IExecution >
callback
Returns
Type Description
void

listExecutionsAsync(request, options)

  listExecutionsAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IExecution 
> ; 
 

Equivalent to listExecutions , but returns an iterable object.

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

Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
request

The request object that will be sent.

CallOptions
options

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable <protos. google.cloud.workflows.executions.v1.IExecution >

{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 [Execution]. 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.

listExecutionsStream(request, options)

  listExecutionsStream 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 workflows 
 . 
 executions 
 . 
 v1 
 . 
 IListExecutionsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ; 
 

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

Parameters
Type Name Description
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
request

The request object that will be sent.

CallOptions
options

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Execution] 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 listExecutionsAsync() 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.

matchExecutionFromExecutionName(executionName)

  matchExecutionFromExecutionName 
 ( 
 executionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the execution from Execution resource.

Parameter
Type Name Description
string
executionName

A fully-qualified path representing Execution resource.

Returns
Type Description
string | number

{string} A string representing the execution.

matchLocationFromExecutionName(executionName)

  matchLocationFromExecutionName 
 ( 
 executionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the location from Execution resource.

Parameter
Type Name Description
string
executionName

A fully-qualified path representing Execution resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromWorkflowName(workflowName)

  matchLocationFromWorkflowName 
 ( 
 workflowName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the location from Workflow resource.

Parameter
Type Name Description
string
workflowName

A fully-qualified path representing Workflow resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchProjectFromExecutionName(executionName)

  matchProjectFromExecutionName 
 ( 
 executionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the project from Execution resource.

Parameter
Type Name Description
string
executionName

A fully-qualified path representing Execution resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromWorkflowName(workflowName)

  matchProjectFromWorkflowName 
 ( 
 workflowName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the project from Workflow resource.

Parameter
Type Name Description
string
workflowName

A fully-qualified path representing Workflow resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchWorkflowFromExecutionName(executionName)

  matchWorkflowFromExecutionName 
 ( 
 executionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the workflow from Execution resource.

Parameter
Type Name Description
string
executionName

A fully-qualified path representing Execution resource.

Returns
Type Description
string | number

{string} A string representing the workflow.

matchWorkflowFromWorkflowName(workflowName)

  matchWorkflowFromWorkflowName 
 ( 
 workflowName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the workflow from Workflow resource.

Parameter
Type Name Description
string
workflowName

A fully-qualified path representing Workflow resource.

Returns
Type Description
string | number

{string} A string representing the workflow.

workflowPath(project, location, workflow)

  workflowPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 workflow 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified workflow resource name string.

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

{string} Resource name string.

Create a Mobile Website
View Site in Mobile | Classic
Share by: