Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook

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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Webhook

Returns a new instance of GoogleCloudDialogflowCxV3beta1Webhook.



7232
7233
7234
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7232

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

Returns:

  • (Boolean) 


7205
7206
7207
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7205

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

Returns:

  • (String) 


7211
7212
7213
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7211

def display_name
  @display_name
end

#generic_web_service ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookGenericWebService

Represents configuration for a generic web service. Corresponds to the JSON property genericWebService

Returns:



7216
7217
7218
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7216

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

Returns:

  • (String) 


7223
7224
7225
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7223

def name
  @name
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

Returns:

  • (String) 


7230
7231
7232
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7230

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7237
7238
7239
7240
7241
7242
7243
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7237

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)
  @timeout = args[:timeout] if args.key?(:timeout)
end