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

Service for managing [SessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityType]. More...

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

Public Member Functions

 SessionEntityTypesClient (std::shared_ptr< SessionEntityTypesConnection > connection, Options opts={})
 
 ~SessionEntityTypesClient ()
 
 SessionEntityTypesClient (SessionEntityTypesClient const &)=default
 
SessionEntityTypesClientoperator= (SessionEntityTypesClient const &)=default
 
 SessionEntityTypesClient (SessionEntityTypesClient &&)=default
 
SessionEntityTypesClientoperator= (SessionEntityTypesClient &&)=default
 
StreamRange< google::cloud::dialogflow::v2::SessionEntityType > ListSessionEntityTypes (std::string const &parent, Options opts={})
 Returns the list of all session entity types in the specified session. More...
 
StreamRange< google::cloud::dialogflow::v2::SessionEntityType > ListSessionEntityTypes (google::cloud::dialogflow::v2::ListSessionEntityTypesRequest request, Options opts={})
 Returns the list of all session entity types in the specified session. More...
 
StatusOr< google::cloud::dialogflow::v2::SessionEntityType > GetSessionEntityType (std::string const &name, Options opts={})
 Retrieves the specified session entity type. More...
 
StatusOr< google::cloud::dialogflow::v2::SessionEntityType > GetSessionEntityType (google::cloud::dialogflow::v2::GetSessionEntityTypeRequest const &request, Options opts={})
 Retrieves the specified session entity type. More...
 
StatusOr< google::cloud::dialogflow::v2::SessionEntityType > CreateSessionEntityType (std::string const &parent, google::cloud::dialogflow::v2::SessionEntityType const &session_entity_type, Options opts={})
 Creates a session entity type. More...
 
StatusOr< google::cloud::dialogflow::v2::SessionEntityType > CreateSessionEntityType (google::cloud::dialogflow::v2::CreateSessionEntityTypeRequest const &request, Options opts={})
 Creates a session entity type. More...
 
StatusOr< google::cloud::dialogflow::v2::SessionEntityType > UpdateSessionEntityType (google::cloud::dialogflow::v2::SessionEntityType const &session_entity_type, Options opts={})
 Updates the specified session entity type. More...
 
StatusOr< google::cloud::dialogflow::v2::SessionEntityType > UpdateSessionEntityType (google::cloud::dialogflow::v2::SessionEntityType const &session_entity_type, google::protobuf::FieldMask const &update_mask, Options opts={})
 Updates the specified session entity type. More...
 
StatusOr< google::cloud::dialogflow::v2::SessionEntityType > UpdateSessionEntityType (google::cloud::dialogflow::v2::UpdateSessionEntityTypeRequest const &request, Options opts={})
 Updates the specified session entity type. More...
 
Status DeleteSessionEntityType (std::string const &name, Options opts={})
 Deletes the specified session entity type. More...
 
Status DeleteSessionEntityType (google::cloud::dialogflow::v2::DeleteSessionEntityTypeRequest const &request, Options opts={})
 Deletes the specified session entity type. More...
 

Friends

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

Detailed Description

Service for managing [SessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityType].

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 62 of file session_entity_types_client.h.

Constructor & Destructor Documentation

◆ SessionEntityTypesClient() [1/3]

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

◆ ~SessionEntityTypesClient()

google::cloud::dialogflow_es::SessionEntityTypesClient::~SessionEntityTypesClient ( )

◆ SessionEntityTypesClient() [2/3]

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

◆ SessionEntityTypesClient() [3/3]

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

Member Function Documentation

◆ CreateSessionEntityType() [1/2]

StatusOr<google::cloud::dialogflow::v2::SessionEntityType> google::cloud::dialogflow_es::SessionEntityTypesClient::CreateSessionEntityType ( google::cloud::dialogflow::v2::CreateSessionEntityTypeRequest const &  request,
Options  opts = {} 
)

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

◆ CreateSessionEntityType() [2/2]

StatusOr<google::cloud::dialogflow::v2::SessionEntityType> google::cloud::dialogflow_es::SessionEntityTypesClient::CreateSessionEntityType ( std::string const &  parent,
google::cloud::dialogflow::v2::SessionEntityType const &  session_entity_type,
Options  opts = {} 
)

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
parentRequired. The session to create a session entity type 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.
session_entity_typeRequired. The session entity type to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::SessionEntityType

◆ DeleteSessionEntityType() [1/2]

Status google::cloud::dialogflow_es::SessionEntityTypesClient::DeleteSessionEntityType ( google::cloud::dialogflow::v2::DeleteSessionEntityTypeRequest const &  request,
Options  opts = {} 
)

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

◆ DeleteSessionEntityType() [2/2]

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

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
nameRequired. The name of the entity type to delete. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity
Type Display Name>
or
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.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ GetSessionEntityType() [1/2]

StatusOr<google::cloud::dialogflow::v2::SessionEntityType> google::cloud::dialogflow_es::SessionEntityTypesClient::GetSessionEntityType ( google::cloud::dialogflow::v2::GetSessionEntityTypeRequest const &  request,
Options  opts = {} 
)

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

◆ GetSessionEntityType() [2/2]

StatusOr<google::cloud::dialogflow::v2::SessionEntityType> google::cloud::dialogflow_es::SessionEntityTypesClient::GetSessionEntityType ( std::string const &  name,
Options  opts = {} 
)

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
nameRequired. The name of the session entity type. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity
Type Display Name>
or
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.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::SessionEntityType

◆ ListSessionEntityTypes() [1/2]

StreamRange<google::cloud::dialogflow::v2::SessionEntityType> google::cloud::dialogflow_es::SessionEntityTypesClient::ListSessionEntityTypes ( google::cloud::dialogflow::v2::ListSessionEntityTypesRequest  request,
Options  opts = {} 
)

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

◆ ListSessionEntityTypes() [2/2]

StreamRange<google::cloud::dialogflow::v2::SessionEntityType> google::cloud::dialogflow_es::SessionEntityTypesClient::ListSessionEntityTypes ( std::string const &  parent,
Options  opts = {} 
)

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
parentRequired. The session to list all session entity types 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::SessionEntityType

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ UpdateSessionEntityType() [1/3]

StatusOr<google::cloud::dialogflow::v2::SessionEntityType> google::cloud::dialogflow_es::SessionEntityTypesClient::UpdateSessionEntityType ( google::cloud::dialogflow::v2::SessionEntityType const &  session_entity_type,
google::protobuf::FieldMask const &  update_mask,
Options  opts = {} 
)

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
session_entity_typeRequired. The session entity type 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::SessionEntityType

◆ UpdateSessionEntityType() [2/3]

StatusOr<google::cloud::dialogflow::v2::SessionEntityType> google::cloud::dialogflow_es::SessionEntityTypesClient::UpdateSessionEntityType ( google::cloud::dialogflow::v2::SessionEntityType const &  session_entity_type,
Options  opts = {} 
)

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
session_entity_typeRequired. The session entity type to update.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::SessionEntityType

◆ UpdateSessionEntityType() [3/3]

StatusOr<google::cloud::dialogflow::v2::SessionEntityType> google::cloud::dialogflow_es::SessionEntityTypesClient::UpdateSessionEntityType ( google::cloud::dialogflow::v2::UpdateSessionEntityTypeRequest const &  request,
Options  opts = {} 
)

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

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 84 of file session_entity_types_client.h.

◆ operator==

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

Definition at line 80 of file session_entity_types_client.h.