Class EntityTypesClient (2.29.0-rc)

Service for managing EntityTypes.

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

EntityTypesClient(EntityTypesClient const &)

Copy and move support

Parameter
Name Description
EntityTypesClient const &

EntityTypesClient(EntityTypesClient &&)

Copy and move support

Parameter
Name Description
EntityTypesClient &&

EntityTypesClient(std::shared_ptr< EntityTypesConnection >, Options)

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

Operators

operator=(EntityTypesClient const &)

Copy and move support

Parameter
Name Description
EntityTypesClient const &
Returns
Type Description
EntityTypesClient &

operator=(EntityTypesClient &&)

Copy and move support

Parameter
Name Description
EntityTypesClient &&
Returns
Type Description
EntityTypesClient &

Functions

ListEntityTypes(std::string const &, Options)

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

Parameters
Name Description
parent std::string const &

Required. The agent to list all entity types from. Format: projects/<ProjectID>/agent.

opts Options

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

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

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

ListEntityTypes(std::string const &, std::string const &, Options)

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

Parameters
Name Description
parent std::string const &

Required. The agent to list all entity types from. Format: projects/<ProjectID>/agent.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

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

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

ListEntityTypes(google::cloud::dialogflow::v2::ListEntityTypesRequest, Options)

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

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

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.ListEntityTypesRequest. 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::EntityType >

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

GetEntityType(std::string const &, Options)

Retrieves the specified entity type.

Parameters
Name Description
name std::string const &

Required. The name of the entity type. Format: projects/<ProjectID>/agent/entityTypes/<EntityType ID>.

opts Options

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

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

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

GetEntityType(std::string const &, std::string const &, Options)

Retrieves the specified entity type.

Parameters
Name Description
name std::string const &

Required. The name of the entity type. Format: projects/<ProjectID>/agent/entityTypes/<EntityType ID>.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

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

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

GetEntityType(google::cloud::dialogflow::v2::GetEntityTypeRequest const &, Options)

Retrieves the specified entity type.

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

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

CreateEntityType(std::string const &, google::cloud::dialogflow::v2::EntityType const &, Options)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent std::string const &

Required. The agent to create a entity type for. Format: projects/<ProjectID>/agent.

entity_type google::cloud::dialogflow::v2::EntityType const &

Required. The 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::EntityType >

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

CreateEntityType(std::string const &, google::cloud::dialogflow::v2::EntityType const &, std::string const &, Options)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent std::string const &

Required. The agent to create a entity type for. Format: projects/<ProjectID>/agent.

entity_type google::cloud::dialogflow::v2::EntityType const &

Required. The entity type to create.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

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

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

CreateEntityType(google::cloud::dialogflow::v2::CreateEntityTypeRequest const &, Options)

Creates an entity type in the specified agent.

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

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

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

UpdateEntityType(google::cloud::dialogflow::v2::EntityType const &, Options)

Updates the specified entity type.

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

Parameters
Name Description
entity_type google::cloud::dialogflow::v2::EntityType const &

Required. The 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::EntityType >

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

UpdateEntityType(google::cloud::dialogflow::v2::EntityType const &, std::string const &, Options)

Updates the specified entity type.

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

Parameters
Name Description
entity_type google::cloud::dialogflow::v2::EntityType const &

Required. The entity type to update.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

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

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

UpdateEntityType(google::cloud::dialogflow::v2::UpdateEntityTypeRequest const &, Options)

Updates the specified entity type.

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

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

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

DeleteEntityType(std::string const &, Options)

Deletes the specified entity type.

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

Parameters
Name Description
name std::string const &

Required. The name of the entity type to delete. Format: projects/<ProjectID>/agent/entityTypes/<EntityType ID>.

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.

DeleteEntityType(google::cloud::dialogflow::v2::DeleteEntityTypeRequest const &, Options)

Deletes the specified entity type.

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

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

BatchUpdateEntityTypes(google::cloud::dialogflow::v2::BatchUpdateEntityTypesRequest const &, Options)

Updates/Creates multiple entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
request google::cloud::dialogflow::v2::BatchUpdateEntityTypesRequest 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.BatchUpdateEntityTypesRequest. 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
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateEntityTypesResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchUpdateEntityTypes(NoAwaitTag, google::cloud::dialogflow::v2::BatchUpdateEntityTypesRequest const &, Options)

Updates/Creates multiple entity types in the specified agent.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::BatchUpdateEntityTypesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchUpdateEntityTypes(google::longrunning::Operation const &, Options)

Updates/Creates multiple entity types in the specified agent.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateEntityTypesResponse > >

BatchDeleteEntityTypes(std::string const &, std::vector< std::string > const &, Options)

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
parent std::string const &

Required. The name of the agent to delete all entities types for. Format: projects/<ProjectID>/agent.

entity_type_names std::vector< std::string > const &

Required. The names entity types to delete. All names must point to the same agent as parent.

opts Options

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

Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeleteEntityTypes(NoAwaitTag, std::string const &, std::vector< std::string > const &, Options)

Deletes entity types in the specified agent.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
entity_type_names std::vector< std::string > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchDeleteEntityTypes(google::cloud::dialogflow::v2::BatchDeleteEntityTypesRequest const &, Options)

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
request google::cloud::dialogflow::v2::BatchDeleteEntityTypesRequest 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.BatchDeleteEntityTypesRequest. 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
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeleteEntityTypes(NoAwaitTag, google::cloud::dialogflow::v2::BatchDeleteEntityTypesRequest const &, Options)

Deletes entity types in the specified agent.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::BatchDeleteEntityTypesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchDeleteEntityTypes(google::longrunning::Operation const &, Options)

Deletes entity types in the specified agent.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

BatchCreateEntities(std::string const &, std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &, Options)

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
parent std::string const &

Required. The name of the entity type to create entities in. Format: projects/<ProjectID>/agent/entityTypes/<Entity Type ID>.

entities std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &

Required. The entities to create.

opts Options

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

Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchCreateEntities(NoAwaitTag, std::string const &, std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &, Options)

Creates multiple new entities in the specified entity type.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
entities std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchCreateEntities(std::string const &, std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &, std::string const &, Options)

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
parent std::string const &

Required. The name of the entity type to create entities in. Format: projects/<ProjectID>/agent/entityTypes/<Entity Type ID>.

entities std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &

Required. The entities to create.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchCreateEntities(NoAwaitTag, std::string const &, std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &, std::string const &, Options)

Creates multiple new entities in the specified entity type.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
entities std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &
language_code std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchCreateEntities(google::cloud::dialogflow::v2::BatchCreateEntitiesRequest const &, Options)

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
request google::cloud::dialogflow::v2::BatchCreateEntitiesRequest 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.BatchCreateEntitiesRequest. 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
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchCreateEntities(NoAwaitTag, google::cloud::dialogflow::v2::BatchCreateEntitiesRequest const &, Options)

Creates multiple new entities in the specified entity type.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::BatchCreateEntitiesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchCreateEntities(google::longrunning::Operation const &, Options)

Creates multiple new entities in the specified entity type.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

BatchUpdateEntities(std::string const &, std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &, Options)

Updates or creates multiple entities in the specified entity type.

This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
parent std::string const &

Required. The name of the entity type to update or create entities in. Format: projects/<ProjectID>/agent/entityTypes/<Entity Type ID>.

entities std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &

Required. The entities to update or create.

opts Options

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

Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchUpdateEntities(NoAwaitTag, std::string const &, std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &, Options)

Updates or creates multiple entities in the specified entity type.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
entities std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchUpdateEntities(std::string const &, std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &, std::string const &, Options)

Updates or creates multiple entities in the specified entity type.

This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
parent std::string const &

Required. The name of the entity type to update or create entities in. Format: projects/<ProjectID>/agent/entityTypes/<Entity Type ID>.

entities std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &

Required. The entities to update or create.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchUpdateEntities(NoAwaitTag, std::string const &, std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &, std::string const &, Options)

Updates or creates multiple entities in the specified entity type.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
entities std::vector< google::cloud::dialogflow::v2::EntityType::Entity > const &
language_code std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchUpdateEntities(google::cloud::dialogflow::v2::BatchUpdateEntitiesRequest const &, Options)

Updates or creates multiple entities in the specified entity type.

This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
request google::cloud::dialogflow::v2::BatchUpdateEntitiesRequest 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.BatchUpdateEntitiesRequest. 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
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchUpdateEntities(NoAwaitTag, google::cloud::dialogflow::v2::BatchUpdateEntitiesRequest const &, Options)

Updates or creates multiple entities in the specified entity type.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::BatchUpdateEntitiesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchUpdateEntities(google::longrunning::Operation const &, Options)

Updates or creates multiple entities in the specified entity type.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

BatchDeleteEntities(std::string const &, std::vector< std::string > const &, Options)

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
parent std::string const &

Required. The name of the entity type to delete entries for. Format: projects/<ProjectID>/agent/entityTypes/<Entity Type ID>.

entity_values std::vector< std::string > const &

Required. The reference values of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with projects/<ProjectID>.

opts Options

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

Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeleteEntities(NoAwaitTag, std::string const &, std::vector< std::string > const &, Options)

Deletes entities in the specified entity type.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
entity_values std::vector< std::string > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchDeleteEntities(std::string const &, std::vector< std::string > const &, std::string const &, Options)

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
parent std::string const &

Required. The name of the entity type to delete entries for. Format: projects/<ProjectID>/agent/entityTypes/<Entity Type ID>.

entity_values std::vector< std::string > const &

Required. The reference values of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with projects/<ProjectID>.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeleteEntities(NoAwaitTag, std::string const &, std::vector< std::string > const &, std::string const &, Options)

Deletes entities in the specified entity type.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
entity_values std::vector< std::string > const &
language_code std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchDeleteEntities(google::cloud::dialogflow::v2::BatchDeleteEntitiesRequest const &, Options)

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

Parameters
Name Description
request google::cloud::dialogflow::v2::BatchDeleteEntitiesRequest 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.BatchDeleteEntitiesRequest. 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
future< StatusOr< google::protobuf::Struct > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeleteEntities(NoAwaitTag, google::cloud::dialogflow::v2::BatchDeleteEntitiesRequest const &, Options)

Deletes entities in the specified entity type.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::dialogflow::v2::BatchDeleteEntitiesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchDeleteEntities(google::longrunning::Operation const &, Options)

Deletes entities in the specified entity type.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::protobuf::Struct > >