google::cloud::dialogflow_cx::PagesClient Class Reference

Service for managing Pages. More...

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

Public Member Functions
	PagesClient (std::shared_ptr< PagesConnection > connection, Options opts={})
	~PagesClient ()
StreamRange< google::cloud::dialogflow::cx::v3::Page >	ListPages (std::string const &parent, Options opts={})
	Returns the list of all pages in the specified flow. More...
StreamRange< google::cloud::dialogflow::cx::v3::Page >	ListPages (google::cloud::dialogflow::cx::v3::ListPagesRequest request, Options opts={})
	Returns the list of all pages in the specified flow. More...
StatusOr< google::cloud::dialogflow::cx::v3::Page >	GetPage (std::string const &name, Options opts={})
	Retrieves the specified page. More...
StatusOr< google::cloud::dialogflow::cx::v3::Page >	GetPage (google::cloud::dialogflow::cx::v3::GetPageRequest const &request, Options opts={})
	Retrieves the specified page. More...
StatusOr< google::cloud::dialogflow::cx::v3::Page >	CreatePage (std::string const &parent, google::cloud::dialogflow::cx::v3::Page const &page, Options opts={})
	Creates a page in the specified flow. More...
StatusOr< google::cloud::dialogflow::cx::v3::Page >	CreatePage (google::cloud::dialogflow::cx::v3::CreatePageRequest const &request, Options opts={})
	Creates a page in the specified flow. More...
StatusOr< google::cloud::dialogflow::cx::v3::Page >	UpdatePage (google::cloud::dialogflow::cx::v3::Page const &page, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified page. More...
StatusOr< google::cloud::dialogflow::cx::v3::Page >	UpdatePage (google::cloud::dialogflow::cx::v3::UpdatePageRequest const &request, Options opts={})
	Updates the specified page. More...
Status	DeletePage (std::string const &name, Options opts={})
	Deletes the specified page. More...
Status	DeletePage (google::cloud::dialogflow::cx::v3::DeletePageRequest const &request, Options opts={})
	Deletes the specified page. More...
Copy and move support
	PagesClient (PagesClient const &)=default
PagesClient &	operator= (PagesClient const &)=default
	PagesClient (PagesClient &&)=default
PagesClient &	operator= (PagesClient &&)=default

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

Detailed Description

Service for managing Pages.

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

PagesClient() [1/3]

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

explicit

~PagesClient()

google::cloud::dialogflow_cx::PagesClient::~PagesClient

(

)

PagesClient() [2/3]

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

default

PagesClient() [3/3]

google::cloud::dialogflow_cx::PagesClient::PagesClient ( PagesClient &&  )

default

Member Function Documentation

CreatePage() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Page > google::cloud::dialogflow_cx::PagesClient::CreatePage	(	google::cloud::dialogflow::cx::v3::CreatePageRequest const &	request,
		Options	opts = {}
	)

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

CreatePage() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Page > google::cloud::dialogflow_cx::PagesClient::CreatePage	(	std::string const &	parent,
		google::cloud::dialogflow::cx::v3::Page const &	page,
		Options	opts = {}
	)

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

DeletePage() [1/2]

Status google::cloud::dialogflow_cx::PagesClient::DeletePage	(	google::cloud::dialogflow::cx::v3::DeletePageRequest const &	request,
		Options	opts = {}
	)

Deletes the specified page.

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

DeletePage() [2/2]

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

Deletes the specified page.

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

Parameters

name	Required. The name of the page to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page 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.

GetPage() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Page > google::cloud::dialogflow_cx::PagesClient::GetPage	(	google::cloud::dialogflow::cx::v3::GetPageRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified page.

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

GetPage() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Page > google::cloud::dialogflow_cx::PagesClient::GetPage	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified page.

Parameters

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

ListPages() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::Page > google::cloud::dialogflow_cx::PagesClient::ListPages	(	google::cloud::dialogflow::cx::v3::ListPagesRequest	request,
		Options	opts = {}
	)

Returns the list of all pages 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.ListPagesRequest. 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.Page, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPages() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::Page > google::cloud::dialogflow_cx::PagesClient::ListPages	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all pages in the specified flow.

Parameters

parent	Required. The flow to list all pages 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.Page, 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]

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

default

operator=() [2/2]

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

default

UpdatePage() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Page > google::cloud::dialogflow_cx::PagesClient::UpdatePage	(	google::cloud::dialogflow::cx::v3::Page const &	page,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates the specified page.

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

Parameters

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

UpdatePage() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Page > google::cloud::dialogflow_cx::PagesClient::UpdatePage	(	google::cloud::dialogflow::cx::v3::UpdatePageRequest const &	request,
		Options	opts = {}
	)

Updates the specified page.

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.UpdatePageRequest. 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.Page) 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!= ( PagesClient const &  a, PagesClient const &  b  )

friend

operator==

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

friend