Class protos.google.cloud.dialogflow.cx.v3.Flows (3.4.2)

Represents a Flows

Inheritance

$protobuf.rpc.Service > protos.google.cloud.dialogflow.cx.v3.Flows

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

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

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

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

createFlow(request, callback)

public createFlow(request: google.cloud.dialogflow.cx.v3.ICreateFlowRequest, callback: google.cloud.dialogflow.cx.v3.Flows.CreateFlowCallback): void;

Calls CreateFlow.

Parameters
Name Description
request ICreateFlowRequest

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

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

createFlow(request)

public createFlow(request: google.cloud.dialogflow.cx.v3.ICreateFlowRequest): Promise<google.cloud.dialogflow.cx.v3.Flow>;

Calls CreateFlow.

Parameter
Name Description
request ICreateFlowRequest

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

Promise

deleteFlow(request, callback)

public deleteFlow(request: google.cloud.dialogflow.cx.v3.IDeleteFlowRequest, callback: google.cloud.dialogflow.cx.v3.Flows.DeleteFlowCallback): void;

Calls DeleteFlow.

Parameters
Name Description
request IDeleteFlowRequest

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

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

deleteFlow(request)

public deleteFlow(request: google.cloud.dialogflow.cx.v3.IDeleteFlowRequest): Promise<google.protobuf.Empty>;

Calls DeleteFlow.

Parameter
Name Description
request IDeleteFlowRequest

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

Promise

exportFlow(request, callback)

public exportFlow(request: google.cloud.dialogflow.cx.v3.IExportFlowRequest, callback: google.cloud.dialogflow.cx.v3.Flows.ExportFlowCallback): void;

Calls ExportFlow.

Parameters
Name Description
request IExportFlowRequest

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

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

exportFlow(request)

public exportFlow(request: google.cloud.dialogflow.cx.v3.IExportFlowRequest): Promise<google.longrunning.Operation>;

Calls ExportFlow.

Parameter
Name Description
request IExportFlowRequest

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

Promise

getFlow(request, callback)

public getFlow(request: google.cloud.dialogflow.cx.v3.IGetFlowRequest, callback: google.cloud.dialogflow.cx.v3.Flows.GetFlowCallback): void;

Calls GetFlow.

Parameters
Name Description
request google.cloud.dialogflow.cx.v3.IGetFlowRequest

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

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

getFlow(request)

public getFlow(request: google.cloud.dialogflow.cx.v3.IGetFlowRequest): Promise<google.cloud.dialogflow.cx.v3.Flow>;

Calls GetFlow.

Parameter
Name Description
request google.cloud.dialogflow.cx.v3.IGetFlowRequest

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

Promise

getFlowValidationResult(request, callback)

public getFlowValidationResult(request: google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest, callback: google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResultCallback): void;

Calls GetFlowValidationResult.

Parameters
Name Description
request IGetFlowValidationResultRequest

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

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

getFlowValidationResult(request)

public getFlowValidationResult(request: google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest): Promise<google.cloud.dialogflow.cx.v3.FlowValidationResult>;

Calls GetFlowValidationResult.

Parameter
Name Description
request IGetFlowValidationResultRequest

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

Promise

importFlow(request, callback)

public importFlow(request: google.cloud.dialogflow.cx.v3.IImportFlowRequest, callback: google.cloud.dialogflow.cx.v3.Flows.ImportFlowCallback): void;

Calls ImportFlow.

Parameters
Name Description
request IImportFlowRequest

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

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

importFlow(request)

public importFlow(request: google.cloud.dialogflow.cx.v3.IImportFlowRequest): Promise<google.longrunning.Operation>;

Calls ImportFlow.

Parameter
Name Description
request IImportFlowRequest

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

Promise

listFlows(request, callback)

public listFlows(request: google.cloud.dialogflow.cx.v3.IListFlowsRequest, callback: google.cloud.dialogflow.cx.v3.Flows.ListFlowsCallback): void;

Calls ListFlows.

Parameters
Name Description
request IListFlowsRequest

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

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

listFlows(request)

public listFlows(request: google.cloud.dialogflow.cx.v3.IListFlowsRequest): Promise<google.cloud.dialogflow.cx.v3.ListFlowsResponse>;

Calls ListFlows.

Parameter
Name Description
request IListFlowsRequest

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

Promise

trainFlow(request, callback)

public trainFlow(request: google.cloud.dialogflow.cx.v3.ITrainFlowRequest, callback: google.cloud.dialogflow.cx.v3.Flows.TrainFlowCallback): void;

Calls TrainFlow.

Parameters
Name Description
request google.cloud.dialogflow.cx.v3.ITrainFlowRequest

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

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

trainFlow(request)

public trainFlow(request: google.cloud.dialogflow.cx.v3.ITrainFlowRequest): Promise<google.longrunning.Operation>;

Calls TrainFlow.

Parameter
Name Description
request google.cloud.dialogflow.cx.v3.ITrainFlowRequest

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

Promise

updateFlow(request, callback)

public updateFlow(request: google.cloud.dialogflow.cx.v3.IUpdateFlowRequest, callback: google.cloud.dialogflow.cx.v3.Flows.UpdateFlowCallback): void;

Calls UpdateFlow.

Parameters
Name Description
request google.cloud.dialogflow.cx.v3.IUpdateFlowRequest

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

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

updateFlow(request)

public updateFlow(request: google.cloud.dialogflow.cx.v3.IUpdateFlowRequest): Promise<google.cloud.dialogflow.cx.v3.Flow>;

Calls UpdateFlow.

Parameter
Name Description
request google.cloud.dialogflow.cx.v3.IUpdateFlowRequest

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

Promise

validateFlow(request, callback)

public validateFlow(request: google.cloud.dialogflow.cx.v3.IValidateFlowRequest, callback: google.cloud.dialogflow.cx.v3.Flows.ValidateFlowCallback): void;

Calls ValidateFlow.

Parameters
Name Description
request google.cloud.dialogflow.cx.v3.IValidateFlowRequest

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

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

validateFlow(request)

public validateFlow(request: google.cloud.dialogflow.cx.v3.IValidateFlowRequest): Promise<google.cloud.dialogflow.cx.v3.FlowValidationResult>;

Calls ValidateFlow.

Parameter
Name Description
request google.cloud.dialogflow.cx.v3.IValidateFlowRequest

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

Promise