google::cloud::dialogflow_es::AgentsClient Class Reference

Service for managing Agents. More...

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

Public Member Functions
	AgentsClient (std::shared_ptr< AgentsConnection > connection, Options opts={})
	~AgentsClient ()
StatusOr< google::cloud::dialogflow::v2::Agent >	GetAgent (std::string const &parent, Options opts={})
	Retrieves the specified agent. More...
StatusOr< google::cloud::dialogflow::v2::Agent >	GetAgent (google::cloud::dialogflow::v2::GetAgentRequest const &request, Options opts={})
	Retrieves the specified agent. More...
StatusOr< google::cloud::dialogflow::v2::Agent >	SetAgent (google::cloud::dialogflow::v2::Agent const &agent, Options opts={})
	Creates/updates the specified agent. More...
StatusOr< google::cloud::dialogflow::v2::Agent >	SetAgent (google::cloud::dialogflow::v2::SetAgentRequest const &request, Options opts={})
	Creates/updates the specified agent. More...
Status	DeleteAgent (std::string const &parent, Options opts={})
	Deletes the specified agent. More...
Status	DeleteAgent (google::cloud::dialogflow::v2::DeleteAgentRequest const &request, Options opts={})
	Deletes the specified agent. More...
StreamRange< google::cloud::dialogflow::v2::Agent >	SearchAgents (std::string const &parent, Options opts={})
	Returns the list of agents. More...
StreamRange< google::cloud::dialogflow::v2::Agent >	SearchAgents (google::cloud::dialogflow::v2::SearchAgentsRequest request, Options opts={})
	Returns the list of agents. More...
future< StatusOr< google::protobuf::Struct > >	TrainAgent (std::string const &parent, Options opts={})
	Trains the specified agent. More...
future< StatusOr< google::protobuf::Struct > >	TrainAgent (google::cloud::dialogflow::v2::TrainAgentRequest const &request, Options opts={})
	Trains the specified agent. More...
future< StatusOr< google::cloud::dialogflow::v2::ExportAgentResponse > >	ExportAgent (std::string const &parent, Options opts={})
	Exports the specified agent to a ZIP file. More...
future< StatusOr< google::cloud::dialogflow::v2::ExportAgentResponse > >	ExportAgent (google::cloud::dialogflow::v2::ExportAgentRequest const &request, Options opts={})
	Exports the specified agent to a ZIP file. More...
future< StatusOr< google::protobuf::Struct > >	ImportAgent (google::cloud::dialogflow::v2::ImportAgentRequest const &request, Options opts={})
	Imports the specified agent from a ZIP file. More...
future< StatusOr< google::protobuf::Struct > >	RestoreAgent (google::cloud::dialogflow::v2::RestoreAgentRequest const &request, Options opts={})
	Restores the specified agent from a ZIP file. More...
StatusOr< google::cloud::dialogflow::v2::ValidationResult >	GetValidationResult (google::cloud::dialogflow::v2::GetValidationResultRequest const &request, Options opts={})
	Gets agent validation result. More...
Copy and move support
	AgentsClient (AgentsClient const &)=default
AgentsClient &	operator= (AgentsClient const &)=default
	AgentsClient (AgentsClient &&)=default
AgentsClient &	operator= (AgentsClient &&)=default

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

Detailed Description

Service for managing Agents.

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

AgentsClient() [1/3]

google::cloud::dialogflow_es::AgentsClient::AgentsClient ( std::shared_ptr< AgentsConnection >  connection, Options  opts = {}  )

explicit

~AgentsClient()

google::cloud::dialogflow_es::AgentsClient::~AgentsClient

(

)

AgentsClient() [2/3]

google::cloud::dialogflow_es::AgentsClient::AgentsClient ( AgentsClient const &  )

default

AgentsClient() [3/3]

google::cloud::dialogflow_es::AgentsClient::AgentsClient ( AgentsClient &&  )

default

Member Function Documentation

DeleteAgent() [1/2]

Status google::cloud::dialogflow_es::AgentsClient::DeleteAgent	(	google::cloud::dialogflow::v2::DeleteAgentRequest const &	request,
		Options	opts = {}
	)

Deletes 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.v2.DeleteAgentRequest. 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.

DeleteAgent() [2/2]

Status google::cloud::dialogflow_es::AgentsClient::DeleteAgent	(	std::string const &	parent,
		Options	opts = {}
	)

Deletes the specified agent.

Parameters

parent	Required. The project that the agent to delete is associated with. Format: projects/<Project 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.

ExportAgent() [1/2]

future< StatusOr< google::cloud::dialogflow::v2::ExportAgentResponse > > google::cloud::dialogflow_es::AgentsClient::ExportAgent	(	google::cloud::dialogflow::v2::ExportAgentRequest const &	request,
		Options	opts = {}
	)

Exports the specified agent to a ZIP file.

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

• metadata: An empty Struct message
• response: ExportAgentResponse

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.v2.ExportAgentRequest. 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 `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.ExportAgentResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportAgent() [2/2]

future< StatusOr< google::cloud::dialogflow::v2::ExportAgentResponse > > google::cloud::dialogflow_es::AgentsClient::ExportAgent	(	std::string const &	parent,
		Options	opts = {}
	)

Exports the specified agent to a ZIP file.

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

• metadata: An empty Struct message
• response: ExportAgentResponse

Parameters

parent	Required. The project that the agent to export is associated with. Format: projects/<Project ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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.ExportAgentResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetAgent() [1/2]

StatusOr< google::cloud::dialogflow::v2::Agent > google::cloud::dialogflow_es::AgentsClient::GetAgent	(	google::cloud::dialogflow::v2::GetAgentRequest const &	request,
		Options	opts = {}
	)

Retrieves 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.v2.GetAgentRequest. 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.v2.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetAgent() [2/2]

StatusOr< google::cloud::dialogflow::v2::Agent > google::cloud::dialogflow_es::AgentsClient::GetAgent	(	std::string const &	parent,
		Options	opts = {}
	)

Retrieves the specified agent.

Parameters

parent	Required. The project that the agent to fetch is associated with. Format: projects/<Project 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.v2.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetValidationResult()

StatusOr< google::cloud::dialogflow::v2::ValidationResult > google::cloud::dialogflow_es::AgentsClient::GetValidationResult	(	google::cloud::dialogflow::v2::GetValidationResultRequest const &	request,
		Options	opts = {}
	)

Gets agent validation result.

Agent validation is performed during training time and is updated automatically when training is completed.

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.v2.GetValidationResultRequest. 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.v2.ValidationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ImportAgent()

future< StatusOr< google::protobuf::Struct > > google::cloud::dialogflow_es::AgentsClient::ImportAgent	(	google::cloud::dialogflow::v2::ImportAgentRequest const &	request,
		Options	opts = {}
	)

Imports the specified agent from a ZIP file.

Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

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

• metadata: An empty Struct message
• response: An Empty message

The operation only tracks when importing is complete, not when it is done training.

Note: You should always train an agent 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.v2.ImportAgentRequest. 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 `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.

operator=() [1/2]

AgentsClient & google::cloud::dialogflow_es::AgentsClient::operator= ( AgentsClient &&  )

default

operator=() [2/2]

AgentsClient & google::cloud::dialogflow_es::AgentsClient::operator= ( AgentsClient const &  )

default

RestoreAgent()

future< StatusOr< google::protobuf::Struct > > google::cloud::dialogflow_es::AgentsClient::RestoreAgent	(	google::cloud::dialogflow::v2::RestoreAgentRequest const &	request,
		Options	opts = {}
	)

Restores the specified agent from a ZIP file.

Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

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

• metadata: An empty Struct message
• response: An Empty message

The operation only tracks when restoring is complete, not when it is done training.

Note: You should always train an agent 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.v2.RestoreAgentRequest. 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 `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.

SearchAgents() [1/2]

StreamRange< google::cloud::dialogflow::v2::Agent > google::cloud::dialogflow_es::AgentsClient::SearchAgents	(	google::cloud::dialogflow::v2::SearchAgentsRequest	request,
		Options	opts = {}
	)

Returns the list of agents.

Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

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

SearchAgents() [2/2]

StreamRange< google::cloud::dialogflow::v2::Agent > google::cloud::dialogflow_es::AgentsClient::SearchAgents	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of agents.

Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Parameters

parent	Required. The project to list agents from. Format: projects/<Project ID or '-'>.
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.v2.Agent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SetAgent() [1/2]

StatusOr< google::cloud::dialogflow::v2::Agent > google::cloud::dialogflow_es::AgentsClient::SetAgent	(	google::cloud::dialogflow::v2::Agent const &	agent,
		Options	opts = {}
	)

Creates/updates the specified agent.

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

Parameters

agent	Required. The agent to update.
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.v2.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetAgent() [2/2]

StatusOr< google::cloud::dialogflow::v2::Agent > google::cloud::dialogflow_es::AgentsClient::SetAgent	(	google::cloud::dialogflow::v2::SetAgentRequest const &	request,
		Options	opts = {}
	)

Creates/updates the specified agent.

Note: You should always train an agent 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.v2.SetAgentRequest. 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.v2.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

TrainAgent() [1/2]

future< StatusOr< google::protobuf::Struct > > google::cloud::dialogflow_es::AgentsClient::TrainAgent	(	google::cloud::dialogflow::v2::TrainAgentRequest const &	request,
		Options	opts = {}
	)

Trains the specified agent.

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

• metadata: An empty Struct message
• response: An Empty message

Note: You should always train an agent 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.v2.TrainAgentRequest. 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 `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.

TrainAgent() [2/2]

future< StatusOr< google::protobuf::Struct > > google::cloud::dialogflow_es::AgentsClient::TrainAgent	(	std::string const &	parent,
		Options	opts = {}
	)

Trains the specified agent.

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

• metadata: An empty Struct message
• response: An Empty message

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

Parameters

parent	Required. The project that the agent to train is associated with. Format: projects/<Project ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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.

Friends And Related Function Documentation

operator!=

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

friend

operator==

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

friend