def create_webhook(
self,
request: gcdc_webhook.CreateWebhookRequest = None,
*,
parent: str = None,
webhook: gcdc_webhook.Webhook = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcdc_webhook.Webhook:
r"""Creates a webhook in the specified agent.
Args:
request (google.cloud.dialogflowcx_v3.types.CreateWebhookRequest):
The request object. The request message for
[Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook].
parent (str):
Required. The agent to create a webhook for. Format:
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
webhook (google.cloud.dialogflowcx_v3.types.Webhook):
Required. The webhook to create.
This corresponds to the ``webhook`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.dialogflowcx_v3.types.Webhook:
Webhooks host the developer's
business logic. During a session,
webhooks allow the developer to use the
data extracted by Dialogflow's natural
language processing to generate dynamic
responses, validate collected data, or
trigger actions on the backend.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([parent, webhook])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a gcdc_webhook.CreateWebhookRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, gcdc_webhook.CreateWebhookRequest):
request = gcdc_webhook.CreateWebhookRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if webhook is not None:
request.webhook = webhook
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.create_webhook]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
async def create_webhook(
self,
request: Union[gcdc_webhook.CreateWebhookRequest, dict] = None,
*,
parent: str = None,
webhook: gcdc_webhook.Webhook = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcdc_webhook.Webhook:
r"""Creates a webhook in the specified agent.
.. code-block::
from google.cloud import dialogflowcx_v3
def sample_create_webhook():
# Create a client
client = dialogflowcx_v3.WebhooksClient()
# Initialize request argument(s)
webhook = dialogflowcx_v3.Webhook()
webhook.generic_web_service.uri = "uri_value"
webhook.display_name = "display_name_value"
request = dialogflowcx_v3.CreateWebhookRequest(
parent="parent_value",
webhook=webhook,
)
# Make the request
response = client.create_webhook(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.dialogflowcx_v3.types.CreateWebhookRequest, dict]):
The request object. The request message for
[Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook].
parent (:class:`str`):
Required. The agent to create a webhook for. Format:
``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
webhook (:class:`google.cloud.dialogflowcx_v3.types.Webhook`):
Required. The webhook to create.
This corresponds to the ``webhook`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.dialogflowcx_v3.types.Webhook:
Webhooks host the developer's
business logic. During a session,
webhooks allow the developer to use the
data extracted by Dialogflow's natural
language processing to generate dynamic
responses, validate collected data, or
trigger actions on the backend.
"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([parent, webhook])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = gcdc_webhook.CreateWebhookRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if webhook is not None:
request.webhook = webhook
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.create_webhook,
default_timeout=None,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("parent", request.parent), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response