Environments

google .cloud .dialogflow .cx .v3. Environments

Represents an Environments

Constructor

new Environments(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

createEnvironment(request, callback) → {undefined}

Calls CreateEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.ICreateEnvironmentRequest	CreateEnvironmentRequest message or plain object
`callback`	google.cloud.dialogflow.cx.v3.Environments.CreateEnvironmentCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls CreateEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.ICreateEnvironmentRequest	CreateEnvironmentRequest message or plain object

Returns:

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

deleteEnvironment(request, callback) → {undefined}

Calls DeleteEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IDeleteEnvironmentRequest	DeleteEnvironmentRequest message or plain object
`callback`	google.cloud.dialogflow.cx.v3.Environments.DeleteEnvironmentCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

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

Calls DeleteEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IDeleteEnvironmentRequest	DeleteEnvironmentRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

deployFlow(request, callback) → {undefined}

Calls DeployFlow.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IDeployFlowRequest	DeployFlowRequest message or plain object
`callback`	google.cloud.dialogflow.cx.v3.Environments.DeployFlowCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls DeployFlow.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IDeployFlowRequest	DeployFlowRequest message or plain object

Returns:

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

getEnvironment(request, callback) → {undefined}

Calls GetEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IGetEnvironmentRequest	GetEnvironmentRequest message or plain object
`callback`	google.cloud.dialogflow.cx.v3.Environments.GetEnvironmentCallback	Node-style callback called with the error, if any, and Environment

Returns:

Type	Description
undefined

getEnvironment(request) → {Promise.<google.cloud.dialogflow.cx.v3.Environment>}

Calls GetEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IGetEnvironmentRequest	GetEnvironmentRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.cx.v3.Environment>	Promise

listContinuousTestResults(request, callback) → {undefined}

Calls ListContinuousTestResults.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest	ListContinuousTestResultsRequest message or plain object
`callback`	google.cloud.dialogflow.cx.v3.Environments.ListContinuousTestResultsCallback	Node-style callback called with the error, if any, and ListContinuousTestResultsResponse

Returns:

Type	Description
undefined

listContinuousTestResults(request) → {Promise.<google.cloud.dialogflow.cx.v3.ListContinuousTestResultsResponse>}

Calls ListContinuousTestResults.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest	ListContinuousTestResultsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.cx.v3.ListContinuousTestResultsResponse>	Promise

listEnvironments(request, callback) → {undefined}

Calls ListEnvironments.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest	ListEnvironmentsRequest message or plain object
`callback`	google.cloud.dialogflow.cx.v3.Environments.ListEnvironmentsCallback	Node-style callback called with the error, if any, and ListEnvironmentsResponse

Returns:

Type	Description
undefined

listEnvironments(request) → {Promise.<google.cloud.dialogflow.cx.v3.ListEnvironmentsResponse>}

Calls ListEnvironments.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest	ListEnvironmentsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.cx.v3.ListEnvironmentsResponse>	Promise

lookupEnvironmentHistory(request, callback) → {undefined}

Calls LookupEnvironmentHistory.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest	LookupEnvironmentHistoryRequest message or plain object
`callback`	google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistoryCallback	Node-style callback called with the error, if any, and LookupEnvironmentHistoryResponse

Returns:

Type	Description
undefined

lookupEnvironmentHistory(request) → {Promise.<google.cloud.dialogflow.cx.v3.LookupEnvironmentHistoryResponse>}

Calls LookupEnvironmentHistory.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest	LookupEnvironmentHistoryRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.dialogflow.cx.v3.LookupEnvironmentHistoryResponse>	Promise

runContinuousTest(request, callback) → {undefined}

Calls RunContinuousTest.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IRunContinuousTestRequest	RunContinuousTestRequest message or plain object
`callback`	google.cloud.dialogflow.cx.v3.Environments.RunContinuousTestCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls RunContinuousTest.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IRunContinuousTestRequest	RunContinuousTestRequest message or plain object

Returns:

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

updateEnvironment(request, callback) → {undefined}

Calls UpdateEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IUpdateEnvironmentRequest	UpdateEnvironmentRequest message or plain object
`callback`	google.cloud.dialogflow.cx.v3.Environments.UpdateEnvironmentCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls UpdateEnvironment.

Parameters:

Name	Type	Description
`request`	google.cloud.dialogflow.cx.v3.IUpdateEnvironmentRequest	UpdateEnvironmentRequest message or plain object

Returns:

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

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

Creates new Environments 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
Environments	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateEnvironmentCallback(error, responseopt)

Callback as used by createEnvironment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteEnvironmentCallback(error, responseopt)

Callback as used by deleteEnvironment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

DeployFlowCallback(error, responseopt)

Callback as used by deployFlow.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

GetEnvironmentCallback(error, responseopt)

Callback as used by getEnvironment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.cx.v3.Environment	<optional>	Environment

ListContinuousTestResultsCallback(error, responseopt)

Callback as used by listContinuousTestResults.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.cx.v3.ListContinuousTestResultsResponse	<optional>	ListContinuousTestResultsResponse

ListEnvironmentsCallback(error, responseopt)

Callback as used by listEnvironments.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.cx.v3.ListEnvironmentsResponse	<optional>	ListEnvironmentsResponse

LookupEnvironmentHistoryCallback(error, responseopt)

Callback as used by lookupEnvironmentHistory.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.dialogflow.cx.v3.LookupEnvironmentHistoryResponse	<optional>	LookupEnvironmentHistoryResponse

RunContinuousTestCallback(error, responseopt)

Callback as used by runContinuousTest.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateEnvironmentCallback(error, responseopt)

Callback as used by updateEnvironment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation