Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1Webhook

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



6766
6767
6768
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 6766

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) 


6733
6734
6735
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 6733

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) 


6739
6740
6741
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 6739

def display_name
  @display_name
end

#generic_web_service ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookGenericWebService

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

Returns:



6744
6745
6746
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 6744

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) 


6751
6752
6753
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 6751

def name
  @name
end

#service_directory ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig

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

Returns:



6757
6758
6759
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 6757

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) 


6764
6765
6766
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 6764

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6771
6772
6773
6774
6775
6776
6777
6778
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 6771

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