Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Webhook

Returns a new instance of GoogleCloudDialogflowCxV3Webhook.



5512
5513
5514
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5512

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) 


5479
5480
5481
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5479

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) 


5485
5486
5487
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5485

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

Returns:



5490
5491
5492
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5490

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) 


5497
5498
5499
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5497

def name
  @name
end

#service_directory ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig

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

Returns:



5503
5504
5505
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5503

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) 


5510
5511
5512
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5510

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5517
5518
5519
5520
5521
5522
5523
5524
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5517

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