Service for managing Environments. More...

#include <google/cloud/dialogflow_cx/environments_client.h>

Public Member Functions
	EnvironmentsClient (std::shared_ptr< EnvironmentsConnection > connection, Options opts={})

	~EnvironmentsClient ()

StreamRange< google::cloud::dialogflow::cx::v3::Environment >	ListEnvironments (std::string const &parent, Options opts={})
	Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent]. More...

StreamRange< google::cloud::dialogflow::cx::v3::Environment >	ListEnvironments (google::cloud::dialogflow::cx::v3::ListEnvironmentsRequest request, Options opts={})
	Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent]. More...

StatusOr< google::cloud::dialogflow::cx::v3::Environment >	GetEnvironment (std::string const &name, Options opts={})
	Retrieves the specified Environment. More...

StatusOr< google::cloud::dialogflow::cx::v3::Environment >	GetEnvironment (google::cloud::dialogflow::cx::v3::GetEnvironmentRequest const &request, Options opts={})
	Retrieves the specified Environment. More...

future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > >	CreateEnvironment (std::string const &parent, google::cloud::dialogflow::cx::v3::Environment const &environment, Options opts={})
	Creates an Environment in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent]. More...

future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > >	CreateEnvironment (google::cloud::dialogflow::cx::v3::CreateEnvironmentRequest const &request, Options opts={})
	Creates an Environment in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent]. More...

future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > >	UpdateEnvironment (google::cloud::dialogflow::cx::v3::Environment const &environment, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified Environment. More...

future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > >	UpdateEnvironment (google::cloud::dialogflow::cx::v3::UpdateEnvironmentRequest const &request, Options opts={})
	Updates the specified Environment. More...

Status	DeleteEnvironment (std::string const &name, Options opts={})
	Deletes the specified Environment. More...

Status	DeleteEnvironment (google::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest const &request, Options opts={})
	Deletes the specified Environment. More...

StreamRange< google::cloud::dialogflow::cx::v3::Environment >	LookupEnvironmentHistory (std::string const &name, Options opts={})
	Looks up the history of the specified Environment. More...

StreamRange< google::cloud::dialogflow::cx::v3::Environment >	LookupEnvironmentHistory (google::cloud::dialogflow::cx::v3::LookupEnvironmentHistoryRequest request, Options opts={})
	Looks up the history of the specified Environment. More...

future< StatusOr< google::cloud::dialogflow::cx::v3::RunContinuousTestResponse > >	RunContinuousTest (google::cloud::dialogflow::cx::v3::RunContinuousTestRequest const &request, Options opts={})
	Kicks off a continuous test under the specified Environment. More...

StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult >	ListContinuousTestResults (std::string const &parent, Options opts={})
	Fetches a list of continuous test results for a given environment. More...

StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult >	ListContinuousTestResults (google::cloud::dialogflow::cx::v3::ListContinuousTestResultsRequest request, Options opts={})
	Fetches a list of continuous test results for a given environment. More...

future< StatusOr< google::cloud::dialogflow::cx::v3::DeployFlowResponse > >	DeployFlow (google::cloud::dialogflow::cx::v3::DeployFlowRequest const &request, Options opts={})
	Deploys a flow to the specified Environment. More...

Copy and move support
	EnvironmentsClient (EnvironmentsClient const &)=default

EnvironmentsClient &	operator= (EnvironmentsClient const &)=default

	EnvironmentsClient (EnvironmentsClient &&)=default

EnvironmentsClient &	operator= (EnvironmentsClient &&)=default

Friends
Equality
bool	operator== (EnvironmentsClient const &a, EnvironmentsClient const &b)

bool	operator!= (EnvironmentsClient const &a, EnvironmentsClient const &b)

Detailed Description

Service for managing Environments.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructor & Destructor Documentation

◆ EnvironmentsClient() [1/3]

google::cloud::dialogflow_cx::EnvironmentsClient::EnvironmentsClient	(	std::shared_ptr< EnvironmentsConnection >	connection,
		Options	opts = `{}`
	)

explicit

◆ ~EnvironmentsClient()

google::cloud::dialogflow_cx::EnvironmentsClient::~EnvironmentsClient ( )

◆ EnvironmentsClient() [2/3]

google::cloud::dialogflow_cx::EnvironmentsClient::EnvironmentsClient ( EnvironmentsClient const & )

default

◆ EnvironmentsClient() [3/3]

google::cloud::dialogflow_cx::EnvironmentsClient::EnvironmentsClient ( EnvironmentsClient && )

default

Member Function Documentation

◆ CreateEnvironment() [1/2]

future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > google::cloud::dialogflow_cx::EnvironmentsClient::CreateEnvironment	(	google::cloud::dialogflow::cx::v3::CreateEnvironmentRequest const &	request,
		Options	opts = `{}`
	)

Creates an Environment in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: Environment

Parameters

request	google::cloud::dialogflow::cx::v3::CreateEnvironmentRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

◆ CreateEnvironment() [2/2]

future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > google::cloud::dialogflow_cx::EnvironmentsClient::CreateEnvironment	(	std::string const &	parent,
		google::cloud::dialogflow::cx::v3::Environment const &	environment,
		Options	opts = `{}`
	)

Creates an Environment in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: Environment

Parameters

parent	Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an Environment for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
environment	Required. The environment to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

◆ DeleteEnvironment() [1/2]

Status google::cloud::dialogflow_cx::EnvironmentsClient::DeleteEnvironment	(	google::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest const &	request,
		Options	opts = `{}`
	)

Deletes the specified Environment.

Parameters

request	google::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

◆ DeleteEnvironment() [2/2]

Status google::cloud::dialogflow_cx::EnvironmentsClient::DeleteEnvironment	(	std::string const &	name,
		Options	opts = `{}`
	)

Deletes the specified Environment.

Parameters

name	Required. The name of the Environment to delete. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>`.
opts	Optional. Override the class-level options, such as retry and backoff policies.

◆ DeployFlow()

future< StatusOr< google::cloud::dialogflow::cx::v3::DeployFlowResponse > > google::cloud::dialogflow_cx::EnvironmentsClient::DeployFlow	(	google::cloud::dialogflow::cx::v3::DeployFlowRequest const &	request,
		Options	opts = `{}`
	)

Deploys a flow to the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: DeployFlowMetadata
response: DeployFlowResponse

Parameters

request	google::cloud::dialogflow::cx::v3::DeployFlowRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::DeployFlowResponse

◆ GetEnvironment() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::GetEnvironment	(	google::cloud::dialogflow::cx::v3::GetEnvironmentRequest const &	request,
		Options	opts = `{}`
	)

Retrieves the specified Environment.

Parameters

request	google::cloud::dialogflow::cx::v3::GetEnvironmentRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

◆ GetEnvironment() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::GetEnvironment	(	std::string const &	name,
		Options	opts = `{}`
	)

Retrieves the specified Environment.

Parameters

name	Required. The name of the Environment. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>`.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

◆ ListContinuousTestResults() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult > google::cloud::dialogflow_cx::EnvironmentsClient::ListContinuousTestResults	(	google::cloud::dialogflow::cx::v3::ListContinuousTestResultsRequest	request,
		Options	opts = `{}`
	)

Fetches a list of continuous test results for a given environment.

Parameters

request	google::cloud::dialogflow::cx::v3::ListContinuousTestResultsRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::ContinuousTestResult

◆ ListContinuousTestResults() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult > google::cloud::dialogflow_cx::EnvironmentsClient::ListContinuousTestResults	(	std::string const &	parent,
		Options	opts = `{}`
	)

Fetches a list of continuous test results for a given environment.

Parameters

parent	Required. The environment to list results for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>`.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::ContinuousTestResult

◆ ListEnvironments() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::ListEnvironments	(	google::cloud::dialogflow::cx::v3::ListEnvironmentsRequest	request,
		Options	opts = `{}`
	)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters

request	google::cloud::dialogflow::cx::v3::ListEnvironmentsRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

◆ ListEnvironments() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::ListEnvironments	(	std::string const &	parent,
		Options	opts = `{}`
	)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters

parent	Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

◆ LookupEnvironmentHistory() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::LookupEnvironmentHistory	(	google::cloud::dialogflow::cx::v3::LookupEnvironmentHistoryRequest	request,
		Options	opts = `{}`
	)

Looks up the history of the specified Environment.

Parameters

request	google::cloud::dialogflow::cx::v3::LookupEnvironmentHistoryRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

◆ LookupEnvironmentHistory() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::LookupEnvironmentHistory	(	std::string const &	name,
		Options	opts = `{}`
	)

Looks up the history of the specified Environment.

Parameters

name	Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID> google::cloud::Project
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

◆ operator=() [1/2]

EnvironmentsClient & google::cloud::dialogflow_cx::EnvironmentsClient::operator= ( EnvironmentsClient && )

default

◆ operator=() [2/2]

EnvironmentsClient & google::cloud::dialogflow_cx::EnvironmentsClient::operator= ( EnvironmentsClient const & )

default

◆ RunContinuousTest()

future< StatusOr< google::cloud::dialogflow::cx::v3::RunContinuousTestResponse > > google::cloud::dialogflow_cx::EnvironmentsClient::RunContinuousTest	(	google::cloud::dialogflow::cx::v3::RunContinuousTestRequest const &	request,
		Options	opts = `{}`
	)

Kicks off a continuous test under the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: RunContinuousTestMetadata
response: RunContinuousTestResponse

Parameters

request	google::cloud::dialogflow::cx::v3::RunContinuousTestRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::RunContinuousTestResponse

◆ UpdateEnvironment() [1/2]

future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > google::cloud::dialogflow_cx::EnvironmentsClient::UpdateEnvironment	(	google::cloud::dialogflow::cx::v3::Environment const &	environment,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = `{}`
	)

Updates the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: Environment

Parameters

environment	Required. The environment to update.
update_mask	Required. The mask to control which fields get updated.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

◆ UpdateEnvironment() [2/2]

future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > google::cloud::dialogflow_cx::EnvironmentsClient::UpdateEnvironment	(	google::cloud::dialogflow::cx::v3::UpdateEnvironmentRequest const &	request,
		Options	opts = `{}`
	)

Updates the specified Environment.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: Environment

Parameters

request	google::cloud::dialogflow::cx::v3::UpdateEnvironmentRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns: google::cloud::dialogflow::cx::v3::Environment

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	EnvironmentsClient const &	a,
		EnvironmentsClient const &	b
	)

friend

◆ operator==

bool operator==	(	EnvironmentsClient const &	a,
		EnvironmentsClient const &	b
	)

friend

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ EnvironmentsClient() [1/3]

◆ ~EnvironmentsClient()

◆ EnvironmentsClient() [2/3]

◆ EnvironmentsClient() [3/3]

Member Function Documentation

◆ CreateEnvironment() [1/2]

◆ CreateEnvironment() [2/2]

◆ DeleteEnvironment() [1/2]

◆ DeleteEnvironment() [2/2]

◆ DeployFlow()

◆ GetEnvironment() [1/2]

◆ GetEnvironment() [2/2]

◆ ListContinuousTestResults() [1/2]

◆ ListContinuousTestResults() [2/2]

◆ ListEnvironments() [1/2]

◆ ListEnvironments() [2/2]

◆ LookupEnvironmentHistory() [1/2]

◆ LookupEnvironmentHistory() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ RunContinuousTest()

◆ UpdateEnvironment() [1/2]

◆ UpdateEnvironment() [2/2]

Friends And Related Function Documentation

◆ operator!=

◆ operator==