google::cloud::dialogflow_cx::WebhooksClient Class Reference

Service for managing Webhooks. More...

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

Public Member Functions
	WebhooksClient (std::shared_ptr< WebhooksConnection > connection, Options opts={})
	~WebhooksClient ()
StreamRange< google::cloud::dialogflow::cx::v3::Webhook >	ListWebhooks (std::string const &parent, Options opts={})
	Returns the list of all webhooks in the specified agent. More...
StreamRange< google::cloud::dialogflow::cx::v3::Webhook >	ListWebhooks (google::cloud::dialogflow::cx::v3::ListWebhooksRequest request, Options opts={})
	Returns the list of all webhooks in the specified agent. More...
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	GetWebhook (std::string const &name, Options opts={})
	Retrieves the specified webhook. More...
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	GetWebhook (google::cloud::dialogflow::cx::v3::GetWebhookRequest const &request, Options opts={})
	Retrieves the specified webhook. More...
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	CreateWebhook (std::string const &parent, google::cloud::dialogflow::cx::v3::Webhook const &webhook, Options opts={})
	Creates a webhook in the specified agent. More...
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	CreateWebhook (google::cloud::dialogflow::cx::v3::CreateWebhookRequest const &request, Options opts={})
	Creates a webhook in the specified agent. More...
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	UpdateWebhook (google::cloud::dialogflow::cx::v3::Webhook const &webhook, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified webhook. More...
StatusOr< google::cloud::dialogflow::cx::v3::Webhook >	UpdateWebhook (google::cloud::dialogflow::cx::v3::UpdateWebhookRequest const &request, Options opts={})
	Updates the specified webhook. More...
Status	DeleteWebhook (std::string const &name, Options opts={})
	Deletes the specified webhook. More...
Status	DeleteWebhook (google::cloud::dialogflow::cx::v3::DeleteWebhookRequest const &request, Options opts={})
	Deletes the specified webhook. More...
Copy and move support
	WebhooksClient (WebhooksClient const &)=default
WebhooksClient &	operator= (WebhooksClient const &)=default
	WebhooksClient (WebhooksClient &&)=default
WebhooksClient &	operator= (WebhooksClient &&)=default

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

Detailed Description

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.

Constructor & Destructor Documentation

WebhooksClient() [1/3]

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

explicit

~WebhooksClient()

google::cloud::dialogflow_cx::WebhooksClient::~WebhooksClient

(

)

WebhooksClient() [2/3]

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

default

WebhooksClient() [3/3]

google::cloud::dialogflow_cx::WebhooksClient::WebhooksClient ( WebhooksClient &&  )

default

Member Function Documentation

CreateWebhook() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Webhook > google::cloud::dialogflow_cx::WebhooksClient::CreateWebhook	(	google::cloud::dialogflow::cx::v3::CreateWebhookRequest const &	request,
		Options	opts = {}
	)

Creates a webhook in the specified agent.

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

CreateWebhook() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Webhook > google::cloud::dialogflow_cx::WebhooksClient::CreateWebhook	(	std::string const &	parent,
		google::cloud::dialogflow::cx::v3::Webhook const &	webhook,
		Options	opts = {}
	)

Creates a webhook in the specified agent.

Parameters

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

DeleteWebhook() [1/2]

Status google::cloud::dialogflow_cx::WebhooksClient::DeleteWebhook	(	google::cloud::dialogflow::cx::v3::DeleteWebhookRequest const &	request,
		Options	opts = {}
	)

Deletes the specified webhook.

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

DeleteWebhook() [2/2]

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

Deletes the specified webhook.

Parameters

name	Required. The name of the webhook to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook 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.

GetWebhook() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Webhook > google::cloud::dialogflow_cx::WebhooksClient::GetWebhook	(	google::cloud::dialogflow::cx::v3::GetWebhookRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified webhook.

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

GetWebhook() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Webhook > google::cloud::dialogflow_cx::WebhooksClient::GetWebhook	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified webhook.

Parameters

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

ListWebhooks() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::Webhook > google::cloud::dialogflow_cx::WebhooksClient::ListWebhooks	(	google::cloud::dialogflow::cx::v3::ListWebhooksRequest	request,
		Options	opts = {}
	)

Returns the list of all webhooks in the specified agent.

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.ListWebhooksRequest. 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.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() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::Webhook > google::cloud::dialogflow_cx::WebhooksClient::ListWebhooks	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all webhooks in the specified agent.

Parameters

parent	Required. The agent to list all webhooks for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent 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.Webhook, 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]

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

default

operator=() [2/2]

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

default

UpdateWebhook() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Webhook > google::cloud::dialogflow_cx::WebhooksClient::UpdateWebhook	(	google::cloud::dialogflow::cx::v3::UpdateWebhookRequest const &	request,
		Options	opts = {}
	)

Updates the specified webhook.

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

UpdateWebhook() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Webhook > google::cloud::dialogflow_cx::WebhooksClient::UpdateWebhook	(	google::cloud::dialogflow::cx::v3::Webhook const &	webhook,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates the specified webhook.

Parameters

webhook	Required. The webhook 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.Webhook) 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!= ( WebhooksClient const &  a, WebhooksClient const &  b  )

friend

operator==

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

friend