Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1Webhook

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



7383
7384
7385
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 7383

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) 


7350
7351
7352
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 7350

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) 


7356
7357
7358
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 7356

def display_name
  @display_name
end

#generic_web_service ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookGenericWebService

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

Returns:



7361
7362
7363
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 7361

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) 


7368
7369
7370
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 7368

def name
  @name
end

#service_directory ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig

Represents configuration for a Service Directory service. Corresponds to the JSON property serviceDirectory

Returns:



7374
7375
7376
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 7374

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

Returns:

  • (String) 


7381
7382
7383
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 7381

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7388
7389
7390
7391
7392
7393
7394
7395
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 7388

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