Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService (v1.0.0)

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>
Returns
  • (::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>
Parameter
  • 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'")
Returns
  • (::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
Returns

#http_method=

def http_method=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod
Parameter
Returns

#parameter_mapping

def parameter_mapping() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::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}
Parameter
  • 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
Returns
  • (::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
Returns
  • (::String) — The password for HTTP Basic authentication.

#password=

def password=(value) -> ::String
Parameter
  • value (::String) — The password for HTTP Basic authentication.
Returns
  • (::String) — The password for HTTP Basic authentication.

#request_body

def request_body() -> ::String
Returns
  • (::String) — Optional. Defines a custom JSON object as request body to send to flexible webhook.

#request_body=

def request_body=(value) -> ::String
Parameter
  • value (::String) — Optional. Defines a custom JSON object as request body to send to flexible webhook.
Returns
  • (::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}
Returns
  • (::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}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — The HTTP request headers to send together with webhook requests.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The HTTP request headers to send together with webhook requests.

#uri

def uri() -> ::String
Returns
  • (::String) — Required. The webhook URI for receiving POST requests. It must use https protocol.

#uri=

def uri=(value) -> ::String
Parameter
  • value (::String) — Required. The webhook URI for receiving POST requests. It must use https protocol.
Returns
  • (::String) — Required. The webhook URI for receiving POST requests. It must use https protocol.

#username

def username() -> ::String
Returns
  • (::String) — The user name for HTTP Basic authentication.

#username=

def username=(value) -> ::String
Parameter
  • value (::String) — The user name for HTTP Basic authentication.
Returns
  • (::String) — The user name for HTTP Basic authentication.

#webhook_type

def webhook_type() -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType
Returns

#webhook_type=

def webhook_type=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType
Parameter
Returns