Dialogflow API C++ Client  2.2.1
A C++ Client Library for the Dialogflow API
Public Member Functions | Friends | List of all members
google::cloud::dialogflow_cx::EntityTypesClient Class Reference

Service for managing [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType]. More...

#include <google/cloud/dialogflow_cx/entity_types_client.h>

Public Member Functions

 EntityTypesClient (std::shared_ptr< EntityTypesConnection > connection, Options opts={})
 
 ~EntityTypesClient ()
 
 EntityTypesClient (EntityTypesClient const &)=default
 
EntityTypesClientoperator= (EntityTypesClient const &)=default
 
 EntityTypesClient (EntityTypesClient &&)=default
 
EntityTypesClientoperator= (EntityTypesClient &&)=default
 
StreamRange< google::cloud::dialogflow::cx::v3::EntityType > ListEntityTypes (std::string const &parent, Options opts={})
 Returns the list of all entity types in the specified agent. More...
 
StreamRange< google::cloud::dialogflow::cx::v3::EntityType > ListEntityTypes (google::cloud::dialogflow::cx::v3::ListEntityTypesRequest request, Options opts={})
 Returns the list of all entity types in the specified agent. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::EntityType > GetEntityType (std::string const &name, Options opts={})
 Retrieves the specified entity type. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::EntityType > GetEntityType (google::cloud::dialogflow::cx::v3::GetEntityTypeRequest const &request, Options opts={})
 Retrieves the specified entity type. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::EntityType > CreateEntityType (std::string const &parent, google::cloud::dialogflow::cx::v3::EntityType const &entity_type, Options opts={})
 Creates an entity type in the specified agent. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::EntityType > CreateEntityType (google::cloud::dialogflow::cx::v3::CreateEntityTypeRequest const &request, Options opts={})
 Creates an entity type in the specified agent. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::EntityType > UpdateEntityType (google::cloud::dialogflow::cx::v3::EntityType const &entity_type, google::protobuf::FieldMask const &update_mask, Options opts={})
 Updates the specified entity type. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::EntityType > UpdateEntityType (google::cloud::dialogflow::cx::v3::UpdateEntityTypeRequest const &request, Options opts={})
 Updates the specified entity type. More...
 
Status DeleteEntityType (std::string const &name, Options opts={})
 Deletes the specified entity type. More...
 
Status DeleteEntityType (google::cloud::dialogflow::cx::v3::DeleteEntityTypeRequest const &request, Options opts={})
 Deletes the specified entity type. More...
 

Friends

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

Detailed Description

Service for managing [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType].

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

Constructor & Destructor Documentation

◆ EntityTypesClient() [1/3]

google::cloud::dialogflow_cx::EntityTypesClient::EntityTypesClient ( std::shared_ptr< EntityTypesConnection connection,
Options  opts = {} 
)
explicit

◆ ~EntityTypesClient()

google::cloud::dialogflow_cx::EntityTypesClient::~EntityTypesClient ( )

◆ EntityTypesClient() [2/3]

google::cloud::dialogflow_cx::EntityTypesClient::EntityTypesClient ( EntityTypesClient const &  )
default

◆ EntityTypesClient() [3/3]

google::cloud::dialogflow_cx::EntityTypesClient::EntityTypesClient ( EntityTypesClient &&  )
default

Member Function Documentation

◆ CreateEntityType() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::EntityType> google::cloud::dialogflow_cx::EntityTypesClient::CreateEntityType ( google::cloud::dialogflow::cx::v3::CreateEntityTypeRequest const &  request,
Options  opts = {} 
)

Creates an entity type in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::CreateEntityTypeRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::EntityType

◆ CreateEntityType() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::EntityType> google::cloud::dialogflow_cx::EntityTypesClient::CreateEntityType ( std::string const &  parent,
google::cloud::dialogflow::cx::v3::EntityType const &  entity_type,
Options  opts = {} 
)

Creates an entity type in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
parentRequired. The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
entity_typeRequired. The entity type to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::EntityType

◆ DeleteEntityType() [1/2]

Status google::cloud::dialogflow_cx::EntityTypesClient::DeleteEntityType ( google::cloud::dialogflow::cx::v3::DeleteEntityTypeRequest const &  request,
Options  opts = {} 
)

Deletes the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation.

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

◆ DeleteEntityType() [2/2]

Status google::cloud::dialogflow_cx::EntityTypesClient::DeleteEntityType ( std::string const &  name,
Options  opts = {} 
)

Deletes the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
nameRequired. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ GetEntityType() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::EntityType> google::cloud::dialogflow_cx::EntityTypesClient::GetEntityType ( google::cloud::dialogflow::cx::v3::GetEntityTypeRequest const &  request,
Options  opts = {} 
)

Retrieves the specified entity type.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::GetEntityTypeRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::EntityType

◆ GetEntityType() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::EntityType> google::cloud::dialogflow_cx::EntityTypesClient::GetEntityType ( std::string const &  name,
Options  opts = {} 
)

Retrieves the specified entity type.

Parameters
nameRequired. The name of the entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::EntityType

◆ ListEntityTypes() [1/2]

StreamRange<google::cloud::dialogflow::cx::v3::EntityType> google::cloud::dialogflow_cx::EntityTypesClient::ListEntityTypes ( google::cloud::dialogflow::cx::v3::ListEntityTypesRequest  request,
Options  opts = {} 
)

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

Parameters
requestgoogle::cloud::dialogflow::cx::v3::ListEntityTypesRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::EntityType

◆ ListEntityTypes() [2/2]

StreamRange<google::cloud::dialogflow::cx::v3::EntityType> google::cloud::dialogflow_cx::EntityTypesClient::ListEntityTypes ( std::string const &  parent,
Options  opts = {} 
)

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

Parameters
parentRequired. The agent to list all entity types for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::EntityType

◆ operator=() [1/2]

EntityTypesClient& google::cloud::dialogflow_cx::EntityTypesClient::operator= ( EntityTypesClient &&  )
default

◆ operator=() [2/2]

EntityTypesClient& google::cloud::dialogflow_cx::EntityTypesClient::operator= ( EntityTypesClient const &  )
default

◆ UpdateEntityType() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::EntityType> google::cloud::dialogflow_cx::EntityTypesClient::UpdateEntityType ( google::cloud::dialogflow::cx::v3::EntityType const &  entity_type,
google::protobuf::FieldMask const &  update_mask,
Options  opts = {} 
)

Updates the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
entity_typeRequired. The entity type to update.
update_maskThe mask to control which fields get updated.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::EntityType

◆ UpdateEntityType() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::EntityType> google::cloud::dialogflow_cx::EntityTypesClient::UpdateEntityType ( google::cloud::dialogflow::cx::v3::UpdateEntityTypeRequest const &  request,
Options  opts = {} 
)

Updates the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::UpdateEntityTypeRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::EntityType

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 82 of file entity_types_client.h.

◆ operator==

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

Definition at line 78 of file entity_types_client.h.