Class protos.google.cloud.workflows.executions.v1.Executions

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
Type Name Description
$protobuf.RPCImpl rpcImpl

RPC implementation
boolean requestDelimited

Whether requests are length-delimited
boolean responseDelimited

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
Type Name Description
ICancelExecutionRequest request

CancelExecutionRequest message or plain object
google.cloud.workflows.executions.v1.Executions.CancelExecutionCallback callback

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
Type Name Description
ICancelExecutionRequest request

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
Type Name Description
$protobuf.RPCImpl rpcImpl

RPC implementation
boolean requestDelimited

Whether requests are length-delimited
boolean responseDelimited

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
Type Name Description
google.cloud.workflows.executions.v1.ICreateExecutionRequest request

CreateExecutionRequest message or plain object
google.cloud.workflows.executions.v1.Executions.CreateExecutionCallback callback

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
Type Name Description
google.cloud.workflows.executions.v1.ICreateExecutionRequest request

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
Type Name Description
IGetExecutionRequest request

GetExecutionRequest message or plain object
google.cloud.workflows.executions.v1.Executions.GetExecutionCallback callback

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
Type Name Description
IGetExecutionRequest request

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
Type Name Description
google.cloud.workflows.executions.v1.IListExecutionsRequest request

ListExecutionsRequest message or plain object
google.cloud.workflows.executions.v1.Executions.ListExecutionsCallback callback

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
Type Name Description
google.cloud.workflows.executions.v1.IListExecutionsRequest request

ListExecutionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.workflows.executions.v1.ListExecutionsResponse>

Promise