Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookGenericWebService

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3WebhookGenericWebService

Returns a new instance of GoogleCloudDialogflowCxV3WebhookGenericWebService.



3538
3539
3540
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3538

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>) 


3457
3458
3459
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3457

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) 


3463
3464
3465
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3463

def http_method
  @http_method
end

#oauth_config ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig

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

Returns:



3469
3470
3471
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3469

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>) 


3476
3477
3478
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3476

def parameter_mapping
  @parameter_mapping
end

#password ⇒ String

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

Returns:

  • (String) 


3481
3482
3483
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3481

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) 


3487
3488
3489
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3487

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>) 


3492
3493
3494
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3492

def request_headers
  @request_headers
end

#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` Corresponds to the JSON propertysecretVersionForUsernamePassword`

Returns:

  • (String) 


3499
3500
3501
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3499

def secret_version_for_username_password
  @secret_version_for_username_password
end

#secret_versions_for_request_headers ⇒ Hash<String,Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue>

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. Corresponds to the JSON property secretVersionsForRequestHeaders

Returns:



3508
3509
3510
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3508

def secret_versions_for_request_headers
  @secret_versions_for_request_headers
end

#service_account_auth_config ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig

Configuration for authentication using a service account. Corresponds to the JSON property serviceAccountAuthConfig

Returns:



3513
3514
3515
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3513

def 
  @service_account_auth_config
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) 


3520
3521
3522
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3520

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) 


3526
3527
3528
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3526

def uri
  @uri
end

#username ⇒ String

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

Returns:

  • (String) 


3531
3532
3533
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3531

def username
  @username
end

#webhook_type ⇒ String

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

Returns:

  • (String) 


3536
3537
3538
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3536

def webhook_type
  @webhook_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3543

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)
  @secret_version_for_username_password = args[:secret_version_for_username_password] if args.key?(:secret_version_for_username_password)
  @secret_versions_for_request_headers = args[:secret_versions_for_request_headers] if args.key?(:secret_versions_for_request_headers)
  @service_account_auth_config = args[:service_account_auth_config] if args.key?(:service_account_auth_config)
  @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