- 1.37.0 (latest)
- 1.36.0
- 1.35.0
- 1.34.1
- 1.33.0
- 1.32.1
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.1
- 1.22.0
- 1.21.0
- 1.20.1
- 1.19.0
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.0
- 1.14.1
- 1.13.5
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.1
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.2
- 1.2.0
- 1.1.1
- 1.0.0
- 0.8.2
- 0.7.1
- 0.6.0
- 0.5.0
- 0.4.1
- 0.3.0
- 0.2.0
- 0.1.1
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 > WebhooksClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
WebhooksTransport | The 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.
Name | Description |
billing_account |
|
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
Name | Description |
folder |
|
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
Name | Description |
project |
|
location |
|
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
Name | Description |
organization |
|
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
Name | Description |
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.
Name | Description |
request |
google.cloud.dialogflowcx_v3beta1.types.CreateWebhookRequest
The request object. The request message for [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.CreateWebhook]. |
Type | Description |
google.cloud.dialogflowcx_v3beta1.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. |
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.
Name | Description |
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.
Name | Description |
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. |
Type | Description |
WebhooksClient | The 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.
Name | Description |
info |
dict
The service account private key info. |
args |
Additional arguments to pass to the constructor. |
kwargs |
Additional arguments to pass to the constructor. |
Type | Description |
WebhooksClient | The 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.
Name | Description |
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. |
Type | Description |
WebhooksClient | The 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.
Name | Description |
request |
google.cloud.dialogflowcx_v3beta1.types.GetWebhookRequest
The request object. The request message for [Webhooks.GetWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.GetWebhook]. |
Type | Description |
google.cloud.dialogflowcx_v3beta1.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. |
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.
Name | Description |
request |
google.cloud.dialogflowcx_v3beta1.types.ListWebhooksRequest
The request object. The request message for [Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3beta1.Webhooks.ListWebhooks]. |
Type | Description |
google.cloud.dialogflowcx_v3beta1.services.webhooks.pagers.ListWebhooksPager | The 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.
Name | Description |
path |
|
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
Name | Description |
path |
|
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
Name | Description |
path |
|
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
Name | Description |
path |
|
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
Name | Description |
path |
|
parse_service_path
parse_service_path(path: str)
Parses a service path into its component segments.
Name | Description |
path |
|
parse_webhook_path
parse_webhook_path(path: str)
Parses a webhook path into its component segments.
Name | Description |
path |
|
service_path
service_path(project: str, location: str, namespace: str, service: str)
Returns a fully-qualified service string.
Name | Description |
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.
Name | Description |
request |
google.cloud.dialogflowcx_v3beta1.types.UpdateWebhookRequest
The request object. The request message for [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.UpdateWebhook]. |
Type | Description |
google.cloud.dialogflowcx_v3beta1.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. |
webhook_path
webhook_path(project: str, location: str, agent: str, webhook: str)
Returns a fully-qualified webhook string.
Name | Description |
project |
|
location |
|
agent |
|
webhook |
|