Class SessionEntityTypesClient (2.23.0-rc)

Service for managing SessionEntityTypes.

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

SessionEntityTypesClient(SessionEntityTypesClient const &)

Copy and move support

Parameter
Name	Description
	`SessionEntityTypesClient const &`

SessionEntityTypesClient(SessionEntityTypesClient &&)

Copy and move support

Parameter
Name	Description
	`SessionEntityTypesClient &&`

SessionEntityTypesClient(std::shared_ptr< SessionEntityTypesConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< SessionEntityTypesConnection >`
`opts`	`Options`

Operators

operator=(SessionEntityTypesClient const &)

Copy and move support

Parameter
Name	Description
	`SessionEntityTypesClient const &`

Returns
Type	Description
`SessionEntityTypesClient &`

operator=(SessionEntityTypesClient &&)

Copy and move support

Parameter
Name	Description
	`SessionEntityTypesClient &&`

Returns
Type	Description
`SessionEntityTypesClient &`

Functions

ListSessionEntityTypes(std::string const &, Options)

Returns the list of all session entity types in the specified session.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`parent`	`std::string const &` Required. The session to list all session entity types 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::SessionEntityType >

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

ListSessionEntityTypes(google::cloud::dialogflow::v2::ListSessionEntityTypesRequest, Options)

Returns the list of all session entity types in the specified session.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`request`	`google::cloud::dialogflow::v2::ListSessionEntityTypesRequest` 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.ListSessionEntityTypesRequest. 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::SessionEntityType >

GetSessionEntityType(std::string const &, Options)

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters

Name Description

name

std::string const &

Required. The name of the session entity type. Format:

projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
```<br>
 or <br>

```cpp
projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
``` 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::SessionEntityType >`	the result of the RPC. The response message type (google.cloud.dialogflow.v2.SessionEntityType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetSessionEntityType(google::cloud::dialogflow::v2::GetSessionEntityTypeRequest const &, Options)

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`request`	`google::cloud::dialogflow::v2::GetSessionEntityTypeRequest 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.GetSessionEntityTypeRequest. 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::SessionEntityType >`	the result of the RPC. The response message type (google.cloud.dialogflow.v2.SessionEntityType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateSessionEntityType(std::string const &, google::cloud::dialogflow::v2::SessionEntityType const &, Options)

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`parent`	`std::string const &` Required. The session to create a session entity type 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.
`session_entity_type`	`google::cloud::dialogflow::v2::SessionEntityType const &` Required. The session entity type to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

CreateSessionEntityType(google::cloud::dialogflow::v2::CreateSessionEntityTypeRequest const &, Options)

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`request`	`google::cloud::dialogflow::v2::CreateSessionEntityTypeRequest 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.CreateSessionEntityTypeRequest. 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::SessionEntityType >`	the result of the RPC. The response message type (google.cloud.dialogflow.v2.SessionEntityType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateSessionEntityType(google::cloud::dialogflow::v2::SessionEntityType const &, Options)

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`session_entity_type`	`google::cloud::dialogflow::v2::SessionEntityType const &` Required. The session entity type to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateSessionEntityType(google::cloud::dialogflow::v2::SessionEntityType const &, google::protobuf::FieldMask const &, Options)

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`session_entity_type`	`google::cloud::dialogflow::v2::SessionEntityType const &` Required. The session entity type 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::SessionEntityType >`	the result of the RPC. The response message type (google.cloud.dialogflow.v2.SessionEntityType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateSessionEntityType(google::cloud::dialogflow::v2::UpdateSessionEntityTypeRequest const &, Options)

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`request`	`google::cloud::dialogflow::v2::UpdateSessionEntityTypeRequest 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.UpdateSessionEntityTypeRequest. 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::SessionEntityType >`	the result of the RPC. The response message type (google.cloud.dialogflow.v2.SessionEntityType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteSessionEntityType(std::string const &, Options)

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters

Name Description

name

std::string const &

Required. The name of the entity type to delete. Format:

projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
```<br>
 or <br>

```cpp
projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
``` 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.

DeleteSessionEntityType(google::cloud::dialogflow::v2::DeleteSessionEntityTypeRequest const &, Options)

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`request`	`google::cloud::dialogflow::v2::DeleteSessionEntityTypeRequest 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.DeleteSessionEntityTypeRequest. 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.