google::cloud::dialogflow_es::EnvironmentsClient Class Reference

Service for managing Environments. More...

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

Public Member Functions
	EnvironmentsClient (std::shared_ptr< EnvironmentsConnection > connection, Options opts={})
	~EnvironmentsClient ()
StreamRange< google::cloud::dialogflow::v2::Environment >	ListEnvironments (std::string const &parent, Options opts={})
	Returns the list of all non-default environments of the specified agent. More...
StreamRange< google::cloud::dialogflow::v2::Environment >	ListEnvironments (google::cloud::dialogflow::v2::ListEnvironmentsRequest request, Options opts={})
	Returns the list of all non-default environments of the specified agent. More...
StatusOr< google::cloud::dialogflow::v2::Environment >	GetEnvironment (google::cloud::dialogflow::v2::GetEnvironmentRequest const &request, Options opts={})
	Retrieves the specified agent environment. More...
StatusOr< google::cloud::dialogflow::v2::Environment >	CreateEnvironment (google::cloud::dialogflow::v2::CreateEnvironmentRequest const &request, Options opts={})
	Creates an agent environment. More...
StatusOr< google::cloud::dialogflow::v2::Environment >	UpdateEnvironment (google::cloud::dialogflow::v2::UpdateEnvironmentRequest const &request, Options opts={})
	Updates the specified agent environment. More...
Status	DeleteEnvironment (google::cloud::dialogflow::v2::DeleteEnvironmentRequest const &request, Options opts={})
	Deletes the specified agent environment. More...
StreamRange< google::cloud::dialogflow::v2::EnvironmentHistory::Entry >	GetEnvironmentHistory (google::cloud::dialogflow::v2::GetEnvironmentHistoryRequest request, Options opts={})
	Gets the history of 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_es::EnvironmentsClient::EnvironmentsClient ( std::shared_ptr< EnvironmentsConnection >  connection, Options  opts = {}  )

explicit

~EnvironmentsClient()

google::cloud::dialogflow_es::EnvironmentsClient::~EnvironmentsClient

(

)

EnvironmentsClient() [2/3]

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

default

EnvironmentsClient() [3/3]

google::cloud::dialogflow_es::EnvironmentsClient::EnvironmentsClient ( EnvironmentsClient &&  )

default

Member Function Documentation

CreateEnvironment()

StatusOr< google::cloud::dialogflow::v2::Environment > google::cloud::dialogflow_es::EnvironmentsClient::CreateEnvironment	(	google::cloud::dialogflow::v2::CreateEnvironmentRequest const &	request,
		Options	opts = {}
	)

Creates an agent environment.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.CreateEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Environment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteEnvironment()

Status google::cloud::dialogflow_es::EnvironmentsClient::DeleteEnvironment	(	google::cloud::dialogflow::v2::DeleteEnvironmentRequest const &	request,
		Options	opts = {}
	)

Deletes the specified agent environment.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.DeleteEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

GetEnvironment()

StatusOr< google::cloud::dialogflow::v2::Environment > google::cloud::dialogflow_es::EnvironmentsClient::GetEnvironment	(	google::cloud::dialogflow::v2::GetEnvironmentRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified agent environment.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.GetEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Environment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEnvironmentHistory()

StreamRange< google::cloud::dialogflow::v2::EnvironmentHistory::Entry > google::cloud::dialogflow_es::EnvironmentsClient::GetEnvironmentHistory	(	google::cloud::dialogflow::v2::GetEnvironmentHistoryRequest	request,
		Options	opts = {}
	)

Gets the history of the specified environment.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.GetEnvironmentHistoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.EnvironmentHistory.Entry, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEnvironments() [1/2]

StreamRange< google::cloud::dialogflow::v2::Environment > google::cloud::dialogflow_es::EnvironmentsClient::ListEnvironments	(	google::cloud::dialogflow::v2::ListEnvironmentsRequest	request,
		Options	opts = {}
	)

Returns the list of all non-default environments of the specified agent.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.ListEnvironmentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEnvironments() [2/2]

StreamRange< google::cloud::dialogflow::v2::Environment > google::cloud::dialogflow_es::EnvironmentsClient::ListEnvironments	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all non-default environments of the specified agent.

Parameters

parent	Required. The agent to list all environments from. Format: projects/<Project ID>/agent projects/<Project ID>/locations/<Location ID>/agent
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

operator=() [1/2]

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

default

operator=() [2/2]

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

default

UpdateEnvironment()

StatusOr< google::cloud::dialogflow::v2::Environment > google::cloud::dialogflow_es::EnvironmentsClient::UpdateEnvironment	(	google::cloud::dialogflow::v2::UpdateEnvironmentRequest const &	request,
		Options	opts = {}
	)

Updates the specified agent environment.

This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment continues serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.UpdateEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Environment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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