Workflows

google.cloud.workflows.v1. Workflows

Represents a Workflows

Constructor

new Workflows(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Workflows service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createWorkflow(request, callback) → {undefined}

Calls CreateWorkflow.

Parameters:
Name Type Description
request google.cloud.workflows.v1.ICreateWorkflowRequest

CreateWorkflowRequest message or plain object
callback google.cloud.workflows.v1.Workflows.CreateWorkflowCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

createWorkflow(request) → {Promise.<google.longrunning.Operation>}

Calls CreateWorkflow.

Parameters:
Name Type Description
request google.cloud.workflows.v1.ICreateWorkflowRequest

CreateWorkflowRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteWorkflow(request, callback) → {undefined}

Calls DeleteWorkflow.

Parameters:
Name Type Description
request google.cloud.workflows.v1.IDeleteWorkflowRequest

DeleteWorkflowRequest message or plain object
callback google.cloud.workflows.v1.Workflows.DeleteWorkflowCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

deleteWorkflow(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteWorkflow.

Parameters:
Name Type Description
request google.cloud.workflows.v1.IDeleteWorkflowRequest

DeleteWorkflowRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

getWorkflow(request, callback) → {undefined}

Calls GetWorkflow.

Parameters:
Name Type Description
request google.cloud.workflows.v1.IGetWorkflowRequest

GetWorkflowRequest message or plain object
callback google.cloud.workflows.v1.Workflows.GetWorkflowCallback

Node-style callback called with the error, if any, and Workflow
Returns:
Type Description
undefined

getWorkflow(request) → {Promise.<google.cloud.workflows.v1.Workflow>}

Calls GetWorkflow.

Parameters:
Name Type Description
request google.cloud.workflows.v1.IGetWorkflowRequest

GetWorkflowRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.workflows.v1.Workflow>

Promise

listWorkflows(request, callback) → {undefined}

Calls ListWorkflows.

Parameters:
Name Type Description
request google.cloud.workflows.v1.IListWorkflowsRequest

ListWorkflowsRequest message or plain object
callback google.cloud.workflows.v1.Workflows.ListWorkflowsCallback

Node-style callback called with the error, if any, and ListWorkflowsResponse
Returns:
Type Description
undefined

listWorkflows(request) → {Promise.<google.cloud.workflows.v1.ListWorkflowsResponse>}

Calls ListWorkflows.

Parameters:
Name Type Description
request google.cloud.workflows.v1.IListWorkflowsRequest

ListWorkflowsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.workflows.v1.ListWorkflowsResponse>

Promise

updateWorkflow(request, callback) → {undefined}

Calls UpdateWorkflow.

Parameters:
Name Type Description
request google.cloud.workflows.v1.IUpdateWorkflowRequest

UpdateWorkflowRequest message or plain object
callback google.cloud.workflows.v1.Workflows.UpdateWorkflowCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

updateWorkflow(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateWorkflow.

Parameters:
Name Type Description
request google.cloud.workflows.v1.IUpdateWorkflowRequest

UpdateWorkflowRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Workflows}

Creates new Workflows service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
Workflows

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateWorkflowCallback(error, responseopt)

Callback as used by createWorkflow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

DeleteWorkflowCallback(error, responseopt)

Callback as used by deleteWorkflow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

GetWorkflowCallback(error, responseopt)

Callback as used by getWorkflow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.workflows.v1.Workflow <optional>

Workflow

ListWorkflowsCallback(error, responseopt)

Callback as used by listWorkflows.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.workflows.v1.ListWorkflowsResponse <optional>

ListWorkflowsResponse

UpdateWorkflowCallback(error, responseopt)

Callback as used by updateWorkflow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation