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

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

#include <google/cloud/dialogflow_es/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::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...
 

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.v2.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 61 of file versions_client.h.

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

◆ 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
parentRequired. The agent to create a version for. Supported formats:
  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
versionRequired. The version to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Version

◆ 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
requestgoogle::cloud::dialogflow::v2::DeleteVersionRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteVersion() [2/2]

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

Delete the specified agent version.

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

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

◆ 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
nameRequired. The name of the version. Supported formats:
  • projects/<Project ID>/agent/versions/<Version ID>
  • projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Version

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

◆ 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
parentRequired. The agent to list all versions from. Supported formats:
  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Version

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

◆ 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
versionRequired. The version to update. Supported formats:
  • projects/<Project ID>/agent/versions/<Version ID>
  • projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>
update_maskRequired. The mask to control which fields get updated.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Version

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 80 of file versions_client.h.

◆ operator==

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

Definition at line 77 of file versions_client.h.