google::cloud::dialogflow_cx::ChangelogsClient Class Reference

Service for managing Changelogs. More...

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

Public Member Functions
	ChangelogsClient (std::shared_ptr< ChangelogsConnection > connection, Options opts={})
	~ChangelogsClient ()
StreamRange< google::cloud::dialogflow::cx::v3::Changelog >	ListChangelogs (std::string const &parent, Options opts={})
	Returns the list of Changelogs. More...
StreamRange< google::cloud::dialogflow::cx::v3::Changelog >	ListChangelogs (google::cloud::dialogflow::cx::v3::ListChangelogsRequest request, Options opts={})
	Returns the list of Changelogs. More...
StatusOr< google::cloud::dialogflow::cx::v3::Changelog >	GetChangelog (std::string const &name, Options opts={})
	Retrieves the specified Changelog. More...
StatusOr< google::cloud::dialogflow::cx::v3::Changelog >	GetChangelog (google::cloud::dialogflow::cx::v3::GetChangelogRequest const &request, Options opts={})
	Retrieves the specified Changelog. More...
Copy and move support
	ChangelogsClient (ChangelogsClient const &)=default
ChangelogsClient &	operator= (ChangelogsClient const &)=default
	ChangelogsClient (ChangelogsClient &&)=default
ChangelogsClient &	operator= (ChangelogsClient &&)=default

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

Detailed Description

Service for managing Changelogs.

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

ChangelogsClient() [1/3]

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

explicit

~ChangelogsClient()

google::cloud::dialogflow_cx::ChangelogsClient::~ChangelogsClient

(

)

ChangelogsClient() [2/3]

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

default

ChangelogsClient() [3/3]

google::cloud::dialogflow_cx::ChangelogsClient::ChangelogsClient ( ChangelogsClient &&  )

default

Member Function Documentation

GetChangelog() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Changelog > google::cloud::dialogflow_cx::ChangelogsClient::GetChangelog	(	google::cloud::dialogflow::cx::v3::GetChangelogRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified Changelog.

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

GetChangelog() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Changelog > google::cloud::dialogflow_cx::ChangelogsClient::GetChangelog	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified Changelog.

Parameters

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

ListChangelogs() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::Changelog > google::cloud::dialogflow_cx::ChangelogsClient::ListChangelogs	(	google::cloud::dialogflow::cx::v3::ListChangelogsRequest	request,
		Options	opts = {}
	)

Returns the list of Changelogs.

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.ListChangelogsRequest. 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.Changelog, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListChangelogs() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::Changelog > google::cloud::dialogflow_cx::ChangelogsClient::ListChangelogs	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of Changelogs.

Parameters

parent	Required. The agent containing the changelogs. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent 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.Changelog, 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]

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

default

operator=() [2/2]

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

default

Friends And Related Function Documentation

operator!=

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

friend

operator==

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

friend