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: |
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 |
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 |
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 |
GetVersion(std::string const &, Options)
Retrieves the specified Version.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Version. Format: |
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 |
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 |
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 |
CreateVersion(std::string const &, google::cloud::dialogflow::cx::v3::Version const &, Options)
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: CreateVersionOperationMetadataresponse
: Version
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The Flow to create an Version for. Format: |
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 |
CreateVersion(NoAwaitTag, std::string const &, google::cloud::dialogflow::cx::v3::Version const &, Options)
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
version |
google::cloud::dialogflow::cx::v3::Version const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateVersion(google::cloud::dialogflow::cx::v3::CreateVersionRequest const &, Options)
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: CreateVersionOperationMetadataresponse
: 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 |
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 |
CreateVersion(NoAwaitTag, google::cloud::dialogflow::cx::v3::CreateVersionRequest const &, Options)
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::cx::v3::CreateVersionRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateVersion(google::longrunning::Operation const &, Options)
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::cx::v3::Version > > |
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 |
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 |
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 |
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 |
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: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 messageresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The Version to be loaded to draft flow. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::protobuf::Struct > > |
A |
LoadVersion(NoAwaitTag, std::string const &, Options)
Loads resources in the specified version to the draft flow.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 messageresponse
: 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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::protobuf::Struct > > |
A |
LoadVersion(NoAwaitTag, google::cloud::dialogflow::cx::v3::LoadVersionRequest const &, Options)
Loads resources in the specified version to the draft flow.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::cx::v3::LoadVersionRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
LoadVersion(google::longrunning::Operation const &, Options)
Loads resources in the specified version to the draft flow.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::protobuf::Struct > > |
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 |
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 |
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 |
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 |