Class WebhooksClient (0.8.0)

WebhooksClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.services.webhooks.transports.base.WebhooksTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing [Webhooks][google.cloud.dialogflow.cx.v3beta1.Webhook].

Inheritance

builtins.object > WebhooksClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
WebhooksTransportThe transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project
location

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project

create_webhook

create_webhook(request: Optional[google.cloud.dialogflowcx_v3beta1.types.webhook.CreateWebhookRequest] = None, *, parent: Optional[str] = None, webhook: Optional[google.cloud.dialogflowcx_v3beta1.types.webhook.Webhook] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a webhook in the specified agent.

Parameter
NameDescription
request google.cloud.dialogflowcx_v3beta1.types.CreateWebhookRequest

The request object. The request message for [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.CreateWebhook].

Returns
TypeDescription
google.cloud.dialogflowcx_v3beta1.types.WebhookWebhooks 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.

delete_webhook

delete_webhook(request: Optional[google.cloud.dialogflowcx_v3beta1.types.webhook.DeleteWebhookRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified webhook.

Parameter
NameDescription
request google.cloud.dialogflowcx_v3beta1.types.DeleteWebhookRequest

The request object. The request message for [Webhooks.DeleteWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.DeleteWebhook].

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
WebhooksClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
WebhooksClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
WebhooksClientThe constructed client.

get_webhook

get_webhook(request: Optional[google.cloud.dialogflowcx_v3beta1.types.webhook.GetWebhookRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified webhook.

Parameter
NameDescription
request google.cloud.dialogflowcx_v3beta1.types.GetWebhookRequest

The request object. The request message for [Webhooks.GetWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.GetWebhook].

Returns
TypeDescription
google.cloud.dialogflowcx_v3beta1.types.WebhookWebhooks 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.

list_webhooks

list_webhooks(request: Optional[google.cloud.dialogflowcx_v3beta1.types.webhook.ListWebhooksRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all webhooks in the specified agent.

Parameter
NameDescription
request google.cloud.dialogflowcx_v3beta1.types.ListWebhooksRequest

The request object. The request message for [Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3beta1.Webhooks.ListWebhooks].

Returns
TypeDescription
google.cloud.dialogflowcx_v3beta1.services.webhooks.pagers.ListWebhooksPagerThe response message for [Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3beta1.Webhooks.ListWebhooks]. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path

parse_service_path

parse_service_path(path: str)

Parses a service path into its component segments.

Parameter
NameDescription
path

parse_webhook_path

parse_webhook_path(path: str)

Parses a webhook path into its component segments.

Parameter
NameDescription
path

service_path

service_path(project: str, location: str, namespace: str, service: str)

Returns a fully-qualified service string.

Parameters
NameDescription
project
location
namespace
service

update_webhook

update_webhook(request: Optional[google.cloud.dialogflowcx_v3beta1.types.webhook.UpdateWebhookRequest] = None, *, webhook: Optional[google.cloud.dialogflowcx_v3beta1.types.webhook.Webhook] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified webhook.

Parameter
NameDescription
request google.cloud.dialogflowcx_v3beta1.types.UpdateWebhookRequest

The request object. The request message for [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.UpdateWebhook].

Returns
TypeDescription
google.cloud.dialogflowcx_v3beta1.types.WebhookWebhooks 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.

webhook_path

webhook_path(project: str, location: str, agent: str, webhook: str)

Returns a fully-qualified webhook string.

Parameters
NameDescription
project
location
agent
webhook