WebhooksAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.webhooks.transports.base.WebhooksTransport] = 'grpc_asyncio', 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
WebhooksAsyncClient
WebhooksAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.webhooks.transports.base.WebhooksTransport] = 'grpc_asyncio', 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,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
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_v3.types.webhook.CreateWebhookRequest, dict]] = None, *, parent: Optional[str] = None, webhook: Optional[google.cloud.dialogflowcx_v3.types.webhook.Webhook] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a webhook in the specified agent.
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)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.CreateWebhookRequest, dict]
The request object. The request message for Webhooks.CreateWebhook. |
parent |
Required. The agent to create a webhook for. Format: |
webhook |
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_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. |
delete_webhook
delete_webhook(request: Optional[Union[google.cloud.dialogflowcx_v3.types.webhook.DeleteWebhookRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified webhook.
from google.cloud import dialogflowcx_v3
def sample_delete_webhook():
# Create a client
client = dialogflowcx_v3.WebhooksClient()
# Initialize request argument(s)
request = dialogflowcx_v3.DeleteWebhookRequest(
name="name_value",
)
# Make the request
client.delete_webhook(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.DeleteWebhookRequest, dict]
The request object. The request message for Webhooks.DeleteWebhook. |
name |
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 |
WebhooksAsyncClient | 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 |
WebhooksAsyncClient | 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 |
WebhooksAsyncClient | The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
get_webhook
get_webhook(request: Optional[Union[google.cloud.dialogflowcx_v3.types.webhook.GetWebhookRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the specified webhook.
from google.cloud import dialogflowcx_v3
def sample_get_webhook():
# Create a client
client = dialogflowcx_v3.WebhooksClient()
# Initialize request argument(s)
request = dialogflowcx_v3.GetWebhookRequest(
name="name_value",
)
# Make the request
response = client.get_webhook(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.GetWebhookRequest, dict]
The request object. The request message for Webhooks.GetWebhook. |
name |
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_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. |
list_webhooks
list_webhooks(request: Optional[Union[google.cloud.dialogflowcx_v3.types.webhook.ListWebhooksRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the list of all webhooks in the specified agent.
from google.cloud import dialogflowcx_v3
def sample_list_webhooks():
# Create a client
client = dialogflowcx_v3.WebhooksClient()
# Initialize request argument(s)
request = dialogflowcx_v3.ListWebhooksRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_webhooks(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.ListWebhooksRequest, dict]
The request object. The request message for Webhooks.ListWebhooks. |
parent |
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_v3.services.webhooks.pagers.ListWebhooksAsyncPager | 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_v3.types.webhook.UpdateWebhookRequest, dict]] = None, *, webhook: Optional[google.cloud.dialogflowcx_v3.types.webhook.Webhook] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified webhook.
from google.cloud import dialogflowcx_v3
def sample_update_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.UpdateWebhookRequest(
webhook=webhook,
)
# Make the request
response = client.update_webhook(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.UpdateWebhookRequest, dict]
The request object. The request message for Webhooks.UpdateWebhook. |
webhook |
Webhook
Required. The webhook to update. This corresponds to the |
update_mask |
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_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. |
webhook_path
webhook_path(project: str, location: str, agent: str, webhook: str)
Returns a fully-qualified webhook string.