Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#disabled ⇒ Boolean
(also: #disabled?)
Indicates whether the webhook is disabled.
-
#display_name ⇒ String
Required.
-
#generic_web_service ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookGenericWebService
Represents configuration for a generic web service.
-
#name ⇒ String
The unique identifier of the webhook.
-
#service_directory ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig
Represents configuration for a Service Directory service.
-
#timeout ⇒ String
Webhook execution timeout.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Webhook
constructor
A new instance of GoogleCloudDialogflowCxV3Webhook.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Webhook
Returns a new instance of GoogleCloudDialogflowCxV3Webhook.
7964 7965 7966 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7964 def initialize(**args) update!(**args) end |
Instance Attribute Details
#disabled ⇒ Boolean Also known as: disabled?
Indicates whether the webhook is disabled.
Corresponds to the JSON property disabled
7931 7932 7933 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7931 def disabled @disabled end |
#display_name ⇒ String
Required. The human-readable name of the webhook, unique within the agent.
Corresponds to the JSON property displayName
7937 7938 7939 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7937 def display_name @display_name end |
#generic_web_service ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookGenericWebService
Represents configuration for a generic web service.
Corresponds to the JSON property genericWebService
7942 7943 7944 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7942 def generic_web_service @generic_web_service end |
#name ⇒ String
The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook
method. Webhooks.CreateWebhook populates the name automatically. Format:
projects//locations//agents//webhooks/
.
Corresponds to the JSON property name
7949 7950 7951 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7949 def name @name end |
#service_directory ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig
Represents configuration for a Service Directory service.
Corresponds to the JSON property serviceDirectory
7955 7956 7957 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7955 def service_directory @service_directory end |
#timeout ⇒ String
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.
Corresponds to the JSON property timeout
7962 7963 7964 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7962 def timeout @timeout end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7969 7970 7971 7972 7973 7974 7975 7976 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7969 def update!(**args) @disabled = args[:disabled] if args.key?(:disabled) @display_name = args[:display_name] if args.key?(:display_name) @generic_web_service = args[:generic_web_service] if args.key?(:generic_web_service) @name = args[:name] if args.key?(:name) @service_directory = args[:service_directory] if args.key?(:service_directory) @timeout = args[:timeout] if args.key?(:timeout) end |