Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService.
Represents configuration for a generic web service.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allowed_ca_certs
def allowed_ca_certs() -> ::Array<::String>
-
(::Array<::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'")
#allowed_ca_certs=
def allowed_ca_certs=(value) -> ::Array<::String>
-
value (::Array<::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'")
-
(::Array<::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'")
#http_method
def http_method() -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod
- (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod) — Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
#http_method=
def http_method=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod
- value (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod) — Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
- (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod) — Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
#oauth_config
def oauth_config() -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::OAuthConfig
- (::Google::Cloud::Dialogflow::CX::V3::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.
#oauth_config=
def oauth_config=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::OAuthConfig
- value (::Google::Cloud::Dialogflow::CX::V3::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.
- (::Google::Cloud::Dialogflow::CX::V3::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.
#parameter_mapping
def parameter_mapping() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) —
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
#parameter_mapping=
def parameter_mapping=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) —
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
-
(::Google::Protobuf::Map{::String => ::String}) —
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
#password
def password() -> ::String
- (::String) — The password for HTTP Basic authentication.
#password=
def password=(value) -> ::String
- value (::String) — The password for HTTP Basic authentication.
- (::String) — The password for HTTP Basic authentication.
#request_body
def request_body() -> ::String
- (::String) — Optional. Defines a custom JSON object as request body to send to flexible webhook.
#request_body=
def request_body=(value) -> ::String
- value (::String) — Optional. Defines a custom JSON object as request body to send to flexible webhook.
- (::String) — Optional. Defines a custom JSON object as request body to send to flexible webhook.
#request_headers
def request_headers() -> ::Google::Protobuf::Map{::String => ::String}
- (::Google::Protobuf::Map{::String => ::String}) — The HTTP request headers to send together with webhook requests.
#request_headers=
def request_headers=(value) -> ::Google::Protobuf::Map{::String => ::String}
- value (::Google::Protobuf::Map{::String => ::String}) — The HTTP request headers to send together with webhook requests.
- (::Google::Protobuf::Map{::String => ::String}) — The HTTP request headers to send together with webhook requests.
#service_agent_auth
def service_agent_auth() -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth
- (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth) — Optional. Indicate the auth token type generated from the Diglogflow service agent. The generated token is sent in the Authorization header.
#service_agent_auth=
def service_agent_auth=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth
- value (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth) — Optional. Indicate the auth token type generated from the Diglogflow service agent. The generated token is sent in the Authorization header.
- (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth) — Optional. Indicate the auth token type generated from the Diglogflow service agent. The generated token is sent in the Authorization header.
#uri
def uri() -> ::String
- (::String) — Required. The webhook URI for receiving POST requests. It must use https protocol.
#uri=
def uri=(value) -> ::String
- value (::String) — Required. The webhook URI for receiving POST requests. It must use https protocol.
- (::String) — Required. The webhook URI for receiving POST requests. It must use https protocol.
#username
def username() -> ::String
- (::String) — The user name for HTTP Basic authentication.
#username=
def username=(value) -> ::String
- value (::String) — The user name for HTTP Basic authentication.
- (::String) — The user name for HTTP Basic authentication.
#webhook_type
def webhook_type() -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType
- (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType) — Optional. Type of the webhook.
#webhook_type=
def webhook_type=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType
- value (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType) — Optional. Type of the webhook.
- (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType) — Optional. Type of the webhook.