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::ContextsClient Class Reference

Service for managing [Contexts][google.cloud.dialogflow.v2.Context]. More...

#include <google/cloud/dialogflow_es/contexts_client.h>

Public Member Functions

 ContextsClient (std::shared_ptr< ContextsConnection > connection, Options opts={})
 
 ~ContextsClient ()
 
 ContextsClient (ContextsClient const &)=default
 
ContextsClientoperator= (ContextsClient const &)=default
 
 ContextsClient (ContextsClient &&)=default
 
ContextsClientoperator= (ContextsClient &&)=default
 
StreamRange< google::cloud::dialogflow::v2::Context > ListContexts (std::string const &parent, Options opts={})
 Returns the list of all contexts in the specified session. More...
 
StreamRange< google::cloud::dialogflow::v2::Context > ListContexts (google::cloud::dialogflow::v2::ListContextsRequest request, Options opts={})
 Returns the list of all contexts in the specified session. More...
 
StatusOr< google::cloud::dialogflow::v2::Context > GetContext (std::string const &name, Options opts={})
 Retrieves the specified context. More...
 
StatusOr< google::cloud::dialogflow::v2::Context > GetContext (google::cloud::dialogflow::v2::GetContextRequest const &request, Options opts={})
 Retrieves the specified context. More...
 
StatusOr< google::cloud::dialogflow::v2::Context > CreateContext (std::string const &parent, google::cloud::dialogflow::v2::Context const &context, Options opts={})
 Creates a context. More...
 
StatusOr< google::cloud::dialogflow::v2::Context > CreateContext (google::cloud::dialogflow::v2::CreateContextRequest const &request, Options opts={})
 Creates a context. More...
 
StatusOr< google::cloud::dialogflow::v2::Context > UpdateContext (google::cloud::dialogflow::v2::Context const &context, google::protobuf::FieldMask const &update_mask, Options opts={})
 Updates the specified context. More...
 
StatusOr< google::cloud::dialogflow::v2::Context > UpdateContext (google::cloud::dialogflow::v2::UpdateContextRequest const &request, Options opts={})
 Updates the specified context. More...
 
Status DeleteContext (std::string const &name, Options opts={})
 Deletes the specified context. More...
 
Status DeleteContext (google::cloud::dialogflow::v2::DeleteContextRequest const &request, Options opts={})
 Deletes the specified context. More...
 
Status DeleteAllContexts (std::string const &parent, Options opts={})
 Deletes all active contexts in the specified session. More...
 
Status DeleteAllContexts (google::cloud::dialogflow::v2::DeleteAllContextsRequest const &request, Options opts={})
 Deletes all active contexts in the specified session. More...
 

Friends

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

Detailed Description

Service for managing [Contexts][google.cloud.dialogflow.v2.Context].

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 contexts_client.h.

Constructor & Destructor Documentation

◆ ContextsClient() [1/3]

google::cloud::dialogflow_es::ContextsClient::ContextsClient ( std::shared_ptr< ContextsConnection connection,
Options  opts = {} 
)
explicit

◆ ~ContextsClient()

google::cloud::dialogflow_es::ContextsClient::~ContextsClient ( )

◆ ContextsClient() [2/3]

google::cloud::dialogflow_es::ContextsClient::ContextsClient ( ContextsClient const &  )
default

◆ ContextsClient() [3/3]

google::cloud::dialogflow_es::ContextsClient::ContextsClient ( ContextsClient &&  )
default

Member Function Documentation

◆ CreateContext() [1/2]

StatusOr<google::cloud::dialogflow::v2::Context> google::cloud::dialogflow_es::ContextsClient::CreateContext ( google::cloud::dialogflow::v2::CreateContextRequest const &  request,
Options  opts = {} 
)

Creates a context.

If the specified context already exists, overrides the context.

Parameters
requestgoogle::cloud::dialogflow::v2::CreateContextRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Context

◆ CreateContext() [2/2]

StatusOr<google::cloud::dialogflow::v2::Context> google::cloud::dialogflow_es::ContextsClient::CreateContext ( std::string const &  parent,
google::cloud::dialogflow::v2::Context const &  context,
Options  opts = {} 
)

Creates a context.

If the specified context already exists, overrides the context.

Parameters
parentRequired. The session to create a context for. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
contextRequired. The context to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Context

◆ DeleteAllContexts() [1/2]

Status google::cloud::dialogflow_es::ContextsClient::DeleteAllContexts ( google::cloud::dialogflow::v2::DeleteAllContextsRequest const &  request,
Options  opts = {} 
)

Deletes all active contexts in the specified session.

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

◆ DeleteAllContexts() [2/2]

Status google::cloud::dialogflow_es::ContextsClient::DeleteAllContexts ( std::string const &  parent,
Options  opts = {} 
)

Deletes all active contexts in the specified session.

Parameters
parentRequired. The name of the session to delete all contexts from. Format:
projects/<Project ID>/agent/sessions/<Session ID>
or
projects/<Project ID>/agent/environments/<Environment ID>/users/<User
ID>/sessions/<Session ID>
If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteContext() [1/2]

Status google::cloud::dialogflow_es::ContextsClient::DeleteContext ( google::cloud::dialogflow::v2::DeleteContextRequest const &  request,
Options  opts = {} 
)

Deletes the specified context.

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

◆ DeleteContext() [2/2]

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

Deletes the specified context.

Parameters
nameRequired. The name of the context to delete. Format:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>
or
projects/<Project ID>/agent/environments/<Environment ID>/users/<User
ID>/sessions/<Session ID>/contexts/<Context ID>`
If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ GetContext() [1/2]

StatusOr<google::cloud::dialogflow::v2::Context> google::cloud::dialogflow_es::ContextsClient::GetContext ( google::cloud::dialogflow::v2::GetContextRequest const &  request,
Options  opts = {} 
)

Retrieves the specified context.

Parameters
requestgoogle::cloud::dialogflow::v2::GetContextRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Context

◆ GetContext() [2/2]

StatusOr<google::cloud::dialogflow::v2::Context> google::cloud::dialogflow_es::ContextsClient::GetContext ( std::string const &  name,
Options  opts = {} 
)

Retrieves the specified context.

Parameters
nameRequired. The name of the context. Format:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>
or
projects/<Project ID>/agent/environments/<Environment ID>/users/<User
ID>/sessions/<Session ID>/contexts/<Context ID>`
If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Context

◆ ListContexts() [1/2]

StreamRange<google::cloud::dialogflow::v2::Context> google::cloud::dialogflow_es::ContextsClient::ListContexts ( google::cloud::dialogflow::v2::ListContextsRequest  request,
Options  opts = {} 
)

Returns the list of all contexts in the specified session.

Parameters
requestgoogle::cloud::dialogflow::v2::ListContextsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Context

◆ ListContexts() [2/2]

StreamRange<google::cloud::dialogflow::v2::Context> google::cloud::dialogflow_es::ContextsClient::ListContexts ( std::string const &  parent,
Options  opts = {} 
)

Returns the list of all contexts in the specified session.

Parameters
parentRequired. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Context

◆ operator=() [1/2]

ContextsClient& google::cloud::dialogflow_es::ContextsClient::operator= ( ContextsClient &&  )
default

◆ operator=() [2/2]

ContextsClient& google::cloud::dialogflow_es::ContextsClient::operator= ( ContextsClient const &  )
default

◆ UpdateContext() [1/2]

StatusOr<google::cloud::dialogflow::v2::Context> google::cloud::dialogflow_es::ContextsClient::UpdateContext ( google::cloud::dialogflow::v2::Context const &  context,
google::protobuf::FieldMask const &  update_mask,
Options  opts = {} 
)

Updates the specified context.

Parameters
contextRequired. The context to update.
update_maskOptional. 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::Context

◆ UpdateContext() [2/2]

StatusOr<google::cloud::dialogflow::v2::Context> google::cloud::dialogflow_es::ContextsClient::UpdateContext ( google::cloud::dialogflow::v2::UpdateContextRequest const &  request,
Options  opts = {} 
)

Updates the specified context.

Parameters
requestgoogle::cloud::dialogflow::v2::UpdateContextRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Context

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 80 of file contexts_client.h.

◆ operator==

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

Definition at line 77 of file contexts_client.h.