Class VersionsClient (2.22.0)

Version 2.22.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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.

Constructors

VersionsClient(VersionsClient const &)

Copy and move support

Parameter
Name	Description
	VersionsClient const &

VersionsClient(VersionsClient &&)

Copy and move support

Parameter
Name	Description
	VersionsClient &&

VersionsClient(std::shared_ptr< VersionsConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< VersionsConnection >
opts	Options

Operators

operator=(VersionsClient const &)

Copy and move support

Parameter
Name	Description
	VersionsClient const &

Returns
Type	Description
VersionsClient &

operator=(VersionsClient &&)

Copy and move support

Parameter
Name	Description
	VersionsClient &&

Returns
Type	Description
VersionsClient &

Functions

ListVersions(std::string const &, Options)

Returns the list of all versions in the specified Flow.

Parameters
Name	Description
parent	std::string const & Required. The Flow to list all versions for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/flows/<Flow ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::Version >	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(google::cloud::dialogflow::cx::v3::ListVersionsRequest, Options)

Returns the list of all versions in the specified Flow.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ListVersionsRequest 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::Version >	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.

GetVersion(std::string const &, Options)

Retrieves the specified Version.

Parameters
Name	Description
name	std::string const & Required. The name of the Version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Version >	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(google::cloud::dialogflow::cx::v3::GetVersionRequest const &, Options)

Retrieves the specified Version.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetVersionRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Version >	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.

CreateVersion(std::string const &, google::cloud::dialogflow::cx::v3::Version const &, Options)

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
Name	Description
parent	std::string const & Required. The Flow to create an Version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/flows/<Flow ID>.
version	google::cloud::dialogflow::cx::v3::Version const & Required. The version to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::Version > >	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(google::cloud::dialogflow::cx::v3::CreateVersionRequest const &, Options)

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
Name	Description
request	google::cloud::dialogflow::cx::v3::CreateVersionRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::Version > >	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.

UpdateVersion(google::cloud::dialogflow::cx::v3::Version const &, google::protobuf::FieldMask const &, Options)

Updates the specified Version.

Parameters
Name	Description
version	google::cloud::dialogflow::cx::v3::Version const & Required. The version to update.
update_mask	google::protobuf::FieldMask const & Required. The mask to control which fields get updated. Currently only description and display_name can be updated.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Version >	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(google::cloud::dialogflow::cx::v3::UpdateVersionRequest const &, Options)

Updates the specified Version.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::UpdateVersionRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Version >	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.

DeleteVersion(std::string const &, Options)

Deletes the specified Version.

Parameters
Name	Description
name	std::string const & Required. The name of the Version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteVersion(google::cloud::dialogflow::cx::v3::DeleteVersionRequest const &, Options)

Deletes the specified Version.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::DeleteVersionRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

LoadVersion(std::string const &, Options)

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	Description
name	std::string const & Required. The Version to be loaded to draft flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::protobuf::Struct > >	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(google::cloud::dialogflow::cx::v3::LoadVersionRequest const &, Options)

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	Description
request	google::cloud::dialogflow::cx::v3::LoadVersionRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::protobuf::Struct > >	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.

CompareVersions(std::string const &, Options)

Compares the specified base version with target version.

Parameters
Name	Description
base_version	std::string const & 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/<ProjectID>/locations/<LocationID>/agents/ <Agent ID>/flows/<Flow ID>/versions/<Version ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::CompareVersionsResponse >	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(google::cloud::dialogflow::cx::v3::CompareVersionsRequest const &, Options)

Compares the specified base version with target version.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::CompareVersionsRequest const & 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	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::CompareVersionsResponse >	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.