google::cloud::dialogflow_cx::DeploymentsClient Class Reference

Service for managing Deployments. More...

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

Public Member Functions
	DeploymentsClient (std::shared_ptr< DeploymentsConnection > connection, Options opts={})
	~DeploymentsClient ()
StreamRange< google::cloud::dialogflow::cx::v3::Deployment >	ListDeployments (std::string const &parent, Options opts={})
	Returns the list of all deployments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment]. More...
StreamRange< google::cloud::dialogflow::cx::v3::Deployment >	ListDeployments (google::cloud::dialogflow::cx::v3::ListDeploymentsRequest request, Options opts={})
	Returns the list of all deployments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment]. More...
StatusOr< google::cloud::dialogflow::cx::v3::Deployment >	GetDeployment (std::string const &name, Options opts={})
	Retrieves the specified Deployment. More...
StatusOr< google::cloud::dialogflow::cx::v3::Deployment >	GetDeployment (google::cloud::dialogflow::cx::v3::GetDeploymentRequest const &request, Options opts={})
	Retrieves the specified Deployment. More...
Copy and move support
	DeploymentsClient (DeploymentsClient const &)=default
DeploymentsClient &	operator= (DeploymentsClient const &)=default
	DeploymentsClient (DeploymentsClient &&)=default
DeploymentsClient &	operator= (DeploymentsClient &&)=default

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

Detailed Description

Service for managing Deployments.

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

DeploymentsClient() [1/3]

google::cloud::dialogflow_cx::DeploymentsClient::DeploymentsClient ( std::shared_ptr< DeploymentsConnection >  connection, Options  opts = {}  )

explicit

~DeploymentsClient()

google::cloud::dialogflow_cx::DeploymentsClient::~DeploymentsClient

(

)

DeploymentsClient() [2/3]

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

default

DeploymentsClient() [3/3]

google::cloud::dialogflow_cx::DeploymentsClient::DeploymentsClient ( DeploymentsClient &&  )

default

Member Function Documentation

GetDeployment() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Deployment > google::cloud::dialogflow_cx::DeploymentsClient::GetDeployment	(	google::cloud::dialogflow::cx::v3::GetDeploymentRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified Deployment.

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.cx.v3.GetDeploymentRequest. 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.cx.v3.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDeployment() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Deployment > google::cloud::dialogflow_cx::DeploymentsClient::GetDeployment	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified Deployment.

Parameters

name	Required. The name of the Deployment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/deployments/<Deployment ID>.
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.cx.v3.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDeployments() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::Deployment > google::cloud::dialogflow_cx::DeploymentsClient::ListDeployments	(	google::cloud::dialogflow::cx::v3::ListDeploymentsRequest	request,
		Options	opts = {}
	)

Returns the list of all deployments in the specified [Environment][google.cloud.dialogflow.cx.v3.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.cx.v3.ListDeploymentsRequest. 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.cx.v3.Deployment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDeployments() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::Deployment > google::cloud::dialogflow_cx::DeploymentsClient::ListDeployments	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all deployments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters

parent	Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments 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

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.cx.v3.Deployment, 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]

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

default

operator=() [2/2]

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

default

Friends And Related Function Documentation

operator!=

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

friend

operator==

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

friend