Dialogflow API C++ Client  2.2.1
A C++ Client Library for the Dialogflow API
Public Member Functions | Friends | List of all members
google::cloud::dialogflow_cx::VersionsClient Class Reference

Service for managing [Versions][google.cloud.dialogflow.cx.v3.Version]. More...

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

Public Member Functions

 VersionsClient (std::shared_ptr< VersionsConnection > connection, Options opts={})
 
 ~VersionsClient ()
 
 VersionsClient (VersionsClient const &)=default
 
VersionsClientoperator= (VersionsClient const &)=default
 
 VersionsClient (VersionsClient &&)=default
 
VersionsClientoperator= (VersionsClient &&)=default
 
StreamRange< google::cloud::dialogflow::cx::v3::Version > ListVersions (std::string const &parent, Options opts={})
 Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.Version]. More...
 
Status DeleteVersion (google::cloud::dialogflow::cx::v3::DeleteVersionRequest const &request, Options opts={})
 Deletes the specified [Version][google.cloud.dialogflow.cx.v3.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...
 

Friends

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

Detailed Description

Service for managing [Versions][google.cloud.dialogflow.cx.v3.Version].

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.

Definition at line 62 of file versions_client.h.

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
requestgoogle::cloud::dialogflow::cx::v3::CompareVersionsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::CompareVersionsResponse

◆ 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_versionRequired. 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>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::CompareVersionsResponse

◆ 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][google.cloud.dialogflow.cx.v3.Flow].

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

  • metadata: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
  • response: Version
Parameters
requestgoogle::cloud::dialogflow::cx::v3::CreateVersionRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Version

◆ 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][google.cloud.dialogflow.cx.v3.Flow].

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

  • metadata: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
  • response: Version
Parameters
parentRequired. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an Version for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
versionRequired. The version to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Version

◆ DeleteVersion() [1/2]

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

Deletes the specified [Version][google.cloud.dialogflow.cx.v3.Version].

Parameters
requestgoogle::cloud::dialogflow::cx::v3::DeleteVersionRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteVersion() [2/2]

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

Deletes the specified [Version][google.cloud.dialogflow.cx.v3.Version].

Parameters
nameRequired. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ 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
requestgoogle::cloud::dialogflow::cx::v3::GetVersionRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Version

◆ 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
nameRequired. The name of the Version. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Version

◆ 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][google.cloud.dialogflow.cx.v3.Flow].

Parameters
requestgoogle::cloud::dialogflow::cx::v3::ListVersionsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Version

◆ 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][google.cloud.dialogflow.cx.v3.Flow].

Parameters
parentRequired. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Version

◆ 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:

Parameters
requestgoogle::cloud::dialogflow::cx::v3::LoadVersionRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::protobuf::Struct

◆ 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:

Parameters
nameRequired. 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>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::protobuf::Struct

◆ 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
requestgoogle::cloud::dialogflow::cx::v3::UpdateVersionRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Version

◆ 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
versionRequired. The version to update.
update_maskRequired. The mask to control which fields get updated. Currently only description and display_name can be updated.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Version

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 81 of file versions_client.h.

◆ operator==

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

Definition at line 78 of file versions_client.h.