Class: Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb

Overview

Represents configuration for a generic web service.

Defined Under Namespace

Modules: HttpMethod, WebhookType Classes: ParameterMappingEntry, RequestHeadersEntry

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_ca_certs ⇒ ::Array<::String>

Returns 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'")



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 106

class GenericWebService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class RequestHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParameterMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the type of webhook configuration.
  module WebhookType
    # Default value. This value is unused.
    WEBHOOK_TYPE_UNSPECIFIED = 0

    # Represents a standard webhook.
    STANDARD = 1

    # Represents a flexible webhook.
    FLEXIBLE = 2
  end

  # HTTP method to use when calling webhooks.
  module HttpMethod
    # HTTP method not specified.
    HTTP_METHOD_UNSPECIFIED = 0

    # HTTP POST Method.
    POST = 1

    # HTTP GET Method.
    GET = 2

    # HTTP HEAD Method.
    HEAD = 3

    # HTTP PUT Method.
    PUT = 4

    # HTTP DELETE Method.
    DELETE = 5

    # HTTP PATCH Method.
    PATCH = 6

    # HTTP OPTIONS Method.
    OPTIONS = 7
  end
end

#http_method ⇒ ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod

Returns Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 106

class GenericWebService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class RequestHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParameterMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the type of webhook configuration.
  module WebhookType
    # Default value. This value is unused.
    WEBHOOK_TYPE_UNSPECIFIED = 0

    # Represents a standard webhook.
    STANDARD = 1

    # Represents a flexible webhook.
    FLEXIBLE = 2
  end

  # HTTP method to use when calling webhooks.
  module HttpMethod
    # HTTP method not specified.
    HTTP_METHOD_UNSPECIFIED = 0

    # HTTP POST Method.
    POST = 1

    # HTTP GET Method.
    GET = 2

    # HTTP HEAD Method.
    HEAD = 3

    # HTTP PUT Method.
    PUT = 4

    # HTTP DELETE Method.
    DELETE = 5

    # HTTP PATCH Method.
    PATCH = 6

    # HTTP OPTIONS Method.
    OPTIONS = 7
  end
end

#parameter_mapping ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 106

class GenericWebService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class RequestHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParameterMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the type of webhook configuration.
  module WebhookType
    # Default value. This value is unused.
    WEBHOOK_TYPE_UNSPECIFIED = 0

    # Represents a standard webhook.
    STANDARD = 1

    # Represents a flexible webhook.
    FLEXIBLE = 2
  end

  # HTTP method to use when calling webhooks.
  module HttpMethod
    # HTTP method not specified.
    HTTP_METHOD_UNSPECIFIED = 0

    # HTTP POST Method.
    POST = 1

    # HTTP GET Method.
    GET = 2

    # HTTP HEAD Method.
    HEAD = 3

    # HTTP PUT Method.
    PUT = 4

    # HTTP DELETE Method.
    DELETE = 5

    # HTTP PATCH Method.
    PATCH = 6

    # HTTP OPTIONS Method.
    OPTIONS = 7
  end
end

#password ⇒ ::String

Returns The password for HTTP Basic authentication.

Returns:

  • (::String) —

    The password for HTTP Basic authentication.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 106

class GenericWebService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class RequestHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParameterMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the type of webhook configuration.
  module WebhookType
    # Default value. This value is unused.
    WEBHOOK_TYPE_UNSPECIFIED = 0

    # Represents a standard webhook.
    STANDARD = 1

    # Represents a flexible webhook.
    FLEXIBLE = 2
  end

  # HTTP method to use when calling webhooks.
  module HttpMethod
    # HTTP method not specified.
    HTTP_METHOD_UNSPECIFIED = 0

    # HTTP POST Method.
    POST = 1

    # HTTP GET Method.
    GET = 2

    # HTTP HEAD Method.
    HEAD = 3

    # HTTP PUT Method.
    PUT = 4

    # HTTP DELETE Method.
    DELETE = 5

    # HTTP PATCH Method.
    PATCH = 6

    # HTTP OPTIONS Method.
    OPTIONS = 7
  end
end

#request_body ⇒ ::String

Returns 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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 106

class GenericWebService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class RequestHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParameterMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the type of webhook configuration.
  module WebhookType
    # Default value. This value is unused.
    WEBHOOK_TYPE_UNSPECIFIED = 0

    # Represents a standard webhook.
    STANDARD = 1

    # Represents a flexible webhook.
    FLEXIBLE = 2
  end

  # HTTP method to use when calling webhooks.
  module HttpMethod
    # HTTP method not specified.
    HTTP_METHOD_UNSPECIFIED = 0

    # HTTP POST Method.
    POST = 1

    # HTTP GET Method.
    GET = 2

    # HTTP HEAD Method.
    HEAD = 3

    # HTTP PUT Method.
    PUT = 4

    # HTTP DELETE Method.
    DELETE = 5

    # HTTP PATCH Method.
    PATCH = 6

    # HTTP OPTIONS Method.
    OPTIONS = 7
  end
end

#request_headers ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 106

class GenericWebService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class RequestHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParameterMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the type of webhook configuration.
  module WebhookType
    # Default value. This value is unused.
    WEBHOOK_TYPE_UNSPECIFIED = 0

    # Represents a standard webhook.
    STANDARD = 1

    # Represents a flexible webhook.
    FLEXIBLE = 2
  end

  # HTTP method to use when calling webhooks.
  module HttpMethod
    # HTTP method not specified.
    HTTP_METHOD_UNSPECIFIED = 0

    # HTTP POST Method.
    POST = 1

    # HTTP GET Method.
    GET = 2

    # HTTP HEAD Method.
    HEAD = 3

    # HTTP PUT Method.
    PUT = 4

    # HTTP DELETE Method.
    DELETE = 5

    # HTTP PATCH Method.
    PATCH = 6

    # HTTP OPTIONS Method.
    OPTIONS = 7
  end
end

#uri ⇒ ::String

Returns 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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 106

class GenericWebService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class RequestHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParameterMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the type of webhook configuration.
  module WebhookType
    # Default value. This value is unused.
    WEBHOOK_TYPE_UNSPECIFIED = 0

    # Represents a standard webhook.
    STANDARD = 1

    # Represents a flexible webhook.
    FLEXIBLE = 2
  end

  # HTTP method to use when calling webhooks.
  module HttpMethod
    # HTTP method not specified.
    HTTP_METHOD_UNSPECIFIED = 0

    # HTTP POST Method.
    POST = 1

    # HTTP GET Method.
    GET = 2

    # HTTP HEAD Method.
    HEAD = 3

    # HTTP PUT Method.
    PUT = 4

    # HTTP DELETE Method.
    DELETE = 5

    # HTTP PATCH Method.
    PATCH = 6

    # HTTP OPTIONS Method.
    OPTIONS = 7
  end
end

#username ⇒ ::String

Returns The user name for HTTP Basic authentication.

Returns:

  • (::String) —

    The user name for HTTP Basic authentication.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 106

class GenericWebService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class RequestHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParameterMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the type of webhook configuration.
  module WebhookType
    # Default value. This value is unused.
    WEBHOOK_TYPE_UNSPECIFIED = 0

    # Represents a standard webhook.
    STANDARD = 1

    # Represents a flexible webhook.
    FLEXIBLE = 2
  end

  # HTTP method to use when calling webhooks.
  module HttpMethod
    # HTTP method not specified.
    HTTP_METHOD_UNSPECIFIED = 0

    # HTTP POST Method.
    POST = 1

    # HTTP GET Method.
    GET = 2

    # HTTP HEAD Method.
    HEAD = 3

    # HTTP PUT Method.
    PUT = 4

    # HTTP DELETE Method.
    DELETE = 5

    # HTTP PATCH Method.
    PATCH = 6

    # HTTP OPTIONS Method.
    OPTIONS = 7
  end
end

#webhook_type ⇒ ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType

Returns Optional. Type of the webhook.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 106

class GenericWebService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class RequestHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ParameterMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents the type of webhook configuration.
  module WebhookType
    # Default value. This value is unused.
    WEBHOOK_TYPE_UNSPECIFIED = 0

    # Represents a standard webhook.
    STANDARD = 1

    # Represents a flexible webhook.
    FLEXIBLE = 2
  end

  # HTTP method to use when calling webhooks.
  module HttpMethod
    # HTTP method not specified.
    HTTP_METHOD_UNSPECIFIED = 0

    # HTTP POST Method.
    POST = 1

    # HTTP GET Method.
    GET = 2

    # HTTP HEAD Method.
    HEAD = 3

    # HTTP PUT Method.
    PUT = 4

    # HTTP DELETE Method.
    DELETE = 5

    # HTTP PATCH Method.
    PATCH = 6

    # HTTP OPTIONS Method.
    OPTIONS = 7
  end
end