Class: DatadogAPIClient::V2::ActionQueryProperties

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/action_query_properties.rb

Overview

The properties of the action query.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



51
52
53
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 51

def additional_properties
  @additional_properties
end

#condition ⇒ Object

Whether to run this query. If specified, the query will only run if this condition evaluates to true in JavaScript and all other conditions are also met.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 25

def condition
  @condition
end

#debounce_in_ms ⇒ Object

The minimum time in milliseconds that must pass before the query can be triggered again. This is useful for preventing accidental double-clicks from triggering the query multiple times.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 28

def debounce_in_ms
  @debounce_in_ms
end

#mocked_outputs ⇒ Object

The mocked outputs of the action query. This is useful for testing the app without actually running the action.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 31

def mocked_outputs
  @mocked_outputs
end

#only_trigger_manually ⇒ Object

Determines when this query is executed. If set to false, the query will run when the app loads and whenever any query arguments change. If set to true, the query will only run when manually triggered from elsewhere in the app.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 34

def only_trigger_manually
  @only_trigger_manually
end

#outputs ⇒ Object

The post-query transformation function, which is a JavaScript function that changes the query's .outputs property after the query's execution.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 37

def outputs
  @outputs
end

#polling_interval_in_ms ⇒ Object

If specified, the app will poll the query at the specified interval in milliseconds. The minimum polling interval is 15 seconds. The query will only poll when the app's browser tab is active.



40
41
42
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 40

def polling_interval_in_ms
  @polling_interval_in_ms
end

#requires_confirmation ⇒ Object

Whether to prompt the user to confirm this query before it runs.



43
44
45
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 43

def requires_confirmation
  @requires_confirmation
end

#show_toast_on_error ⇒ Object

Whether to display a toast to the user when the query returns an error.



46
47
48
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 46

def show_toast_on_error
  @show_toast_on_error
end

#spec ⇒ Object

The definition of the action query.



49
50
51
 
# File 'lib/datadog_api_client/v2/models/action_query_properties.rb', line 49

def spec
  @spec
end