Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class GenericWebService.
Represents configuration for a generic web service.
Generated from protobuf message google.cloud.dialogflow.cx.v3.Webhook.GenericWebService
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3 \ WebhookMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ uri
string
Required. The webhook URI for receiving POST requests. It must use https protocol.
↳ username
string
The user name for HTTP Basic authentication.
↳ password
string
The password for HTTP Basic authentication.
↳ secret_version_for_username_password
string
Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: projects/{project}/secrets/{secret}/versions/{version}
↳ request_headers
array| Google\Protobuf\Internal\MapField
The HTTP request headers to send together with webhook requests.
↳ secret_versions_for_request_headers
array| Google\Protobuf\Internal\MapField
Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both request_headers
and secret_versions_for_request_headers
, the value in secret_versions_for_request_headers
will be used.
↳ allowed_ca_certs
string[]
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
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
int
Optional. Indicate the auth token type generated from the Diglogflow service agent . The generated token is sent in the Authorization header.
↳ service_account_auth_config
GenericWebService\ServiceAccountAuthConfig
Optional. Configuration for service account authentication.
↳ webhook_type
int
Optional. Type of the webhook.
↳ http_method
int
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
↳ request_body
string
Optional. Defines a custom JSON object as request body to send to flexible webhook.
↳ parameter_mapping
array| Google\Protobuf\Internal\MapField
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
getUri
Required. The webhook URI for receiving POST requests. It must use https protocol.
string
setUri
Required. The webhook URI for receiving POST requests. It must use https protocol.
var
string
$this
getUsername
The user name for HTTP Basic authentication.
string
setUsername
The user name for HTTP Basic authentication.
var
string
$this
getPassword
The password for HTTP Basic authentication.
string
setPassword
The password for HTTP Basic authentication.
var
string
$this
getSecretVersionForUsernamePassword
Optional. The SecretManager secret version resource storing the
username:password pair for HTTP Basic authentication. Format: projects/{project}/secrets/{secret}/versions/{version}
string
setSecretVersionForUsernamePassword
Optional. The SecretManager secret version resource storing the
username:password pair for HTTP Basic authentication. Format: projects/{project}/secrets/{secret}/versions/{version}
var
string
$this
getRequestHeaders
The HTTP request headers to send together with webhook requests.
setRequestHeaders
The HTTP request headers to send together with webhook requests.
$this
getSecretVersionsForRequestHeaders
Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions.
When the same header name is specified in both request_headers
and secret_versions_for_request_headers
, the value in secret_versions_for_request_headers
will be used.
setSecretVersionsForRequestHeaders
Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions.
When the same header name is specified in both request_headers
and secret_versions_for_request_headers
, the value in secret_versions_for_request_headers
will be used.
$this
getAllowedCaCerts
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'")
setAllowedCaCerts
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'")
var
string[]
$this
getOauthConfig
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.
hasOauthConfig
clearOauthConfig
setOauthConfig
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.
$this
getServiceAgentAuth
Optional. Indicate the auth token type generated from the Diglogflow service agent .
The generated token is sent in the Authorization header.
setServiceAgentAuth
Optional. Indicate the auth token type generated from the Diglogflow service agent .
The generated token is sent in the Authorization header.
$this
getServiceAccountAuthConfig
Optional. Configuration for service account authentication.
hasServiceAccountAuthConfig
clearServiceAccountAuthConfig
setServiceAccountAuthConfig
Optional. Configuration for service account authentication.
$this
getWebhookType
Optional. Type of the webhook.
setWebhookType
Optional. Type of the webhook.
$this
getHttpMethod
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
setHttpMethod
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
$this
getRequestBody
Optional. Defines a custom JSON object as request body to send to flexible webhook.
string
setRequestBody
Optional. Defines a custom JSON object as request body to send to flexible webhook.
var
string
$this
getParameterMapping
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
setParameterMapping
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
$this
