Class protos.google.cloud.workflows.executions.v1.Executions (3.1.1)

Version latest

• 3.1.1 (latest)
• 2.3.2
• 2.2.0
• 1.4.0
• 1.3.1
• 1.2.6

Represents an Executions

Inheritance

$protobuf.rpc.Service > protos.google.cloud.workflows.executions.v1.Executions

Package

@google-cloud/workflows

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Executions service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

cancelExecution(request, callback)

public cancelExecution(request: google.cloud.workflows.executions.v1.ICancelExecutionRequest, callback: google.cloud.workflows.executions.v1.Executions.CancelExecutionCallback): void;

Calls CancelExecution.

Parameters
Name	Description
request	ICancelExecutionRequest CancelExecutionRequest message or plain object
callback	CancelExecutionCallback Node-style callback called with the error, if any, and Execution

Returns
Type	Description
void

cancelExecution(request)

public cancelExecution(request: google.cloud.workflows.executions.v1.ICancelExecutionRequest): Promise<google.cloud.workflows.executions.v1.Execution>;

Calls CancelExecution.

Parameter
Name	Description
request	ICancelExecutionRequest CancelExecutionRequest message or plain object

Returns
Type	Description
Promise<google.cloud.workflows.executions.v1.Execution>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Executions;

Creates new Executions service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
Executions	RPC service. Useful where requests and/or responses are streamed.

createExecution(request, callback)

public createExecution(request: google.cloud.workflows.executions.v1.ICreateExecutionRequest, callback: google.cloud.workflows.executions.v1.Executions.CreateExecutionCallback): void;

Calls CreateExecution.

Parameters
Name	Description
request	ICreateExecutionRequest CreateExecutionRequest message or plain object
callback	CreateExecutionCallback Node-style callback called with the error, if any, and Execution

Returns
Type	Description
void

createExecution(request)

public createExecution(request: google.cloud.workflows.executions.v1.ICreateExecutionRequest): Promise<google.cloud.workflows.executions.v1.Execution>;

Calls CreateExecution.

Parameter
Name	Description
request	ICreateExecutionRequest CreateExecutionRequest message or plain object

Returns
Type	Description
Promise<google.cloud.workflows.executions.v1.Execution>	Promise

getExecution(request, callback)

public getExecution(request: google.cloud.workflows.executions.v1.IGetExecutionRequest, callback: google.cloud.workflows.executions.v1.Executions.GetExecutionCallback): void;

Calls GetExecution.

Parameters
Name	Description
request	IGetExecutionRequest GetExecutionRequest message or plain object
callback	GetExecutionCallback Node-style callback called with the error, if any, and Execution

Returns
Type	Description
void

getExecution(request)

public getExecution(request: google.cloud.workflows.executions.v1.IGetExecutionRequest): Promise<google.cloud.workflows.executions.v1.Execution>;

Calls GetExecution.

Parameter
Name	Description
request	IGetExecutionRequest GetExecutionRequest message or plain object

Returns
Type	Description
Promise<google.cloud.workflows.executions.v1.Execution>	Promise

listExecutions(request, callback)

public listExecutions(request: google.cloud.workflows.executions.v1.IListExecutionsRequest, callback: google.cloud.workflows.executions.v1.Executions.ListExecutionsCallback): void;

Calls ListExecutions.

Parameters
Name	Description
request	IListExecutionsRequest ListExecutionsRequest message or plain object
callback	ListExecutionsCallback Node-style callback called with the error, if any, and ListExecutionsResponse

Returns
Type	Description
void

listExecutions(request)

public listExecutions(request: google.cloud.workflows.executions.v1.IListExecutionsRequest): Promise<google.cloud.workflows.executions.v1.ListExecutionsResponse>;

Calls ListExecutions.

Parameter
Name	Description
request	IListExecutionsRequest ListExecutionsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.workflows.executions.v1.ListExecutionsResponse>	Promise