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

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

Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

Defined Under Namespace

Classes: GenericWebService, ServiceDirectoryConfig

Instance Attribute Summary collapse

Instance Attribute Details

#disabled ⇒ ::Boolean

Returns Indicates whether the webhook is disabled.

Returns:

  • (::Boolean) —

    Indicates whether the webhook is disabled.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 60

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

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] secret_version_for_username_password
  #   @return [::String]
  #     Optional. The SecretManager secret version resource storing the
  #     username:password pair for HTTP Basic authentication. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook requests.
  # @!attribute [rw] secret_versions_for_request_headers
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue}]
  #     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.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::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'")
  #     ```
  # @!attribute [rw] oauth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::OAuthConfig]
  #     Optional. The OAuth configuration of the webhook. If specified,
  #     Dialogflow will initiate the OAuth client credential flow to exchange an
  #     access token from the 3rd party platform and put it in the auth header.
  # @!attribute [rw] service_agent_auth
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth]
  #     Optional. Indicate the auth token type generated from the [Diglogflow
  #     service
  #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
  #     The generated token is sent in the Authorization header.
  # @!attribute [rw] service_account_auth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAccountAuthConfig]
  #     Optional. Configuration for service account authentication.
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the value of an HTTP header stored in a SecretManager secret
    # version.
    # @!attribute [rw] secret_version
    #   @return [::String]
    #     Required. The SecretManager secret version resource storing the header
    #     value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
    class SecretVersionHeaderValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents configuration of OAuth client credential flow for 3rd party
    # API authentication.
    # @!attribute [rw] client_id
    #   @return [::String]
    #     Required. The client ID provided by the 3rd party platform.
    # @!attribute [rw] client_secret
    #   @return [::String]
    #     Optional. The client secret provided by the 3rd party platform.
    # @!attribute [rw] secret_version_for_client_secret
    #   @return [::String]
    #     Optional. The name of the SecretManager secret version resource storing
    #     the client secret. If this field is set, the `client_secret` field will
    #     be ignored. Format:
    #     `projects/{project}/secrets/{secret}/versions/{version}`
    # @!attribute [rw] token_endpoint
    #   @return [::String]
    #     Required. The token endpoint provided by the 3rd party platform to
    #     exchange an access token.
    # @!attribute [rw] scopes
    #   @return [::Array<::String>]
    #     Optional. The OAuth scopes to grant.
    class OAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for authentication using a service account.
    # @!attribute [rw] service_account
    #   @return [::String]
    #     Required. The email address of the service account used to authenticate
    #     the webhook call. Dialogflow uses this service account to exchange an
    #     access token and the access token is then sent in the `Authorization`
    #     header of the webhook request.
    #
    #     The service account must have the
    #     `roles/iam.serviceAccountTokenCreator` role granted to the
    #     [Dialogflow service
    #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    class ServiceAccountAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!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 [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue]
    class SecretVersionsForRequestHeadersEntry
      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

    # Indicate the auth token type generated from the [Diglogflow service
    # agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    module ServiceAgentAuth
      # Service agent auth type unspecified. Default to ID_TOKEN.
      SERVICE_AGENT_AUTH_UNSPECIFIED = 0

      # No token used.
      NONE = 1

      # Use [ID
      # token](https://cloud.google.com/docs/authentication/token-types#id)
      # generated from service agent. This can be used to access Cloud Function
      # and Cloud Run after you grant Invoker role to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ID_TOKEN = 2

      # Use [access
      # token](https://cloud.google.com/docs/authentication/token-types#access)
      # generated from service agent. This can be used to access other Google
      # Cloud APIs after you grant required roles to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ACCESS_TOKEN = 3
    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

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/namespaces/<NamespaceID>/services/<ServiceID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the webhook, unique within the agent.

Returns:

  • (::String) —

    Required. The human-readable name of the webhook, unique within the agent.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 60

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

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] secret_version_for_username_password
  #   @return [::String]
  #     Optional. The SecretManager secret version resource storing the
  #     username:password pair for HTTP Basic authentication. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook requests.
  # @!attribute [rw] secret_versions_for_request_headers
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue}]
  #     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.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::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'")
  #     ```
  # @!attribute [rw] oauth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::OAuthConfig]
  #     Optional. The OAuth configuration of the webhook. If specified,
  #     Dialogflow will initiate the OAuth client credential flow to exchange an
  #     access token from the 3rd party platform and put it in the auth header.
  # @!attribute [rw] service_agent_auth
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth]
  #     Optional. Indicate the auth token type generated from the [Diglogflow
  #     service
  #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
  #     The generated token is sent in the Authorization header.
  # @!attribute [rw] service_account_auth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAccountAuthConfig]
  #     Optional. Configuration for service account authentication.
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the value of an HTTP header stored in a SecretManager secret
    # version.
    # @!attribute [rw] secret_version
    #   @return [::String]
    #     Required. The SecretManager secret version resource storing the header
    #     value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
    class SecretVersionHeaderValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents configuration of OAuth client credential flow for 3rd party
    # API authentication.
    # @!attribute [rw] client_id
    #   @return [::String]
    #     Required. The client ID provided by the 3rd party platform.
    # @!attribute [rw] client_secret
    #   @return [::String]
    #     Optional. The client secret provided by the 3rd party platform.
    # @!attribute [rw] secret_version_for_client_secret
    #   @return [::String]
    #     Optional. The name of the SecretManager secret version resource storing
    #     the client secret. If this field is set, the `client_secret` field will
    #     be ignored. Format:
    #     `projects/{project}/secrets/{secret}/versions/{version}`
    # @!attribute [rw] token_endpoint
    #   @return [::String]
    #     Required. The token endpoint provided by the 3rd party platform to
    #     exchange an access token.
    # @!attribute [rw] scopes
    #   @return [::Array<::String>]
    #     Optional. The OAuth scopes to grant.
    class OAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for authentication using a service account.
    # @!attribute [rw] service_account
    #   @return [::String]
    #     Required. The email address of the service account used to authenticate
    #     the webhook call. Dialogflow uses this service account to exchange an
    #     access token and the access token is then sent in the `Authorization`
    #     header of the webhook request.
    #
    #     The service account must have the
    #     `roles/iam.serviceAccountTokenCreator` role granted to the
    #     [Dialogflow service
    #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    class ServiceAccountAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!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 [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue]
    class SecretVersionsForRequestHeadersEntry
      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

    # Indicate the auth token type generated from the [Diglogflow service
    # agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    module ServiceAgentAuth
      # Service agent auth type unspecified. Default to ID_TOKEN.
      SERVICE_AGENT_AUTH_UNSPECIFIED = 0

      # No token used.
      NONE = 1

      # Use [ID
      # token](https://cloud.google.com/docs/authentication/token-types#id)
      # generated from service agent. This can be used to access Cloud Function
      # and Cloud Run after you grant Invoker role to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ID_TOKEN = 2

      # Use [access
      # token](https://cloud.google.com/docs/authentication/token-types#access)
      # generated from service agent. This can be used to access other Google
      # Cloud APIs after you grant required roles to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ACCESS_TOKEN = 3
    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

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/namespaces/<NamespaceID>/services/<ServiceID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#generic_web_service ⇒ ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService

Returns Configuration for a generic web service.

Note: The following fields are mutually exclusive: generic_web_service, service_directory. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 60

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

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] secret_version_for_username_password
  #   @return [::String]
  #     Optional. The SecretManager secret version resource storing the
  #     username:password pair for HTTP Basic authentication. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook requests.
  # @!attribute [rw] secret_versions_for_request_headers
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue}]
  #     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.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::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'")
  #     ```
  # @!attribute [rw] oauth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::OAuthConfig]
  #     Optional. The OAuth configuration of the webhook. If specified,
  #     Dialogflow will initiate the OAuth client credential flow to exchange an
  #     access token from the 3rd party platform and put it in the auth header.
  # @!attribute [rw] service_agent_auth
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth]
  #     Optional. Indicate the auth token type generated from the [Diglogflow
  #     service
  #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
  #     The generated token is sent in the Authorization header.
  # @!attribute [rw] service_account_auth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAccountAuthConfig]
  #     Optional. Configuration for service account authentication.
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the value of an HTTP header stored in a SecretManager secret
    # version.
    # @!attribute [rw] secret_version
    #   @return [::String]
    #     Required. The SecretManager secret version resource storing the header
    #     value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
    class SecretVersionHeaderValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents configuration of OAuth client credential flow for 3rd party
    # API authentication.
    # @!attribute [rw] client_id
    #   @return [::String]
    #     Required. The client ID provided by the 3rd party platform.
    # @!attribute [rw] client_secret
    #   @return [::String]
    #     Optional. The client secret provided by the 3rd party platform.
    # @!attribute [rw] secret_version_for_client_secret
    #   @return [::String]
    #     Optional. The name of the SecretManager secret version resource storing
    #     the client secret. If this field is set, the `client_secret` field will
    #     be ignored. Format:
    #     `projects/{project}/secrets/{secret}/versions/{version}`
    # @!attribute [rw] token_endpoint
    #   @return [::String]
    #     Required. The token endpoint provided by the 3rd party platform to
    #     exchange an access token.
    # @!attribute [rw] scopes
    #   @return [::Array<::String>]
    #     Optional. The OAuth scopes to grant.
    class OAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for authentication using a service account.
    # @!attribute [rw] service_account
    #   @return [::String]
    #     Required. The email address of the service account used to authenticate
    #     the webhook call. Dialogflow uses this service account to exchange an
    #     access token and the access token is then sent in the `Authorization`
    #     header of the webhook request.
    #
    #     The service account must have the
    #     `roles/iam.serviceAccountTokenCreator` role granted to the
    #     [Dialogflow service
    #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    class ServiceAccountAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!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 [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue]
    class SecretVersionsForRequestHeadersEntry
      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

    # Indicate the auth token type generated from the [Diglogflow service
    # agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    module ServiceAgentAuth
      # Service agent auth type unspecified. Default to ID_TOKEN.
      SERVICE_AGENT_AUTH_UNSPECIFIED = 0

      # No token used.
      NONE = 1

      # Use [ID
      # token](https://cloud.google.com/docs/authentication/token-types#id)
      # generated from service agent. This can be used to access Cloud Function
      # and Cloud Run after you grant Invoker role to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ID_TOKEN = 2

      # Use [access
      # token](https://cloud.google.com/docs/authentication/token-types#access)
      # generated from service agent. This can be used to access other Google
      # Cloud APIs after you grant required roles to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ACCESS_TOKEN = 3
    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

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/namespaces/<NamespaceID>/services/<ServiceID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.

Returns:

  • (::String) —

    The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 60

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

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] secret_version_for_username_password
  #   @return [::String]
  #     Optional. The SecretManager secret version resource storing the
  #     username:password pair for HTTP Basic authentication. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook requests.
  # @!attribute [rw] secret_versions_for_request_headers
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue}]
  #     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.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::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'")
  #     ```
  # @!attribute [rw] oauth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::OAuthConfig]
  #     Optional. The OAuth configuration of the webhook. If specified,
  #     Dialogflow will initiate the OAuth client credential flow to exchange an
  #     access token from the 3rd party platform and put it in the auth header.
  # @!attribute [rw] service_agent_auth
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth]
  #     Optional. Indicate the auth token type generated from the [Diglogflow
  #     service
  #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
  #     The generated token is sent in the Authorization header.
  # @!attribute [rw] service_account_auth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAccountAuthConfig]
  #     Optional. Configuration for service account authentication.
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the value of an HTTP header stored in a SecretManager secret
    # version.
    # @!attribute [rw] secret_version
    #   @return [::String]
    #     Required. The SecretManager secret version resource storing the header
    #     value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
    class SecretVersionHeaderValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents configuration of OAuth client credential flow for 3rd party
    # API authentication.
    # @!attribute [rw] client_id
    #   @return [::String]
    #     Required. The client ID provided by the 3rd party platform.
    # @!attribute [rw] client_secret
    #   @return [::String]
    #     Optional. The client secret provided by the 3rd party platform.
    # @!attribute [rw] secret_version_for_client_secret
    #   @return [::String]
    #     Optional. The name of the SecretManager secret version resource storing
    #     the client secret. If this field is set, the `client_secret` field will
    #     be ignored. Format:
    #     `projects/{project}/secrets/{secret}/versions/{version}`
    # @!attribute [rw] token_endpoint
    #   @return [::String]
    #     Required. The token endpoint provided by the 3rd party platform to
    #     exchange an access token.
    # @!attribute [rw] scopes
    #   @return [::Array<::String>]
    #     Optional. The OAuth scopes to grant.
    class OAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for authentication using a service account.
    # @!attribute [rw] service_account
    #   @return [::String]
    #     Required. The email address of the service account used to authenticate
    #     the webhook call. Dialogflow uses this service account to exchange an
    #     access token and the access token is then sent in the `Authorization`
    #     header of the webhook request.
    #
    #     The service account must have the
    #     `roles/iam.serviceAccountTokenCreator` role granted to the
    #     [Dialogflow service
    #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    class ServiceAccountAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!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 [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue]
    class SecretVersionsForRequestHeadersEntry
      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

    # Indicate the auth token type generated from the [Diglogflow service
    # agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    module ServiceAgentAuth
      # Service agent auth type unspecified. Default to ID_TOKEN.
      SERVICE_AGENT_AUTH_UNSPECIFIED = 0

      # No token used.
      NONE = 1

      # Use [ID
      # token](https://cloud.google.com/docs/authentication/token-types#id)
      # generated from service agent. This can be used to access Cloud Function
      # and Cloud Run after you grant Invoker role to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ID_TOKEN = 2

      # Use [access
      # token](https://cloud.google.com/docs/authentication/token-types#access)
      # generated from service agent. This can be used to access other Google
      # Cloud APIs after you grant required roles to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ACCESS_TOKEN = 3
    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

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/namespaces/<NamespaceID>/services/<ServiceID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_directory ⇒ ::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig

Returns Configuration for a Service Directory service.

Note: The following fields are mutually exclusive: service_directory, generic_web_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 60

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

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] secret_version_for_username_password
  #   @return [::String]
  #     Optional. The SecretManager secret version resource storing the
  #     username:password pair for HTTP Basic authentication. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook requests.
  # @!attribute [rw] secret_versions_for_request_headers
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue}]
  #     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.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::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'")
  #     ```
  # @!attribute [rw] oauth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::OAuthConfig]
  #     Optional. The OAuth configuration of the webhook. If specified,
  #     Dialogflow will initiate the OAuth client credential flow to exchange an
  #     access token from the 3rd party platform and put it in the auth header.
  # @!attribute [rw] service_agent_auth
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth]
  #     Optional. Indicate the auth token type generated from the [Diglogflow
  #     service
  #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
  #     The generated token is sent in the Authorization header.
  # @!attribute [rw] service_account_auth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAccountAuthConfig]
  #     Optional. Configuration for service account authentication.
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the value of an HTTP header stored in a SecretManager secret
    # version.
    # @!attribute [rw] secret_version
    #   @return [::String]
    #     Required. The SecretManager secret version resource storing the header
    #     value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
    class SecretVersionHeaderValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents configuration of OAuth client credential flow for 3rd party
    # API authentication.
    # @!attribute [rw] client_id
    #   @return [::String]
    #     Required. The client ID provided by the 3rd party platform.
    # @!attribute [rw] client_secret
    #   @return [::String]
    #     Optional. The client secret provided by the 3rd party platform.
    # @!attribute [rw] secret_version_for_client_secret
    #   @return [::String]
    #     Optional. The name of the SecretManager secret version resource storing
    #     the client secret. If this field is set, the `client_secret` field will
    #     be ignored. Format:
    #     `projects/{project}/secrets/{secret}/versions/{version}`
    # @!attribute [rw] token_endpoint
    #   @return [::String]
    #     Required. The token endpoint provided by the 3rd party platform to
    #     exchange an access token.
    # @!attribute [rw] scopes
    #   @return [::Array<::String>]
    #     Optional. The OAuth scopes to grant.
    class OAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for authentication using a service account.
    # @!attribute [rw] service_account
    #   @return [::String]
    #     Required. The email address of the service account used to authenticate
    #     the webhook call. Dialogflow uses this service account to exchange an
    #     access token and the access token is then sent in the `Authorization`
    #     header of the webhook request.
    #
    #     The service account must have the
    #     `roles/iam.serviceAccountTokenCreator` role granted to the
    #     [Dialogflow service
    #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    class ServiceAccountAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!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 [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue]
    class SecretVersionsForRequestHeadersEntry
      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

    # Indicate the auth token type generated from the [Diglogflow service
    # agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    module ServiceAgentAuth
      # Service agent auth type unspecified. Default to ID_TOKEN.
      SERVICE_AGENT_AUTH_UNSPECIFIED = 0

      # No token used.
      NONE = 1

      # Use [ID
      # token](https://cloud.google.com/docs/authentication/token-types#id)
      # generated from service agent. This can be used to access Cloud Function
      # and Cloud Run after you grant Invoker role to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ID_TOKEN = 2

      # Use [access
      # token](https://cloud.google.com/docs/authentication/token-types#access)
      # generated from service agent. This can be used to access other Google
      # Cloud APIs after you grant required roles to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ACCESS_TOKEN = 3
    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

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/namespaces/<NamespaceID>/services/<ServiceID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#timeout ⇒ ::Google::Protobuf::Duration

Returns Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

Returns:

  • (::Google::Protobuf::Duration) —

    Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 60

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

  # Represents configuration for a generic web service.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The webhook URI for receiving POST requests. It must use https
  #     protocol.
  # @!attribute [rw] username
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The password for HTTP Basic authentication.
  # @!attribute [rw] secret_version_for_username_password
  #   @return [::String]
  #     Optional. The SecretManager secret version resource storing the
  #     username:password pair for HTTP Basic authentication. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The HTTP request headers to send together with webhook requests.
  # @!attribute [rw] secret_versions_for_request_headers
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue}]
  #     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.
  # @!attribute [rw] allowed_ca_certs
  #   @return [::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'")
  #     ```
  # @!attribute [rw] oauth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::OAuthConfig]
  #     Optional. The OAuth configuration of the webhook. If specified,
  #     Dialogflow will initiate the OAuth client credential flow to exchange an
  #     access token from the 3rd party platform and put it in the auth header.
  # @!attribute [rw] service_agent_auth
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth]
  #     Optional. Indicate the auth token type generated from the [Diglogflow
  #     service
  #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
  #     The generated token is sent in the Authorization header.
  # @!attribute [rw] service_account_auth_config
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAccountAuthConfig]
  #     Optional. Configuration for service account authentication.
  # @!attribute [rw] webhook_type
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::WebhookType]
  #     Optional. Type of the webhook.
  # @!attribute [rw] http_method
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::HttpMethod]
  #     Optional. HTTP method for the flexible webhook calls. Standard webhook
  #     always uses POST.
  # @!attribute [rw] request_body
  #   @return [::String]
  #     Optional. Defines a custom JSON object as request body to send to
  #     flexible webhook.
  # @!attribute [rw] parameter_mapping
  #   @return [::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
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the value of an HTTP header stored in a SecretManager secret
    # version.
    # @!attribute [rw] secret_version
    #   @return [::String]
    #     Required. The SecretManager secret version resource storing the header
    #     value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
    class SecretVersionHeaderValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents configuration of OAuth client credential flow for 3rd party
    # API authentication.
    # @!attribute [rw] client_id
    #   @return [::String]
    #     Required. The client ID provided by the 3rd party platform.
    # @!attribute [rw] client_secret
    #   @return [::String]
    #     Optional. The client secret provided by the 3rd party platform.
    # @!attribute [rw] secret_version_for_client_secret
    #   @return [::String]
    #     Optional. The name of the SecretManager secret version resource storing
    #     the client secret. If this field is set, the `client_secret` field will
    #     be ignored. Format:
    #     `projects/{project}/secrets/{secret}/versions/{version}`
    # @!attribute [rw] token_endpoint
    #   @return [::String]
    #     Required. The token endpoint provided by the 3rd party platform to
    #     exchange an access token.
    # @!attribute [rw] scopes
    #   @return [::Array<::String>]
    #     Optional. The OAuth scopes to grant.
    class OAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for authentication using a service account.
    # @!attribute [rw] service_account
    #   @return [::String]
    #     Required. The email address of the service account used to authenticate
    #     the webhook call. Dialogflow uses this service account to exchange an
    #     access token and the access token is then sent in the `Authorization`
    #     header of the webhook request.
    #
    #     The service account must have the
    #     `roles/iam.serviceAccountTokenCreator` role granted to the
    #     [Dialogflow service
    #     agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    class ServiceAccountAuthConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!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 [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::SecretVersionHeaderValue]
    class SecretVersionsForRequestHeadersEntry
      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

    # Indicate the auth token type generated from the [Diglogflow service
    # agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
    module ServiceAgentAuth
      # Service agent auth type unspecified. Default to ID_TOKEN.
      SERVICE_AGENT_AUTH_UNSPECIFIED = 0

      # No token used.
      NONE = 1

      # Use [ID
      # token](https://cloud.google.com/docs/authentication/token-types#id)
      # generated from service agent. This can be used to access Cloud Function
      # and Cloud Run after you grant Invoker role to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ID_TOKEN = 2

      # Use [access
      # token](https://cloud.google.com/docs/authentication/token-types#access)
      # generated from service agent. This can be used to access other Google
      # Cloud APIs after you grant required roles to
      # `service-<PROJECT-NUMBER>@gcp-sa-dialogflow.iam.gserviceaccount.com`.
      ACCESS_TOKEN = 3
    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

  # Represents configuration for a [Service
  # Directory](https://cloud.google.com/service-directory) service.
  # @!attribute [rw] service
  #   @return [::String]
  #     Required. The name of [Service
  #     Directory](https://cloud.google.com/service-directory) service.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/namespaces/<NamespaceID>/services/<ServiceID>`.
  #     `Location ID` of the service directory must be the same as the location
  #     of the agent.
  # @!attribute [rw] generic_web_service
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService]
  #     Generic Service configuration of this webhook.
  class ServiceDirectoryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end