Class WebhooksClient (2.19.0)

Version 2.19.0

• 2.33.0-rc (latest)
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Service for managing Webhooks.

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

WebhooksClient(WebhooksClient const &)

Copy and move support

Parameter
Name	Description
	WebhooksClient const &

WebhooksClient(WebhooksClient &&)

Copy and move support

Parameter
Name	Description
	WebhooksClient &&

WebhooksClient(std::shared_ptr< WebhooksConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< WebhooksConnection >
opts	Options

Operators

operator=(WebhooksClient const &)

Copy and move support

Parameter
Name	Description
	WebhooksClient const &

Returns
Type	Description
WebhooksClient &

operator=(WebhooksClient &&)

Copy and move support

Parameter
Name	Description
	WebhooksClient &&

Returns
Type	Description
WebhooksClient &

Functions

ListWebhooks(std::string const &, Options)

Returns the list of all webhooks in the specified agent.

Parameters
Name	Description
parent	std::string const & Required. The agent to list all webhooks for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::Webhook >	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.Webhook, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListWebhooks(google::cloud::dialogflow::cx::v3::ListWebhooksRequest, Options)

Returns the list of all webhooks in the specified agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ListWebhooksRequest 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.ListWebhooksRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::Webhook >	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.Webhook, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetWebhook(std::string const &, Options)

Retrieves the specified webhook.

Parameters
Name	Description
name	std::string const & Required. The name of the webhook. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/webhooks/<Webhook ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Webhook) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetWebhook(google::cloud::dialogflow::cx::v3::GetWebhookRequest const &, Options)

Retrieves the specified webhook.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetWebhookRequest const & 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.GetWebhookRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Webhook) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateWebhook(std::string const &, google::cloud::dialogflow::cx::v3::Webhook const &, Options)

Creates a webhook in the specified agent.

Parameters
Name	Description
parent	std::string const & Required. The agent to create a webhook for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
webhook	google::cloud::dialogflow::cx::v3::Webhook const & Required. The webhook 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::Webhook >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Webhook) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateWebhook(google::cloud::dialogflow::cx::v3::CreateWebhookRequest const &, Options)

Creates a webhook in the specified agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::CreateWebhookRequest const & 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.CreateWebhookRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Webhook) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateWebhook(google::cloud::dialogflow::cx::v3::Webhook const &, google::protobuf::FieldMask const &, Options)

Updates the specified webhook.

Parameters
Name	Description
webhook	google::cloud::dialogflow::cx::v3::Webhook const & Required. The webhook 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::Webhook >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Webhook) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateWebhook(google::cloud::dialogflow::cx::v3::UpdateWebhookRequest const &, Options)

Updates the specified webhook.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::UpdateWebhookRequest const & 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.UpdateWebhookRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Webhook) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteWebhook(std::string const &, Options)

Deletes the specified webhook.

Parameters
Name	Description
name	std::string const & Required. The name of the webhook to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/webhooks/<Webhook ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteWebhook(google::cloud::dialogflow::cx::v3::DeleteWebhookRequest const &, Options)

Deletes the specified webhook.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::DeleteWebhookRequest const & 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.DeleteWebhookRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.