google::cloud::dialogflow_cx::VersionsClient Class Reference

Service for managing Versions. More...

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

Public Member Functions
	VersionsClient (std::shared_ptr< VersionsConnection > connection, Options opts={})
	~VersionsClient ()
StreamRange< google::cloud::dialogflow::cx::v3::Version >	ListVersions (std::string const &parent, Options opts={})
	Returns the list of all versions in the specified Flow. More...
StreamRange< google::cloud::dialogflow::cx::v3::Version >	ListVersions (google::cloud::dialogflow::cx::v3::ListVersionsRequest request, Options opts={})
	Returns the list of all versions in the specified Flow. More...
StatusOr< google::cloud::dialogflow::cx::v3::Version >	GetVersion (std::string const &name, Options opts={})
	Retrieves the specified Version. More...
StatusOr< google::cloud::dialogflow::cx::v3::Version >	GetVersion (google::cloud::dialogflow::cx::v3::GetVersionRequest const &request, Options opts={})
	Retrieves the specified Version. More...
future< StatusOr< google::cloud::dialogflow::cx::v3::Version > >	CreateVersion (std::string const &parent, google::cloud::dialogflow::cx::v3::Version const &version, Options opts={})
	Creates a Version in the specified Flow. More...
future< StatusOr< google::cloud::dialogflow::cx::v3::Version > >	CreateVersion (google::cloud::dialogflow::cx::v3::CreateVersionRequest const &request, Options opts={})
	Creates a Version in the specified Flow. More...
StatusOr< google::cloud::dialogflow::cx::v3::Version >	UpdateVersion (google::cloud::dialogflow::cx::v3::Version const &version, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified Version. More...
StatusOr< google::cloud::dialogflow::cx::v3::Version >	UpdateVersion (google::cloud::dialogflow::cx::v3::UpdateVersionRequest const &request, Options opts={})
	Updates the specified Version. More...
Status	DeleteVersion (std::string const &name, Options opts={})
	Deletes the specified Version. More...
Status	DeleteVersion (google::cloud::dialogflow::cx::v3::DeleteVersionRequest const &request, Options opts={})
	Deletes the specified Version. More...
future< StatusOr< google::protobuf::Struct > >	LoadVersion (std::string const &name, Options opts={})
	Loads resources in the specified version to the draft flow. More...
future< StatusOr< google::protobuf::Struct > >	LoadVersion (google::cloud::dialogflow::cx::v3::LoadVersionRequest const &request, Options opts={})
	Loads resources in the specified version to the draft flow. More...
StatusOr< google::cloud::dialogflow::cx::v3::CompareVersionsResponse >	CompareVersions (std::string const &base_version, Options opts={})
	Compares the specified base version with target version. More...
StatusOr< google::cloud::dialogflow::cx::v3::CompareVersionsResponse >	CompareVersions (google::cloud::dialogflow::cx::v3::CompareVersionsRequest const &request, Options opts={})
	Compares the specified base version with target 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_cx::VersionsClient::VersionsClient ( std::shared_ptr< VersionsConnection >  connection, Options  opts = {}  )

explicit

~VersionsClient()

google::cloud::dialogflow_cx::VersionsClient::~VersionsClient

(

)

VersionsClient() [2/3]

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

default

VersionsClient() [3/3]

google::cloud::dialogflow_cx::VersionsClient::VersionsClient ( VersionsClient &&  )

default

Member Function Documentation

CompareVersions() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::CompareVersionsResponse > google::cloud::dialogflow_cx::VersionsClient::CompareVersions	(	google::cloud::dialogflow::cx::v3::CompareVersionsRequest const &	request,
		Options	opts = {}
	)

Compares the specified base version with target 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.cx.v3.CompareVersionsRequest. 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.CompareVersionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CompareVersions() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::CompareVersionsResponse > google::cloud::dialogflow_cx::VersionsClient::CompareVersions	(	std::string const &	base_version,
		Options	opts = {}
	)

Compares the specified base version with target version.

Parameters

base_version	Required. Name of the base flow version to compare with the target version. Use version ID 0 to indicate the draft version of the specified flow. Format: projects/<Project ID>/locations/<Location ID>/agents/ <Agent ID>/flows/<Flow ID>/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.cx.v3.CompareVersionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateVersion() [1/2]

future< StatusOr< google::cloud::dialogflow::cx::v3::Version > > google::cloud::dialogflow_cx::VersionsClient::CreateVersion	(	google::cloud::dialogflow::cx::v3::CreateVersionRequest const &	request,
		Options	opts = {}
	)

Creates a Version in the specified Flow.

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

• metadata: CreateVersionOperationMetadata
• response: 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.cx.v3.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

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.Version proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateVersion() [2/2]

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

Creates a Version in the specified Flow.

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

• metadata: CreateVersionOperationMetadata
• response: Version

Parameters

parent	Required. The Flow to create an Version for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
version	Required. The version to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.Version proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteVersion() [1/2]

Status google::cloud::dialogflow_cx::VersionsClient::DeleteVersion	(	google::cloud::dialogflow::cx::v3::DeleteVersionRequest const &	request,
		Options	opts = {}
	)

Deletes the specified 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.cx.v3.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_cx::VersionsClient::DeleteVersion	(	std::string const &	name,
		Options	opts = {}
	)

Deletes the specified Version.

Parameters

name	Required. The name of the Version to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/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::cx::v3::Version > google::cloud::dialogflow_cx::VersionsClient::GetVersion	(	google::cloud::dialogflow::cx::v3::GetVersionRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified 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.cx.v3.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.cx.v3.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::cx::v3::Version > google::cloud::dialogflow_cx::VersionsClient::GetVersion	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified Version.

Parameters

name	Required. The name of the Version. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/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.cx.v3.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::cx::v3::Version > google::cloud::dialogflow_cx::VersionsClient::ListVersions	(	google::cloud::dialogflow::cx::v3::ListVersionsRequest	request,
		Options	opts = {}
	)

Returns the list of all versions in the specified Flow.

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.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.cx.v3.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::cx::v3::Version > google::cloud::dialogflow_cx::VersionsClient::ListVersions	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all versions in the specified Flow.

Parameters

parent	Required. The Flow to list all versions for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow 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.Version, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

LoadVersion() [1/2]

future< StatusOr< google::protobuf::Struct > > google::cloud::dialogflow_cx::VersionsClient::LoadVersion	(	google::cloud::dialogflow::cx::v3::LoadVersionRequest const &	request,
		Options	opts = {}
	)

Loads resources in the specified version to the draft flow.

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

• metadata: An empty Struct message
• response: An Empty message

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.LoadVersionRequest. 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 `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

LoadVersion() [2/2]

future< StatusOr< google::protobuf::Struct > > google::cloud::dialogflow_cx::VersionsClient::LoadVersion	(	std::string const &	name,
		Options	opts = {}
	)

Loads resources in the specified version to the draft flow.

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

• metadata: An empty Struct message
• response: An Empty message

Parameters

name	Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

operator=() [1/2]

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

default

operator=() [2/2]

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

default

UpdateVersion() [1/2]

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

Updates the specified 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.cx.v3.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.cx.v3.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::cx::v3::Version > google::cloud::dialogflow_cx::VersionsClient::UpdateVersion	(	google::cloud::dialogflow::cx::v3::Version const &	version,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates the specified Version.

Parameters

version	Required. The version to update.
update_mask	Required. The mask to control which fields get updated. Currently only description and display_name can be 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.cx.v3.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