- 1.36.0 (latest)
- 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.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
WebhooksTransport | The transport used by the client instance. |
Methods
WebhooksClient
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>)
Instantiates the webhooks client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, WebhooksTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_webhook
create_webhook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.webhook.CreateWebhookRequest, dict]] = None, *, parent: Optional[str] = None, webhook: Optional[google.cloud.dialogflowcx_v3beta1.types.webhook.Webhook] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.CreateWebhookRequest, dict]
The request object. The request message for Webhooks.CreateWebhook. |
parent |
str
Required. The agent to create a webhook for. Format: |
webhook |
google.cloud.dialogflowcx_v3beta1.types.Webhook
Required. The webhook to create. This corresponds to the |
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 | |
---|---|
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[Union[google.cloud.dialogflowcx_v3beta1.types.webhook.DeleteWebhookRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.DeleteWebhookRequest, dict]
The request object. The request message for Webhooks.DeleteWebhook. |
name |
str
Required. The name of the webhook to delete. Format: |
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. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
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.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
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.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
WebhooksClient | The constructed client. |
get_webhook
get_webhook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.webhook.GetWebhookRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.GetWebhookRequest, dict]
The request object. The request message for Webhooks.GetWebhook. |
name |
str
Required. The name of the webhook. Format: |
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 | |
---|---|
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[Union[google.cloud.dialogflowcx_v3beta1.types.webhook.ListWebhooksRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the list of all webhooks in the specified agent.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.ListWebhooksRequest, dict]
The request object. The request message for Webhooks.ListWebhooks. |
parent |
str
Required. The agent to list all webhooks for. Format: |
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 | |
---|---|
Type | Description |
google.cloud.dialogflowcx_v3beta1.services.webhooks.pagers.ListWebhooksPager | The response message for 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.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_service_path
parse_service_path(path: str)
Parses a service path into its component segments.
parse_webhook_path
parse_webhook_path(path: str)
Parses a webhook path into its component segments.
service_path
service_path(project: str, location: str, namespace: str, service: str)
Returns a fully-qualified service string.
update_webhook
update_webhook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.webhook.UpdateWebhookRequest, dict]] = 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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified webhook.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.UpdateWebhookRequest, dict]
The request object. The request message for Webhooks.UpdateWebhook. |
webhook |
google.cloud.dialogflowcx_v3beta1.types.Webhook
Required. The webhook to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to the |
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 | |
---|---|
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.