google::cloud::dialogflow_es::VersionsClient Class Reference

Service for managing Versions. More...

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

Public Member Functions
	VersionsClient (std::shared_ptr< VersionsConnection > connection, Options opts={})
	~VersionsClient ()
StreamRange< google::cloud::dialogflow::v2::Version >	ListVersions (std::string const &parent, Options opts={})
	Returns the list of all versions of the specified agent. More...
StreamRange< google::cloud::dialogflow::v2::Version >	ListVersions (google::cloud::dialogflow::v2::ListVersionsRequest request, Options opts={})
	Returns the list of all versions of the specified agent. More...
StatusOr< google::cloud::dialogflow::v2::Version >	GetVersion (std::string const &name, Options opts={})
	Retrieves the specified agent version. More...
StatusOr< google::cloud::dialogflow::v2::Version >	GetVersion (google::cloud::dialogflow::v2::GetVersionRequest const &request, Options opts={})
	Retrieves the specified agent version. More...
StatusOr< google::cloud::dialogflow::v2::Version >	CreateVersion (std::string const &parent, google::cloud::dialogflow::v2::Version const &version, Options opts={})
	Creates an agent version. More...
StatusOr< google::cloud::dialogflow::v2::Version >	CreateVersion (google::cloud::dialogflow::v2::CreateVersionRequest const &request, Options opts={})
	Creates an agent version. More...
StatusOr< google::cloud::dialogflow::v2::Version >	UpdateVersion (google::cloud::dialogflow::v2::Version const &version, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified agent version. More...
StatusOr< google::cloud::dialogflow::v2::Version >	UpdateVersion (google::cloud::dialogflow::v2::UpdateVersionRequest const &request, Options opts={})
	Updates the specified agent version. More...
Status	DeleteVersion (std::string const &name, Options opts={})
	Delete the specified agent version. More...
Status	DeleteVersion (google::cloud::dialogflow::v2::DeleteVersionRequest const &request, Options opts={})
	Delete the specified agent version. More...
Copy and move support
	VersionsClient (VersionsClient const &)=default
VersionsClient &	operator= (VersionsClient const &)=default
	VersionsClient (VersionsClient &&)=default
VersionsClient &	operator= (VersionsClient &&)=default

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

Detailed Description

Service for managing Versions.

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

VersionsClient() [1/3]

google::cloud::dialogflow_es::VersionsClient::VersionsClient ( std::shared_ptr< VersionsConnection >  connection, Options  opts = {}  )

explicit

~VersionsClient()

google::cloud::dialogflow_es::VersionsClient::~VersionsClient

(

)

VersionsClient() [2/3]

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

default

VersionsClient() [3/3]

google::cloud::dialogflow_es::VersionsClient::VersionsClient ( VersionsClient &&  )

default

Member Function Documentation

CreateVersion() [1/2]

StatusOr< google::cloud::dialogflow::v2::Version > google::cloud::dialogflow_es::VersionsClient::CreateVersion	(	google::cloud::dialogflow::v2::CreateVersionRequest const &	request,
		Options	opts = {}
	)

Creates an agent version.

The new version points to the agent instance in the "default" 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.CreateVersionRequest. 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.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateVersion() [2/2]

StatusOr< google::cloud::dialogflow::v2::Version > google::cloud::dialogflow_es::VersionsClient::CreateVersion	(	std::string const &	parent,
		google::cloud::dialogflow::v2::Version const &	version,
		Options	opts = {}
	)

Creates an agent version.

The new version points to the agent instance in the "default" environment.

Parameters

parent	Required. The agent to create a version for. Supported formats: projects/<Project ID>/agent projects/<Project ID>/locations/<Location ID>/agent
version	Required. The version to create.
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.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteVersion() [1/2]

Status google::cloud::dialogflow_es::VersionsClient::DeleteVersion	(	google::cloud::dialogflow::v2::DeleteVersionRequest const &	request,
		Options	opts = {}
	)

Delete the specified agent version.

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.DeleteVersionRequest. 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.

DeleteVersion() [2/2]

Status google::cloud::dialogflow_es::VersionsClient::DeleteVersion	(	std::string const &	name,
		Options	opts = {}
	)

Delete the specified agent version.

Parameters

name	Required. The name of the version to delete. Supported formats: projects/<Project ID>/agent/versions/<Version ID> projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>
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.

GetVersion() [1/2]

StatusOr< google::cloud::dialogflow::v2::Version > google::cloud::dialogflow_es::VersionsClient::GetVersion	(	google::cloud::dialogflow::v2::GetVersionRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified agent version.

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

GetVersion() [2/2]

StatusOr< google::cloud::dialogflow::v2::Version > google::cloud::dialogflow_es::VersionsClient::GetVersion	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified agent version.

Parameters

name	Required. The name of the version. Supported formats: projects/<Project ID>/agent/versions/<Version ID> projects/<Project ID>/locations/<Location ID>/agent/versions/<Version 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.v2.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListVersions() [1/2]

StreamRange< google::cloud::dialogflow::v2::Version > google::cloud::dialogflow_es::VersionsClient::ListVersions	(	google::cloud::dialogflow::v2::ListVersionsRequest	request,
		Options	opts = {}
	)

Returns the list of all versions 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.ListVersionsRequest. 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.Version, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListVersions() [2/2]

StreamRange< google::cloud::dialogflow::v2::Version > google::cloud::dialogflow_es::VersionsClient::ListVersions	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all versions of the specified agent.

Parameters

parent	Required. The agent to list all versions from. Supported formats: 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.Version, 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]

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

default

operator=() [2/2]

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

default

UpdateVersion() [1/2]

StatusOr< google::cloud::dialogflow::v2::Version > google::cloud::dialogflow_es::VersionsClient::UpdateVersion	(	google::cloud::dialogflow::v2::UpdateVersionRequest const &	request,
		Options	opts = {}
	)

Updates the specified agent version.

Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

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

UpdateVersion() [2/2]

StatusOr< google::cloud::dialogflow::v2::Version > google::cloud::dialogflow_es::VersionsClient::UpdateVersion	(	google::cloud::dialogflow::v2::Version const &	version,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates the specified agent version.

Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

Parameters

version	Required. The version to update. Supported formats: projects/<Project ID>/agent/versions/<Version ID> projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>
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

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Version) 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!= ( VersionsClient const &  a, VersionsClient const &  b  )

friend

operator==

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

friend