Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3WebhookGenericWebService

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/representations.rb

Overview

Represents configuration for a generic web service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3WebhookGenericWebService

Returns a new instance of GoogleCloudDialogflowCxV3WebhookGenericWebService.



3477
3478
3479
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3477

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

Returns:

  • (Array<String>) 


3417
3418
3419
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3417

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

Returns:

  • (String) 


3423
3424
3425
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3423

def http_method
  @http_method
end

#oauth_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig

Represents configuration of OAuth client credential flow for 3rd party API authentication. Corresponds to the JSON property oauthConfig

Returns:



3429
3430
3431
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3429

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

Returns:

  • (Hash<String,String>) 


3436
3437
3438
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3436

def parameter_mapping
  @parameter_mapping
end

#password ⇒ String

The password for HTTP Basic authentication. Corresponds to the JSON property password

Returns:

  • (String) 


3441
3442
3443
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3441

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

Returns:

  • (String) 


3447
3448
3449
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3447

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

Returns:

  • (Hash<String,String>) 


3452
3453
3454
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3452

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

Returns:

  • (String) 


3459
3460
3461
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3459

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

Returns:

  • (String) 


3465
3466
3467
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3465

def uri
  @uri
end

#username ⇒ String

The user name for HTTP Basic authentication. Corresponds to the JSON property username

Returns:

  • (String) 


3470
3471
3472
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3470

def username
  @username
end

#webhook_type ⇒ String

Optional. Type of the webhook. Corresponds to the JSON property webhookType

Returns:

  • (String) 


3475
3476
3477
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3475

def webhook_type
  @webhook_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3482

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