Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookGenericWebService
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookGenericWebService
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3beta1/classes.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb
Overview
Represents configuration for a generic web service.
Instance Attribute Summary collapse
-
#allowed_ca_certs ⇒ Array<String>
Optional.
-
#http_method ⇒ String
Optional.
-
#oauth_config ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig
Represents configuration of OAuth client credential flow for 3rd party API authentication.
-
#parameter_mapping ⇒ Hash<String,String>
Optional.
-
#password ⇒ String
The password for HTTP Basic authentication.
-
#request_body ⇒ String
Optional.
-
#request_headers ⇒ Hash<String,String>
The HTTP request headers to send together with webhook requests.
-
#service_agent_auth ⇒ String
Optional.
-
#uri ⇒ String
Required.
-
#username ⇒ String
The user name for HTTP Basic authentication.
-
#webhook_type ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1WebhookGenericWebService
constructor
A new instance of GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1WebhookGenericWebService
Returns a new instance of GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.
14147 14148 14149 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14147 def initialize(**args) update!(**args) end |
Instance Attribute Details
#allowed_ca_certs ⇒ 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'")
Corresponds to the JSON property allowedCaCerts
14087 14088 14089 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14087 def allowed_ca_certs @allowed_ca_certs end |
#http_method ⇒ String
Optional. HTTP method for the flexible webhook calls. Standard webhook always
uses POST.
Corresponds to the JSON property httpMethod
14093 14094 14095 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14093 def http_method @http_method end |
#oauth_config ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig
Represents configuration of OAuth client credential flow for 3rd party API
authentication.
Corresponds to the JSON property oauthConfig
14099 14100 14101 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14099 def oauth_config @oauth_config end |
#parameter_mapping ⇒ Hash<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
Corresponds to the JSON property parameterMapping
14106 14107 14108 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14106 def parameter_mapping @parameter_mapping end |
#password ⇒ String
The password for HTTP Basic authentication.
Corresponds to the JSON property password
14111 14112 14113 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14111 def password @password end |
#request_body ⇒ String
Optional. Defines a custom JSON object as request body to send to flexible
webhook.
Corresponds to the JSON property requestBody
14117 14118 14119 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14117 def request_body @request_body end |
#request_headers ⇒ Hash<String,String>
The HTTP request headers to send together with webhook requests.
Corresponds to the JSON property requestHeaders
14122 14123 14124 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14122 def request_headers @request_headers end |
#service_agent_auth ⇒ String
Optional. Indicate the auth token type generated from the Diglogflow service
agent. The generated token is sent in the Authorization header.
Corresponds to the JSON property serviceAgentAuth
14129 14130 14131 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14129 def service_agent_auth @service_agent_auth end |
#uri ⇒ String
Required. The webhook URI for receiving POST requests. It must use https
protocol.
Corresponds to the JSON property uri
14135 14136 14137 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14135 def uri @uri end |
#username ⇒ String
The user name for HTTP Basic authentication.
Corresponds to the JSON property username
14140 14141 14142 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14140 def username @username end |
#webhook_type ⇒ String
Optional. Type of the webhook.
Corresponds to the JSON property webhookType
14145 14146 14147 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14145 def webhook_type @webhook_type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14152 def update!(**args) @allowed_ca_certs = args[:allowed_ca_certs] if args.key?(:allowed_ca_certs) @http_method = args[:http_method] if args.key?(:http_method) @oauth_config = args[:oauth_config] if args.key?(:oauth_config) @parameter_mapping = args[:parameter_mapping] if args.key?(:parameter_mapping) @password = args[:password] if args.key?(:password) @request_body = args[:request_body] if args.key?(:request_body) @request_headers = args[:request_headers] if args.key?(:request_headers) @service_agent_auth = args[:service_agent_auth] if args.key?(:service_agent_auth) @uri = args[:uri] if args.key?(:uri) @username = args[:username] if args.key?(:username) @webhook_type = args[:webhook_type] if args.key?(:webhook_type) end |