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, ServiceAgentAuth, WebhookType Classes: OAuthConfig, 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'")



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

#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:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

#oauth_config ⇒ ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::OAuthConfig

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

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

#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


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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

#password ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns The password for HTTP Basic authentication.

Returns:

  • (::String) —

    The password for HTTP Basic authentication.



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

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



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

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



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

#service_agent_auth ⇒ ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService::ServiceAgentAuth

Returns Optional. Indicate the auth token type generated from the Diglogflow service agent. The generated token is sent in the Authorization header.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

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



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

#username ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns The user name for HTTP Basic authentication.

Returns:

  • (::String) —

    The user name for HTTP Basic authentication.



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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

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

Returns Optional. Type of the webhook.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 119

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

  # 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]
  #     Required. The client secret provided by the 3rd party platform.
  # @!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

  # @!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

  # 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