Class protos.google.cloud.workflows.v1beta.Workflows

Represents a Workflows

Inheritance

$protobuf.rpc.Service > protos.google.cloud.workflows.v1beta.Workflows

Package

@google-cloud/workflows!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Workflows 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

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new Workflows 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
Workflows	RPC service. Useful where requests and/or responses are streamed.

createWorkflow(request, callback)

public createWorkflow(request: google.cloud.workflows.v1beta.ICreateWorkflowRequest, callback: google.cloud.workflows.v1beta.Workflows.CreateWorkflowCallback): void;

Calls CreateWorkflow.

Parameters

Type	Name	Description
google.cloud.workflows.v1beta.ICreateWorkflowRequest	request	CreateWorkflowRequest message or plain object
google.cloud.workflows.v1beta.Workflows.CreateWorkflowCallback	callback	Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

createWorkflow(request)

public createWorkflow(request: google.cloud.workflows.v1beta.ICreateWorkflowRequest): Promise<google.longrunning.Operation>;

Calls CreateWorkflow.

Parameter

Type	Name	Description
google.cloud.workflows.v1beta.ICreateWorkflowRequest	request	CreateWorkflowRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

deleteWorkflow(request, callback)

public deleteWorkflow(request: google.cloud.workflows.v1beta.IDeleteWorkflowRequest, callback: google.cloud.workflows.v1beta.Workflows.DeleteWorkflowCallback): void;

Calls DeleteWorkflow.

Parameters

Type	Name	Description
google.cloud.workflows.v1beta.IDeleteWorkflowRequest	request	DeleteWorkflowRequest message or plain object
google.cloud.workflows.v1beta.Workflows.DeleteWorkflowCallback	callback	Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

deleteWorkflow(request)

public deleteWorkflow(request: google.cloud.workflows.v1beta.IDeleteWorkflowRequest): Promise<google.longrunning.Operation>;

Calls DeleteWorkflow.

Parameter

Type	Name	Description
google.cloud.workflows.v1beta.IDeleteWorkflowRequest	request	DeleteWorkflowRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

getWorkflow(request, callback)

public getWorkflow(request: google.cloud.workflows.v1beta.IGetWorkflowRequest, callback: google.cloud.workflows.v1beta.Workflows.GetWorkflowCallback): void;

Calls GetWorkflow.

Parameters

Type	Name	Description
google.cloud.workflows.v1beta.IGetWorkflowRequest	request	GetWorkflowRequest message or plain object
google.cloud.workflows.v1beta.Workflows.GetWorkflowCallback	callback	Node-style callback called with the error, if any, and Workflow

Returns

Type	Description
void

getWorkflow(request)

public getWorkflow(request: google.cloud.workflows.v1beta.IGetWorkflowRequest): Promise<google.cloud.workflows.v1beta.Workflow>;

Calls GetWorkflow.

Parameter

Type	Name	Description
google.cloud.workflows.v1beta.IGetWorkflowRequest	request	GetWorkflowRequest message or plain object

Returns

Type	Description
Promise<google.cloud.workflows.v1beta.Workflow>	Promise

listWorkflows(request, callback)

public listWorkflows(request: google.cloud.workflows.v1beta.IListWorkflowsRequest, callback: google.cloud.workflows.v1beta.Workflows.ListWorkflowsCallback): void;

Calls ListWorkflows.

Parameters

Type	Name	Description
IListWorkflowsRequest	request	ListWorkflowsRequest message or plain object
google.cloud.workflows.v1beta.Workflows.ListWorkflowsCallback	callback	Node-style callback called with the error, if any, and ListWorkflowsResponse

Returns

Type	Description
void

listWorkflows(request)

public listWorkflows(request: google.cloud.workflows.v1beta.IListWorkflowsRequest): Promise<google.cloud.workflows.v1beta.ListWorkflowsResponse>;

Calls ListWorkflows.

Parameter

Type	Name	Description
IListWorkflowsRequest	request	ListWorkflowsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.workflows.v1beta.ListWorkflowsResponse>	Promise

updateWorkflow(request, callback)

public updateWorkflow(request: google.cloud.workflows.v1beta.IUpdateWorkflowRequest, callback: google.cloud.workflows.v1beta.Workflows.UpdateWorkflowCallback): void;

Calls UpdateWorkflow.

Parameters

Type	Name	Description
IUpdateWorkflowRequest	request	UpdateWorkflowRequest message or plain object
google.cloud.workflows.v1beta.Workflows.UpdateWorkflowCallback	callback	Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

updateWorkflow(request)

public updateWorkflow(request: google.cloud.workflows.v1beta.IUpdateWorkflowRequest): Promise<google.longrunning.Operation>;

Calls UpdateWorkflow.

Parameter

Type	Name	Description
IUpdateWorkflowRequest	request	UpdateWorkflowRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise