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

Service for managing [Intents][google.cloud.dialogflow.v2.Intent]. More...

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

Public Member Functions

 IntentsClient (std::shared_ptr< IntentsConnection > connection, Options opts={})
 
 ~IntentsClient ()
 
 IntentsClient (IntentsClient const &)=default
 
IntentsClientoperator= (IntentsClient const &)=default
 
 IntentsClient (IntentsClient &&)=default
 
IntentsClientoperator= (IntentsClient &&)=default
 
StreamRange< google::cloud::dialogflow::v2::Intent > ListIntents (std::string const &parent, Options opts={})
 Returns the list of all intents in the specified agent. More...
 
StreamRange< google::cloud::dialogflow::v2::Intent > ListIntents (std::string const &parent, std::string const &language_code, Options opts={})
 Returns the list of all intents in the specified agent. More...
 
StreamRange< google::cloud::dialogflow::v2::Intent > ListIntents (google::cloud::dialogflow::v2::ListIntentsRequest request, Options opts={})
 Returns the list of all intents in the specified agent. More...
 
StatusOr< google::cloud::dialogflow::v2::Intent > GetIntent (std::string const &name, Options opts={})
 Retrieves the specified intent. More...
 
StatusOr< google::cloud::dialogflow::v2::Intent > GetIntent (std::string const &name, std::string const &language_code, Options opts={})
 Retrieves the specified intent. More...
 
StatusOr< google::cloud::dialogflow::v2::Intent > GetIntent (google::cloud::dialogflow::v2::GetIntentRequest const &request, Options opts={})
 Retrieves the specified intent. More...
 
StatusOr< google::cloud::dialogflow::v2::Intent > CreateIntent (std::string const &parent, google::cloud::dialogflow::v2::Intent const &intent, Options opts={})
 Creates an intent in the specified agent. More...
 
StatusOr< google::cloud::dialogflow::v2::Intent > CreateIntent (std::string const &parent, google::cloud::dialogflow::v2::Intent const &intent, std::string const &language_code, Options opts={})
 Creates an intent in the specified agent. More...
 
StatusOr< google::cloud::dialogflow::v2::Intent > CreateIntent (google::cloud::dialogflow::v2::CreateIntentRequest const &request, Options opts={})
 Creates an intent in the specified agent. More...
 
StatusOr< google::cloud::dialogflow::v2::Intent > UpdateIntent (google::cloud::dialogflow::v2::Intent const &intent, std::string const &language_code, Options opts={})
 Updates the specified intent. More...
 
StatusOr< google::cloud::dialogflow::v2::Intent > UpdateIntent (google::cloud::dialogflow::v2::Intent const &intent, std::string const &language_code, google::protobuf::FieldMask const &update_mask, Options opts={})
 Updates the specified intent. More...
 
StatusOr< google::cloud::dialogflow::v2::Intent > UpdateIntent (google::cloud::dialogflow::v2::UpdateIntentRequest const &request, Options opts={})
 Updates the specified intent. More...
 
Status DeleteIntent (std::string const &name, Options opts={})
 Deletes the specified intent and its direct or indirect followup intents. More...
 
Status DeleteIntent (google::cloud::dialogflow::v2::DeleteIntentRequest const &request, Options opts={})
 Deletes the specified intent and its direct or indirect followup intents. More...
 
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateIntentsResponse > > BatchUpdateIntents (std::string const &parent, std::string const &intent_batch_uri, Options opts={})
 Updates/Creates multiple intents in the specified agent. More...
 
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateIntentsResponse > > BatchUpdateIntents (std::string const &parent, google::cloud::dialogflow::v2::IntentBatch const &intent_batch_inline, Options opts={})
 Updates/Creates multiple intents in the specified agent. More...
 
future< StatusOr< google::cloud::dialogflow::v2::BatchUpdateIntentsResponse > > BatchUpdateIntents (google::cloud::dialogflow::v2::BatchUpdateIntentsRequest const &request, Options opts={})
 Updates/Creates multiple intents in the specified agent. More...
 
future< StatusOr< google::protobuf::Struct > > BatchDeleteIntents (std::string const &parent, std::vector< google::cloud::dialogflow::v2::Intent > const &intents, Options opts={})
 Deletes intents in the specified agent. More...
 
future< StatusOr< google::protobuf::Struct > > BatchDeleteIntents (google::cloud::dialogflow::v2::BatchDeleteIntentsRequest const &request, Options opts={})
 Deletes intents in the specified agent. More...
 

Friends

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

Detailed Description

Service for managing [Intents][google.cloud.dialogflow.v2.Intent].

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

Constructor & Destructor Documentation

◆ IntentsClient() [1/3]

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

◆ ~IntentsClient()

google::cloud::dialogflow_es::IntentsClient::~IntentsClient ( )

◆ IntentsClient() [2/3]

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

◆ IntentsClient() [3/3]

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

Member Function Documentation

◆ BatchDeleteIntents() [1/2]

future<StatusOr<google::protobuf::Struct> > google::cloud::dialogflow_es::IntentsClient::BatchDeleteIntents ( google::cloud::dialogflow::v2::BatchDeleteIntentsRequest const &  request,
Options  opts = {} 
)

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

◆ BatchDeleteIntents() [2/2]

future<StatusOr<google::protobuf::Struct> > google::cloud::dialogflow_es::IntentsClient::BatchDeleteIntents ( std::string const &  parent,
std::vector< google::cloud::dialogflow::v2::Intent > const &  intents,
Options  opts = {} 
)

Deletes intents 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
parentRequired. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.
intentsRequired. The collection of intents to delete. Only intent name must be filled in.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::protobuf::Struct

◆ BatchUpdateIntents() [1/3]

future<StatusOr<google::cloud::dialogflow::v2::BatchUpdateIntentsResponse> > google::cloud::dialogflow_es::IntentsClient::BatchUpdateIntents ( google::cloud::dialogflow::v2::BatchUpdateIntentsRequest const &  request,
Options  opts = {} 
)

Updates/Creates multiple intents 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
requestgoogle::cloud::dialogflow::v2::BatchUpdateIntentsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::BatchUpdateIntentsResponse

◆ BatchUpdateIntents() [2/3]

future<StatusOr<google::cloud::dialogflow::v2::BatchUpdateIntentsResponse> > google::cloud::dialogflow_es::IntentsClient::BatchUpdateIntents ( std::string const &  parent,
google::cloud::dialogflow::v2::IntentBatch const &  intent_batch_inline,
Options  opts = {} 
)

Updates/Creates multiple intents 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
parentRequired. The name of the agent to update or create intents in. Format: projects/<Project ID>/agent.
intent_batch_inlineThe collection of intents to update or create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::BatchUpdateIntentsResponse

◆ BatchUpdateIntents() [3/3]

future<StatusOr<google::cloud::dialogflow::v2::BatchUpdateIntentsResponse> > google::cloud::dialogflow_es::IntentsClient::BatchUpdateIntents ( std::string const &  parent,
std::string const &  intent_batch_uri,
Options  opts = {} 
)

Updates/Creates multiple intents 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
parentRequired. The name of the agent to update or create intents in. Format: projects/<Project ID>/agent.
intent_batch_uriThe URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::BatchUpdateIntentsResponse

◆ CreateIntent() [1/3]

StatusOr<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::CreateIntent ( google::cloud::dialogflow::v2::CreateIntentRequest const &  request,
Options  opts = {} 
)

Creates an intent in the specified agent.

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

Parameters
requestgoogle::cloud::dialogflow::v2::CreateIntentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ CreateIntent() [2/3]

StatusOr<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::CreateIntent ( std::string const &  parent,
google::cloud::dialogflow::v2::Intent const &  intent,
Options  opts = {} 
)

Creates an intent in the specified agent.

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

Parameters
parentRequired. The agent to create a intent for. Format: projects/<Project ID>/agent.
intentRequired. The intent to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ CreateIntent() [3/3]

StatusOr<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::CreateIntent ( std::string const &  parent,
google::cloud::dialogflow::v2::Intent const &  intent,
std::string const &  language_code,
Options  opts = {} 
)

Creates an intent in the specified agent.

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

Parameters
parentRequired. The agent to create a intent for. Format: projects/<Project ID>/agent.
intentRequired. The intent to create.
language_codeOptional. 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.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ DeleteIntent() [1/2]

Status google::cloud::dialogflow_es::IntentsClient::DeleteIntent ( google::cloud::dialogflow::v2::DeleteIntentRequest const &  request,
Options  opts = {} 
)

Deletes the specified intent and its direct or indirect followup intents.

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

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

◆ DeleteIntent() [2/2]

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

Deletes the specified intent and its direct or indirect followup intents.

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

Parameters
nameRequired. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: projects/<Project ID>/agent/intents/<Intent ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ GetIntent() [1/3]

StatusOr<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::GetIntent ( google::cloud::dialogflow::v2::GetIntentRequest const &  request,
Options  opts = {} 
)

Retrieves the specified intent.

Parameters
requestgoogle::cloud::dialogflow::v2::GetIntentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ GetIntent() [2/3]

StatusOr<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::GetIntent ( std::string const &  name,
Options  opts = {} 
)

Retrieves the specified intent.

Parameters
nameRequired. The name of the intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ GetIntent() [3/3]

StatusOr<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::GetIntent ( std::string const &  name,
std::string const &  language_code,
Options  opts = {} 
)

Retrieves the specified intent.

Parameters
nameRequired. The name of the intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.
language_codeOptional. 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.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ ListIntents() [1/3]

StreamRange<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::ListIntents ( google::cloud::dialogflow::v2::ListIntentsRequest  request,
Options  opts = {} 
)

Returns the list of all intents in the specified agent.

Parameters
requestgoogle::cloud::dialogflow::v2::ListIntentsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ ListIntents() [2/3]

StreamRange<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::ListIntents ( std::string const &  parent,
Options  opts = {} 
)

Returns the list of all intents in the specified agent.

Parameters
parentRequired. The agent to list all intents from. Format: projects/<Project ID>/agent or projects/<Project ID>/locations/<Location ID>/agent. Alternatively, you can specify the environment to list intents for. Format: projects/<Project ID>/agent/environments/<Environment ID> or projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>. Note: training phrases of the intents will not be returned for non-draft environment.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ ListIntents() [3/3]

StreamRange<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::ListIntents ( std::string const &  parent,
std::string const &  language_code,
Options  opts = {} 
)

Returns the list of all intents in the specified agent.

Parameters
parentRequired. The agent to list all intents from. Format: projects/<Project ID>/agent or projects/<Project ID>/locations/<Location ID>/agent. Alternatively, you can specify the environment to list intents for. Format: projects/<Project ID>/agent/environments/<Environment ID> or projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>. Note: training phrases of the intents will not be returned for non-draft environment.
language_codeOptional. 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.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ UpdateIntent() [1/3]

StatusOr<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::UpdateIntent ( google::cloud::dialogflow::v2::Intent const &  intent,
std::string const &  language_code,
google::protobuf::FieldMask const &  update_mask,
Options  opts = {} 
)

Updates the specified intent.

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

Parameters
intentRequired. The intent to update.
language_codeOptional. 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.
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::Intent

◆ UpdateIntent() [2/3]

StatusOr<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::UpdateIntent ( google::cloud::dialogflow::v2::Intent const &  intent,
std::string const &  language_code,
Options  opts = {} 
)

Updates the specified intent.

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

Parameters
intentRequired. The intent to update.
language_codeOptional. 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.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

◆ UpdateIntent() [3/3]

StatusOr<google::cloud::dialogflow::v2::Intent> google::cloud::dialogflow_es::IntentsClient::UpdateIntent ( google::cloud::dialogflow::v2::UpdateIntentRequest const &  request,
Options  opts = {} 
)

Updates the specified intent.

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

Parameters
requestgoogle::cloud::dialogflow::v2::UpdateIntentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Intent

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 81 of file intents_client.h.

◆ operator==

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

Definition at line 78 of file intents_client.h.