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.
Constructors
PagesClient(PagesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PagesClient const &
|
PagesClient(PagesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PagesClient &&
|
PagesClient(std::shared_ptr< PagesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< PagesConnection >
|
opts |
Options
|
Operators
operator=(PagesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PagesClient const &
|
Returns | |
---|---|
Type | Description |
PagesClient & |
operator=(PagesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
PagesClient &&
|
Returns | |
---|---|
Type | Description |
PagesClient & |
Functions
ListPages(std::string const &, Options)
Returns the list of all pages in the specified flow.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The flow to list all pages for. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::cx::v3::Page > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListPages(google::cloud::dialogflow::cx::v3::ListPagesRequest, Options)
Returns the list of all pages in the specified flow.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::ListPagesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::cx::v3::Page > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetPage(std::string const &, Options)
Retrieves the specified page.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the page. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Page > |
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 |
GetPage(google::cloud::dialogflow::cx::v3::GetPageRequest const &, Options)
Retrieves the specified page.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::GetPageRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Page > |
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 |
CreatePage(std::string const &, google::cloud::dialogflow::cx::v3::Page const &, Options)
Creates a page in the specified flow.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The flow to create a page for. Format: |
page |
google::cloud::dialogflow::cx::v3::Page const &
Required. The page to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Page > |
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 |
CreatePage(google::cloud::dialogflow::cx::v3::CreatePageRequest const &, Options)
Creates a page in the specified flow.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::CreatePageRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Page > |
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 |
UpdatePage(google::cloud::dialogflow::cx::v3::Page const &, google::protobuf::FieldMask const &, Options)
Updates the specified page.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
page |
google::cloud::dialogflow::cx::v3::Page const &
Required. The page to update. |
update_mask |
google::protobuf::FieldMask const &
The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Page > |
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 |
UpdatePage(google::cloud::dialogflow::cx::v3::UpdatePageRequest const &, Options)
Updates the specified page.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::UpdatePageRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Page > |
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 |
DeletePage(std::string const &, Options)
Deletes the specified page.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the page to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeletePage(google::cloud::dialogflow::cx::v3::DeletePageRequest const &, Options)
Deletes the specified page.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::DeletePageRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |