Class protos.google.cloud.workflows.v1.Workflows (3.1.1)

Represents a Workflows

Inheritance

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

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Workflows service.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` 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
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` 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.v1.ICreateWorkflowRequest, callback: google.cloud.workflows.v1.Workflows.CreateWorkflowCallback): void;

Calls CreateWorkflow.

Parameters
Name	Description
`request`	`ICreateWorkflowRequest` CreateWorkflowRequest message or plain object
`callback`	`CreateWorkflowCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

createWorkflow(request)

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

Calls CreateWorkflow.

Parameter
Name	Description
`request`	`ICreateWorkflowRequest` CreateWorkflowRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

deleteWorkflow(request, callback)

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

Calls DeleteWorkflow.

Parameters
Name	Description
`request`	`IDeleteWorkflowRequest` DeleteWorkflowRequest message or plain object
`callback`	`DeleteWorkflowCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

deleteWorkflow(request)

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

Calls DeleteWorkflow.

Parameter
Name	Description
`request`	`IDeleteWorkflowRequest` DeleteWorkflowRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

getWorkflow(request, callback)

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

Calls GetWorkflow.

Parameters
Name	Description
`request`	`IGetWorkflowRequest` GetWorkflowRequest message or plain object
`callback`	`GetWorkflowCallback` Node-style callback called with the error, if any, and Workflow

Returns
Type	Description
`void`

getWorkflow(request)

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

Calls GetWorkflow.

Parameter
Name	Description
`request`	`IGetWorkflowRequest` GetWorkflowRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workflows.v1.Workflow>`	Promise

listWorkflows(request, callback)

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

Calls ListWorkflows.

Parameters
Name	Description
`request`	`IListWorkflowsRequest` ListWorkflowsRequest message or plain object
`callback`	`ListWorkflowsCallback` Node-style callback called with the error, if any, and ListWorkflowsResponse

Returns
Type	Description
`void`

listWorkflows(request)

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

Calls ListWorkflows.

Parameter
Name	Description
`request`	`IListWorkflowsRequest` ListWorkflowsRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workflows.v1.ListWorkflowsResponse>`	Promise

updateWorkflow(request, callback)

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

Calls UpdateWorkflow.

Parameters
Name	Description
`request`	`IUpdateWorkflowRequest` UpdateWorkflowRequest message or plain object
`callback`	`UpdateWorkflowCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

updateWorkflow(request)

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

Calls UpdateWorkflow.

Parameter
Name	Description
`request`	`IUpdateWorkflowRequest` UpdateWorkflowRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise