Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookGenericWebService

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/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.



7743
7744
7745
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7743

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

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


7696
7697
7698
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7696

def allowed_ca_certs
  @allowed_ca_certs
end

#http_methodString

Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. Corresponds to the JSON property httpMethod

Returns:

  • (String)


7702
7703
7704
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7702

def http_method
  @http_method
end

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


7709
7710
7711
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7709

def parameter_mapping
  @parameter_mapping
end

#passwordString

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

Returns:

  • (String)


7714
7715
7716
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7714

def password
  @password
end

#request_bodyString

Optional. Defines a custom JSON object as request body to send to flexible webhook. Corresponds to the JSON property requestBody

Returns:

  • (String)


7720
7721
7722
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7720

def request_body
  @request_body
end

#request_headersHash<String,String>

The HTTP request headers to send together with webhook requests. Corresponds to the JSON property requestHeaders

Returns:

  • (Hash<String,String>)


7725
7726
7727
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7725

def request_headers
  @request_headers
end

#uriString

Required. The webhook URI for receiving POST requests. It must use https protocol. Corresponds to the JSON property uri

Returns:

  • (String)


7731
7732
7733
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7731

def uri
  @uri
end

#usernameString

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

Returns:

  • (String)


7736
7737
7738
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7736

def username
  @username
end

#webhook_typeString

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

Returns:

  • (String)


7741
7742
7743
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7741

def webhook_type
  @webhook_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7748

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