Class ContextsClient (2.23.0)

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.

Constructors

ContextsClient(ContextsClient const &)

Copy and move support

Parameter
Name Description
ContextsClient const &

ContextsClient(ContextsClient &&)

Copy and move support

Parameter
Name Description
ContextsClient &&

ContextsClient(std::shared_ptr< ContextsConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< ContextsConnection >
opts Options

Operators

operator=(ContextsClient const &)

Copy and move support

Parameter
Name Description
ContextsClient const &
Returns
Type Description
ContextsClient &

operator=(ContextsClient &&)

Copy and move support

Parameter
Name Description
ContextsClient &&
Returns
Type Description
ContextsClient &

Functions

ListContexts(std::string const &, Options)

Returns the list of all contexts in the specified session.

Parameters
Name Description
parent std::string const &

Required. The session to list all contexts from. Format: projects/<ProjectID>/agent/sessions/<Session ID> or projects/<ProjectID>/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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::v2::Context >

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(google::cloud::dialogflow::v2::ListContextsRequest, Options)

Returns the list of all contexts in the specified session.

Parameters
Name Description
request google::cloud::dialogflow::v2::ListContextsRequest

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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::v2::Context >

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.

GetContext(std::string const &, Options)

Retrieves the specified context.

Parameters
Name Description
name std::string const &

Required. The name of the context. Format: 

projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>
```<br>
 or <br>

```cpp
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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Context >

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(google::cloud::dialogflow::v2::GetContextRequest const &, Options)

Retrieves the specified context.

Parameters
Name Description
request google::cloud::dialogflow::v2::GetContextRequest const &

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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Context >

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(std::string const &, google::cloud::dialogflow::v2::Context const &, Options)

Creates a context.

If the specified context already exists, overrides the context.

Parameters
Name Description
parent std::string const &

Required. The session to create a context for. Format: projects/<ProjectID>/agent/sessions/<Session ID> or projects/<ProjectID>/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 google::cloud::dialogflow::v2::Context const &

Required. The context to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Context >

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(google::cloud::dialogflow::v2::CreateContextRequest const &, Options)

Creates a context.

If the specified context already exists, overrides the context.

Parameters
Name Description
request google::cloud::dialogflow::v2::CreateContextRequest const &

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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Context >

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(google::cloud::dialogflow::v2::Context const &, google::protobuf::FieldMask const &, Options)

Updates the specified context.

Parameters
Name Description
context google::cloud::dialogflow::v2::Context const &

Required. The context to update.

update_mask google::protobuf::FieldMask const &

Optional. The mask to control which fields get updated.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Context >

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(google::cloud::dialogflow::v2::UpdateContextRequest const &, Options)

Updates the specified context.

Parameters
Name Description
request google::cloud::dialogflow::v2::UpdateContextRequest const &

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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Context >

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.

DeleteContext(std::string const &, Options)

Deletes the specified context.

Parameters
Name Description
name std::string const &

Required. The name of the context to delete. Format: 

projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>
```<br>
 or <br>

```cpp
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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

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

DeleteContext(google::cloud::dialogflow::v2::DeleteContextRequest const &, Options)

Deletes the specified context.

Parameters
Name Description
request google::cloud::dialogflow::v2::DeleteContextRequest const &

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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

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

DeleteAllContexts(std::string const &, Options)

Deletes all active contexts in the specified session.

Parameters
Name Description
parent std::string const &

Required. The name of the session to delete all contexts from. Format: 

projects/<Project ID>/agent/sessions/<Session ID>
```<br>
 or <br>

```cpp
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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

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

DeleteAllContexts(google::cloud::dialogflow::v2::DeleteAllContextsRequest const &, Options)

Deletes all active contexts in the specified session.

Parameters
Name Description
request google::cloud::dialogflow::v2::DeleteAllContextsRequest const &

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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

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