Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3Webhook

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) ⇒ GoogleCloudDialogflowCxV3Webhook

Returns a new instance of GoogleCloudDialogflowCxV3Webhook.



2655
2656
2657
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2655

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) 


2622
2623
2624
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2622

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) 


2628
2629
2630
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2628

def display_name
  @display_name
end

#generic_web_service ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookGenericWebService

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

Returns:



2633
2634
2635
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2633

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) 


2640
2641
2642
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2640

def name
  @name
end

#service_directory ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig

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

Returns:



2646
2647
2648
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2646

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) 


2653
2654
2655
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2653

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2660
2661
2662
2663
2664
2665
2666
2667
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2660

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