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

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



4291
4292
4293
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 4291

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#disabledBoolean Also known as: disabled?

Indicates whether the webhook is disabled. Corresponds to the JSON property disabled

Returns:

  • (Boolean)


4264
4265
4266
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 4264

def disabled
  @disabled
end

#display_nameString

Required. The human-readable name of the webhook, unique within the agent. Corresponds to the JSON property displayName

Returns:

  • (String)


4270
4271
4272
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 4270

def display_name
  @display_name
end

#generic_web_serviceGoogle::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookGenericWebService

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



4275
4276
4277
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 4275

def generic_web_service
  @generic_web_service
end

#nameString

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)


4282
4283
4284
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 4282

def name
  @name
end

#timeoutString

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)


4289
4290
4291
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 4289

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4296
4297
4298
4299
4300
4301
4302
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 4296

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