Dialogflow API C++ Client  2.2.1
A C++ Client Library for the Dialogflow API
Public Member Functions | Friends | List of all members
google::cloud::dialogflow_cx::PagesClient Class Reference

Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page]. More...

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

Public Member Functions

 PagesClient (std::shared_ptr< PagesConnection > connection, Options opts={})
 
 ~PagesClient ()
 
 PagesClient (PagesClient const &)=default
 
PagesClientoperator= (PagesClient const &)=default
 
 PagesClient (PagesClient &&)=default
 
PagesClientoperator= (PagesClient &&)=default
 
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...
 

Friends

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

Detailed Description

Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page].

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 61 of file pages_client.h.

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
requestgoogle::cloud::dialogflow::cx::v3::CreatePageRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Page

◆ 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
parentRequired. The flow to create a page for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
pageRequired. The page to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Page

◆ 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
requestgoogle::cloud::dialogflow::cx::v3::DeletePageRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ 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
nameRequired. The name of the page to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ 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
requestgoogle::cloud::dialogflow::cx::v3::GetPageRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Page

◆ 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
nameRequired. The name of the page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Page

◆ 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
requestgoogle::cloud::dialogflow::cx::v3::ListPagesRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Page

◆ 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
parentRequired. The flow to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Page

◆ 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
pageRequired. The page to update.
update_maskThe mask to control which fields get updated. If the mask is not present, all fields will be updated.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Page

◆ 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
requestgoogle::cloud::dialogflow::cx::v3::UpdatePageRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Page

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 80 of file pages_client.h.

◆ operator==

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

Definition at line 77 of file pages_client.h.