google::cloud::dialogflow_cx::IntentsClient Class Reference

Service for managing Intents. More...

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

Public Member Functions
	IntentsClient (std::shared_ptr< IntentsConnection > connection, Options opts={})
	~IntentsClient ()
StreamRange< google::cloud::dialogflow::cx::v3::Intent >	ListIntents (std::string const &parent, Options opts={})
	Returns the list of all intents in the specified agent. More...
StreamRange< google::cloud::dialogflow::cx::v3::Intent >	ListIntents (google::cloud::dialogflow::cx::v3::ListIntentsRequest request, Options opts={})
	Returns the list of all intents in the specified agent. More...
StatusOr< google::cloud::dialogflow::cx::v3::Intent >	GetIntent (std::string const &name, Options opts={})
	Retrieves the specified intent. More...
StatusOr< google::cloud::dialogflow::cx::v3::Intent >	GetIntent (google::cloud::dialogflow::cx::v3::GetIntentRequest const &request, Options opts={})
	Retrieves the specified intent. More...
StatusOr< google::cloud::dialogflow::cx::v3::Intent >	CreateIntent (std::string const &parent, google::cloud::dialogflow::cx::v3::Intent const &intent, Options opts={})
	Creates an intent in the specified agent. More...
StatusOr< google::cloud::dialogflow::cx::v3::Intent >	CreateIntent (google::cloud::dialogflow::cx::v3::CreateIntentRequest const &request, Options opts={})
	Creates an intent in the specified agent. More...
StatusOr< google::cloud::dialogflow::cx::v3::Intent >	UpdateIntent (google::cloud::dialogflow::cx::v3::Intent const &intent, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified intent. More...
StatusOr< google::cloud::dialogflow::cx::v3::Intent >	UpdateIntent (google::cloud::dialogflow::cx::v3::UpdateIntentRequest const &request, Options opts={})
	Updates the specified intent. More...
Status	DeleteIntent (std::string const &name, Options opts={})
	Deletes the specified intent. More...
Status	DeleteIntent (google::cloud::dialogflow::cx::v3::DeleteIntentRequest const &request, Options opts={})
	Deletes the specified intent. More...
Copy and move support
	IntentsClient (IntentsClient const &)=default
IntentsClient &	operator= (IntentsClient const &)=default
	IntentsClient (IntentsClient &&)=default
IntentsClient &	operator= (IntentsClient &&)=default

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

Detailed Description

Service for managing Intents.

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.

Constructor & Destructor Documentation

IntentsClient() [1/3]

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

explicit

~IntentsClient()

google::cloud::dialogflow_cx::IntentsClient::~IntentsClient

(

)

IntentsClient() [2/3]

google::cloud::dialogflow_cx::IntentsClient::IntentsClient ( IntentsClient const &  )

default

IntentsClient() [3/3]

google::cloud::dialogflow_cx::IntentsClient::IntentsClient ( IntentsClient &&  )

default

Member Function Documentation

CreateIntent() [1/2]

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

Creates an intent in the specified agent.

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

Parameters

request	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.cx.v3.CreateIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

CreateIntent() [2/2]

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

Creates an intent in the specified agent.

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

Parameters

parent	Required. The agent to create an intent for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
intent	Required. The intent to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

DeleteIntent() [1/2]

Status google::cloud::dialogflow_cx::IntentsClient::DeleteIntent	(	google::cloud::dialogflow::cx::v3::DeleteIntentRequest const &	request,
		Options	opts = {}
	)

Deletes the specified intent.

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

Parameters

request	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.cx.v3.DeleteIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

DeleteIntent() [2/2]

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

Deletes the specified intent.

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

Parameters

name	Required. The name of the intent to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

GetIntent() [1/2]

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

Retrieves the specified intent.

Parameters

request	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.cx.v3.GetIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

GetIntent() [2/2]

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

Retrieves the specified intent.

Parameters

name	Required. The name of the intent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

ListIntents() [1/2]

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

Returns the list of all intents in the specified agent.

Parameters

request	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.cx.v3.ListIntentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

ListIntents() [2/2]

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

Returns the list of all intents in the specified agent.

Parameters

parent	Required. The agent to list all intents for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

operator=() [1/2]

IntentsClient & google::cloud::dialogflow_cx::IntentsClient::operator= ( IntentsClient &&  )

default

operator=() [2/2]

IntentsClient & google::cloud::dialogflow_cx::IntentsClient::operator= ( IntentsClient const &  )

default

UpdateIntent() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Intent > google::cloud::dialogflow_cx::IntentsClient::UpdateIntent	(	google::cloud::dialogflow::cx::v3::Intent const &	intent,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates the specified intent.

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

Parameters

intent	Required. The intent to update.
update_mask	The mask to control which fields get updated. If the mask is not present, all fields will be updated.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

UpdateIntent() [2/2]

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

Updates the specified intent.

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

Parameters

request	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.cx.v3.UpdateIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

Friends And Related Function Documentation

operator!=

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

friend

operator==

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

friend