Class GenericWebService (1.33.0)

Version latest

• 1.33.0 (latest)
• 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

GenericWebService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents configuration for a generic web service.

Attributes
Name	Description
uri	str Required. The webhook URI for receiving POST requests. It must use https protocol.
username	str The user name for HTTP Basic authentication.
password	str The password for HTTP Basic authentication.
request_headers	MutableMapping[str, str] The HTTP request headers to send together with webhook requests.
allowed_ca_certs	MutableSequence[bytes] Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, :: openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectaltname='DNS:www.example.com' ")="">
oauth_config	google.cloud.dialogflowcx_v3beta1.types.Webhook.GenericWebService.OAuthConfig Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
service_agent_auth	google.cloud.dialogflowcx_v3beta1.types.Webhook.GenericWebService.ServiceAgentAuth Optional. Indicate the auth token type generated from the `Diglogflow service agent
webhook_type	google.cloud.dialogflowcx_v3beta1.types.Webhook.GenericWebService.WebhookType Optional. Type of the webhook.
http_method	google.cloud.dialogflowcx_v3beta1.types.Webhook.GenericWebService.HttpMethod Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
request_body	str Optional. Defines a custom JSON object as request body to send to flexible webhook.
parameter_mapping	MutableMapping[str, str] Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response

Classes

HttpMethod

HttpMethod(value)

HTTP method to use when calling webhooks.

Values: HTTP_METHOD_UNSPECIFIED (0): HTTP method not specified. POST (1): HTTP POST Method. GET (2): HTTP GET Method. HEAD (3): HTTP HEAD Method. PUT (4): HTTP PUT Method. DELETE (5): HTTP DELETE Method. PATCH (6): HTTP PATCH Method. OPTIONS (7): HTTP OPTIONS Method.

OAuthConfig

OAuthConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents configuration of OAuth client credential flow for 3rd party API authentication.

ParameterMappingEntry

ParameterMappingEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

RequestHeadersEntry

RequestHeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

ServiceAgentAuth

ServiceAgentAuth(value)

Indicate the auth token type generated from the Diglogflow service agent <https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent>__.

Values: SERVICE_AGENT_AUTH_UNSPECIFIED (0): Service agent auth type unspecified. Default to ID_TOKEN. NONE (1): No token used. ID_TOKEN (2): Use ID token <https://cloud.google.com/docs/authentication/token-types#id> generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com. ACCESS_TOKEN (3): Use access token <https://cloud.google.com/docs/authentication/token-types#access> generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com.

WebhookType

WebhookType(value)

Represents the type of webhook configuration.

Values: WEBHOOK_TYPE_UNSPECIFIED (0): Default value. This value is unused. STANDARD (1): Represents a standard webhook. FLEXIBLE (2): Represents a flexible webhook.