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

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



6598
6599
6600
 
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 6598

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) 


6571
6572
6573
 
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 6571

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) 


6577
6578
6579
 
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 6577

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:



6582
6583
6584
 
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 6582

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) 


6589
6590
6591
 
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 6589

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) 


6596
6597
6598
 
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 6596

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6603
6604
6605
6606
6607
6608
6609
 
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 6603

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