Examples

google.cloud.dialogflow.cx.v3beta1. Examples

Represents an Examples

Constructor

new Examples(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

createExample(request, callback) → {undefined}

Calls CreateExample.

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

CreateExampleRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Examples.CreateExampleCallback

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

createExample(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Example>}

Calls CreateExample.

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

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

Promise

deleteExample(request, callback) → {undefined}

Calls DeleteExample.

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

DeleteExampleRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Examples.DeleteExampleCallback

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

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

Calls DeleteExample.

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

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

Promise

getExample(request, callback) → {undefined}

Calls GetExample.

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

GetExampleRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Examples.GetExampleCallback

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

getExample(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Example>}

Calls GetExample.

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

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

Promise

listExamples(request, callback) → {undefined}

Calls ListExamples.

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

ListExamplesRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Examples.ListExamplesCallback

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

listExamples(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.ListExamplesResponse>}

Calls ListExamples.

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

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

Promise

updateExample(request, callback) → {undefined}

Calls UpdateExample.

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

UpdateExampleRequest message or plain object
callback google.cloud.dialogflow.cx.v3beta1.Examples.UpdateExampleCallback

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

updateExample(request) → {Promise.<google.cloud.dialogflow.cx.v3beta1.Example>}

Calls UpdateExample.

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

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

Promise

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

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

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

Type Definitions

CreateExampleCallback(error, responseopt)

Callback as used by createExample.

Parameters:
Name Type Attributes Description
error Error | null

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

Example

DeleteExampleCallback(error, responseopt)

Callback as used by deleteExample.

Parameters:
Name Type Attributes Description
error Error | null

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

Empty

GetExampleCallback(error, responseopt)

Callback as used by getExample.

Parameters:
Name Type Attributes Description
error Error | null

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

Example

ListExamplesCallback(error, responseopt)

Callback as used by listExamples.

Parameters:
Name Type Attributes Description
error Error | null

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

ListExamplesResponse

UpdateExampleCallback(error, responseopt)

Callback as used by updateExample.

Parameters:
Name Type Attributes Description
error Error | null

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

Example