google::cloud::dialogflow_cx::TransitionRouteGroupsClient Class Reference

Service for managing TransitionRouteGroups. More...

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

Public Member Functions
	TransitionRouteGroupsClient (std::shared_ptr< TransitionRouteGroupsConnection > connection, Options opts={})
	~TransitionRouteGroupsClient ()
StreamRange< google::cloud::dialogflow::cx::v3::TransitionRouteGroup >	ListTransitionRouteGroups (std::string const &parent, Options opts={})
	Returns the list of all transition route groups in the specified flow. More...
StreamRange< google::cloud::dialogflow::cx::v3::TransitionRouteGroup >	ListTransitionRouteGroups (google::cloud::dialogflow::cx::v3::ListTransitionRouteGroupsRequest request, Options opts={})
	Returns the list of all transition route groups in the specified flow. More...
StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup >	GetTransitionRouteGroup (std::string const &name, Options opts={})
	Retrieves the specified TransitionRouteGroup. More...
StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup >	GetTransitionRouteGroup (google::cloud::dialogflow::cx::v3::GetTransitionRouteGroupRequest const &request, Options opts={})
	Retrieves the specified TransitionRouteGroup. More...
StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup >	CreateTransitionRouteGroup (std::string const &parent, google::cloud::dialogflow::cx::v3::TransitionRouteGroup const &transition_route_group, Options opts={})
	Creates an TransitionRouteGroup in the specified flow. More...
StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup >	CreateTransitionRouteGroup (google::cloud::dialogflow::cx::v3::CreateTransitionRouteGroupRequest const &request, Options opts={})
	Creates an TransitionRouteGroup in the specified flow. More...
StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup >	UpdateTransitionRouteGroup (google::cloud::dialogflow::cx::v3::TransitionRouteGroup const &transition_route_group, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified TransitionRouteGroup. More...
StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup >	UpdateTransitionRouteGroup (google::cloud::dialogflow::cx::v3::UpdateTransitionRouteGroupRequest const &request, Options opts={})
	Updates the specified TransitionRouteGroup. More...
Status	DeleteTransitionRouteGroup (std::string const &name, Options opts={})
	Deletes the specified TransitionRouteGroup. More...
Status	DeleteTransitionRouteGroup (google::cloud::dialogflow::cx::v3::DeleteTransitionRouteGroupRequest const &request, Options opts={})
	Deletes the specified TransitionRouteGroup. More...
Copy and move support
	TransitionRouteGroupsClient (TransitionRouteGroupsClient const &)=default
TransitionRouteGroupsClient &	operator= (TransitionRouteGroupsClient const &)=default
	TransitionRouteGroupsClient (TransitionRouteGroupsClient &&)=default
TransitionRouteGroupsClient &	operator= (TransitionRouteGroupsClient &&)=default

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

Detailed Description

Service for managing TransitionRouteGroups.

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

TransitionRouteGroupsClient() [1/3]

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

explicit

~TransitionRouteGroupsClient()

google::cloud::dialogflow_cx::TransitionRouteGroupsClient::~TransitionRouteGroupsClient

(

)

TransitionRouteGroupsClient() [2/3]

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

default

TransitionRouteGroupsClient() [3/3]

google::cloud::dialogflow_cx::TransitionRouteGroupsClient::TransitionRouteGroupsClient ( TransitionRouteGroupsClient &&  )

default

Member Function Documentation

CreateTransitionRouteGroup() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup > google::cloud::dialogflow_cx::TransitionRouteGroupsClient::CreateTransitionRouteGroup	(	google::cloud::dialogflow::cx::v3::CreateTransitionRouteGroupRequest const &	request,
		Options	opts = {}
	)

Creates an TransitionRouteGroup in the specified flow.

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

CreateTransitionRouteGroup() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup > google::cloud::dialogflow_cx::TransitionRouteGroupsClient::CreateTransitionRouteGroup	(	std::string const &	parent,
		google::cloud::dialogflow::cx::v3::TransitionRouteGroup const &	transition_route_group,
		Options	opts = {}
	)

Creates an TransitionRouteGroup in the specified flow.

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

Parameters

parent	Required. The flow to create an TransitionRouteGroup for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
transition_route_group	Required. The transition route group 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.TransitionRouteGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteTransitionRouteGroup() [1/2]

Status google::cloud::dialogflow_cx::TransitionRouteGroupsClient::DeleteTransitionRouteGroup	(	google::cloud::dialogflow::cx::v3::DeleteTransitionRouteGroupRequest const &	request,
		Options	opts = {}
	)

Deletes the specified TransitionRouteGroup.

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.DeleteTransitionRouteGroupRequest. 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.

DeleteTransitionRouteGroup() [2/2]

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

Deletes the specified TransitionRouteGroup.

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

Parameters

name	Required. The name of the TransitionRouteGroup to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group 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.

GetTransitionRouteGroup() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup > google::cloud::dialogflow_cx::TransitionRouteGroupsClient::GetTransitionRouteGroup	(	google::cloud::dialogflow::cx::v3::GetTransitionRouteGroupRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified TransitionRouteGroup.

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

GetTransitionRouteGroup() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup > google::cloud::dialogflow_cx::TransitionRouteGroupsClient::GetTransitionRouteGroup	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified TransitionRouteGroup.

Parameters

name	Required. The name of the TransitionRouteGroup. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group 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.TransitionRouteGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListTransitionRouteGroups() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::TransitionRouteGroup > google::cloud::dialogflow_cx::TransitionRouteGroupsClient::ListTransitionRouteGroups	(	google::cloud::dialogflow::cx::v3::ListTransitionRouteGroupsRequest	request,
		Options	opts = {}
	)

Returns the list of all transition route groups in the specified flow.

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

ListTransitionRouteGroups() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::TransitionRouteGroup > google::cloud::dialogflow_cx::TransitionRouteGroupsClient::ListTransitionRouteGroups	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all transition route groups in the specified flow.

Parameters

parent	Required. The flow to list all transition route groups for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow 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.TransitionRouteGroup, 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]

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

default

operator=() [2/2]

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

default

UpdateTransitionRouteGroup() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup > google::cloud::dialogflow_cx::TransitionRouteGroupsClient::UpdateTransitionRouteGroup	(	google::cloud::dialogflow::cx::v3::TransitionRouteGroup const &	transition_route_group,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates the specified TransitionRouteGroup.

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

Parameters

transition_route_group	Required. The transition route group to update.
update_mask	The mask to control which fields get 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.TransitionRouteGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTransitionRouteGroup() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::TransitionRouteGroup > google::cloud::dialogflow_cx::TransitionRouteGroupsClient::UpdateTransitionRouteGroup	(	google::cloud::dialogflow::cx::v3::UpdateTransitionRouteGroupRequest const &	request,
		Options	opts = {}
	)

Updates the specified TransitionRouteGroup.

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.UpdateTransitionRouteGroupRequest. 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.TransitionRouteGroup) 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!= ( TransitionRouteGroupsClient const &  a, TransitionRouteGroupsClient const &  b  )

friend

operator==

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

friend