Flows

google.cloud.dialogflow.cx.v3beta1. Flows

Represents a Flows

Constructor

new Flows(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

createFlow(request, callback) → {undefined}

Calls CreateFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.ICreateFlowRequest

CreateFlowRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.CreateFlowCallback

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

createFlow(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Flow>}

Calls CreateFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.ICreateFlowRequest

CreateFlowRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.Flow>

Promise

deleteFlow(request, callback) → {undefined}

Calls DeleteFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IDeleteFlowRequest

DeleteFlowRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.DeleteFlowCallback

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

deleteFlow(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IDeleteFlowRequest

DeleteFlowRequest message or plain object
Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

exportFlow(request, callback) → {undefined}

Calls ExportFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IExportFlowRequest

ExportFlowRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.ExportFlowCallback

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

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

Calls ExportFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IExportFlowRequest

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

Promise

getFlow(request, callback) → {undefined}

Calls GetFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IGetFlowRequest

GetFlowRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.GetFlowCallback

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

getFlow(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Flow>}

Calls GetFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IGetFlowRequest

GetFlowRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.Flow>

Promise

getFlowValidationResult(request, callback) → {undefined}

Calls GetFlowValidationResult.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IGetFlowValidationResultRequest

GetFlowValidationResultRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.GetFlowValidationResultCallback

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

getFlowValidationResult(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.FlowValidationResult>}

Calls GetFlowValidationResult.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IGetFlowValidationResultRequest

GetFlowValidationResultRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.FlowValidationResult>

Promise

importFlow(request, callback) → {undefined}

Calls ImportFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IImportFlowRequest

ImportFlowRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.ImportFlowCallback

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

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

Calls ImportFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IImportFlowRequest

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

Promise

listFlows(request, callback) → {undefined}

Calls ListFlows.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IListFlowsRequest

ListFlowsRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.ListFlowsCallback

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

listFlows(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.ListFlowsResponse>}

Calls ListFlows.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IListFlowsRequest

ListFlowsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.ListFlowsResponse>

Promise

trainFlow(request, callback) → {undefined}

Calls TrainFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.ITrainFlowRequest

TrainFlowRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.TrainFlowCallback

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

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

Calls TrainFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.ITrainFlowRequest

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

Promise

updateFlow(request, callback) → {undefined}

Calls UpdateFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IUpdateFlowRequest

UpdateFlowRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.UpdateFlowCallback

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

updateFlow(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Flow>}

Calls UpdateFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IUpdateFlowRequest

UpdateFlowRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.Flow>

Promise

validateFlow(request, callback) → {undefined}

Calls ValidateFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IValidateFlowRequest

ValidateFlowRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Flows.ValidateFlowCallback

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

validateFlow(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.FlowValidationResult>}

Calls ValidateFlow.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3beta1.IValidateFlowRequest

ValidateFlowRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3beta1.FlowValidationResult>

Promise

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

Creates new Flows 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
Flows

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

Type Definitions

CreateFlowCallback(error, responseopt)

Callback as used by createFlow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.Flow <optional>

Flow

DeleteFlowCallback(error, responseopt)

Callback as used by deleteFlow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

ExportFlowCallback(error, responseopt)

Callback as used by exportFlow.

Parameters:
Name Type Attributes Description
error Error | null

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

Operation

GetFlowCallback(error, responseopt)

Callback as used by getFlow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.Flow <optional>

Flow

GetFlowValidationResultCallback(error, responseopt)

Callback as used by getFlowValidationResult.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.FlowValidationResult <optional>

FlowValidationResult

ImportFlowCallback(error, responseopt)

Callback as used by importFlow.

Parameters:
Name Type Attributes Description
error Error | null

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

Operation

ListFlowsCallback(error, responseopt)

Callback as used by listFlows.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.ListFlowsResponse <optional>

ListFlowsResponse

TrainFlowCallback(error, responseopt)

Callback as used by trainFlow.

Parameters:
Name Type Attributes Description
error Error | null

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

Operation

UpdateFlowCallback(error, responseopt)

Callback as used by updateFlow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.Flow <optional>

Flow

ValidateFlowCallback(error, responseopt)

Callback as used by validateFlow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3beta1.FlowValidationResult <optional>

FlowValidationResult