google::cloud::dialogflow_es::ContextsClient Class Reference

Service for managing Contexts. More...

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

Public Member Functions
	ContextsClient (std::shared_ptr< ContextsConnection > connection, Options opts={})
	~ContextsClient ()
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...
Copy and move support
	ContextsClient (ContextsClient const &)=default
ContextsClient &	operator= (ContextsClient const &)=default
	ContextsClient (ContextsClient &&)=default
ContextsClient &	operator= (ContextsClient &&)=default

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

Detailed Description

Service for managing Contexts.

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.

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

request	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.v2.CreateContextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

parent	Required. 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.
context	Required. The context to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	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.v2.DeleteAllContextsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

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

parent	Required. 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.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

DeleteContext() [1/2]

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

Deletes the specified context.

Parameters

request	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.v2.DeleteContextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

DeleteContext() [2/2]

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

Deletes the specified context.

Parameters

name	Required. 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.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

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

request	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.v2.GetContextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

name	Required. 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.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	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.v2.ListContextsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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.v2.Context, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

parent	Required. 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.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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.v2.Context, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

context	Required. The context to update.
update_mask	Optional. The mask to control which fields get updated.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	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.v2.UpdateContextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

Friends And Related Function Documentation

operator!=

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

friend

operator==

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

friend