ActionQueryProperties (datadog-api-client 2.42.0 API)

java.lang.Object
- com.datadog.api.client.v2.model.ActionQueryProperties

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class ActionQueryProperties
extends Object

The properties of the action query.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_CONDITION`
`static String`	`JSON_PROPERTY_DEBOUNCE_IN_MS`
`static String`	`JSON_PROPERTY_MOCKED_OUTPUTS`
`static String`	`JSON_PROPERTY_ONLY_TRIGGER_MANUALLY`
`static String`	`JSON_PROPERTY_OUTPUTS`
`static String`	`JSON_PROPERTY_POLLING_INTERVAL_IN_MS`
`static String`	`JSON_PROPERTY_REQUIRES_CONFIRMATION`
`static String`	`JSON_PROPERTY_SHOW_TOAST_ON_ERROR`
`static String`	`JSON_PROPERTY_SPEC`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

ActionQueryProperties()

ActionQueryProperties(ActionQuerySpec spec)

Constructors
Constructor and Description
`ActionQueryProperties()`
`ActionQueryProperties(ActionQuerySpec spec)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActionQueryProperties`	`condition(ActionQueryCondition condition)`
`ActionQueryProperties`	`debounceInMs(ActionQueryDebounceInMs debounceInMs)`
`boolean`	`equals(Object o)` Return true if this ActionQueryProperties object is equal to o.
`Map<String,Object>`	`getAdditionalProperties()` Return the additional (undeclared) property.
`Object`	`getAdditionalProperty(String key)` Return the additional (undeclared) property with the specified name.
`ActionQueryCondition`	`getCondition()` Whether to run this query.
`ActionQueryDebounceInMs`	`getDebounceInMs()` The minimum time in milliseconds that must pass before the query can be triggered again.
`ActionQueryMockedOutputs`	`getMockedOutputs()` The mocked outputs of the action query.
`ActionQueryOnlyTriggerManually`	`getOnlyTriggerManually()` Determines when this query is executed.
`String`	`getOutputs()` The post-query transformation function, which is a JavaScript function that changes the query's `.outputs` property after the query's execution.
`ActionQueryPollingIntervalInMs`	`getPollingIntervalInMs()` If specified, the app will poll the query at the specified interval in milliseconds.
`ActionQueryRequiresConfirmation`	`getRequiresConfirmation()` Whether to prompt the user to confirm this query before it runs.
`ActionQueryShowToastOnError`	`getShowToastOnError()` Whether to display a toast to the user when the query returns an error.
`ActionQuerySpec`	`getSpec()` The definition of the action query.
`int`	`hashCode()`
`ActionQueryProperties`	`mockedOutputs(ActionQueryMockedOutputs mockedOutputs)`
`ActionQueryProperties`	`onlyTriggerManually(ActionQueryOnlyTriggerManually onlyTriggerManually)`
`ActionQueryProperties`	`outputs(String outputs)`
`ActionQueryProperties`	`pollingIntervalInMs(ActionQueryPollingIntervalInMs pollingIntervalInMs)`
`ActionQueryProperties`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`ActionQueryProperties`	`requiresConfirmation(ActionQueryRequiresConfirmation requiresConfirmation)`
`void`	`setCondition(ActionQueryCondition condition)`
`void`	`setDebounceInMs(ActionQueryDebounceInMs debounceInMs)`
`void`	`setMockedOutputs(ActionQueryMockedOutputs mockedOutputs)`
`void`	`setOnlyTriggerManually(ActionQueryOnlyTriggerManually onlyTriggerManually)`
`void`	`setOutputs(String outputs)`
`void`	`setPollingIntervalInMs(ActionQueryPollingIntervalInMs pollingIntervalInMs)`
`void`	`setRequiresConfirmation(ActionQueryRequiresConfirmation requiresConfirmation)`
`void`	`setShowToastOnError(ActionQueryShowToastOnError showToastOnError)`
`void`	`setSpec(ActionQuerySpec spec)`
`ActionQueryProperties`	`showToastOnError(ActionQueryShowToastOnError showToastOnError)`
`ActionQueryProperties`	`spec(ActionQuerySpec spec)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - unparsed
```
public boolean unparsed
```
  - JSON_PROPERTY_CONDITION
```
public static final String JSON_PROPERTY_CONDITION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DEBOUNCE_IN_MS
```
public static final String JSON_PROPERTY_DEBOUNCE_IN_MS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MOCKED_OUTPUTS
```
public static final String JSON_PROPERTY_MOCKED_OUTPUTS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ONLY_TRIGGER_MANUALLY
```
public static final String JSON_PROPERTY_ONLY_TRIGGER_MANUALLY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_OUTPUTS
```
public static final String JSON_PROPERTY_OUTPUTS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_POLLING_INTERVAL_IN_MS
```
public static final String JSON_PROPERTY_POLLING_INTERVAL_IN_MS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REQUIRES_CONFIRMATION
```
public static final String JSON_PROPERTY_REQUIRES_CONFIRMATION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOW_TOAST_ON_ERROR
```
public static final String JSON_PROPERTY_SHOW_TOAST_ON_ERROR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SPEC
```
public static final String JSON_PROPERTY_SPEC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ActionQueryProperties
```
public ActionQueryProperties()
```
  - ActionQueryProperties
```
public ActionQueryProperties(ActionQuerySpec spec)
```
- Method Detail
  - condition
```
public ActionQueryProperties condition(ActionQueryCondition condition)
```
  - getCondition
```
@Nullable
public ActionQueryCondition getCondition()
```
    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.
    
    Returns:
    
    condition
  - setCondition
```
public void setCondition(ActionQueryCondition condition)
```
  - debounceInMs
```
public ActionQueryProperties debounceInMs(ActionQueryDebounceInMs debounceInMs)
```
  - getDebounceInMs
```
@Nullable
public ActionQueryDebounceInMs getDebounceInMs()
```
    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.
    
    Returns:
    
    debounceInMs
  - setDebounceInMs
```
public void setDebounceInMs(ActionQueryDebounceInMs debounceInMs)
```
  - mockedOutputs
```
public ActionQueryProperties mockedOutputs(ActionQueryMockedOutputs mockedOutputs)
```
  - getMockedOutputs
```
@Nullable
public ActionQueryMockedOutputs getMockedOutputs()
```
    The mocked outputs of the action query. This is useful for testing the app without actually running the action.
    
    Returns:
    
    mockedOutputs
  - setMockedOutputs
```
public void setMockedOutputs(ActionQueryMockedOutputs mockedOutputs)
```
  - onlyTriggerManually
```
public ActionQueryProperties onlyTriggerManually(ActionQueryOnlyTriggerManually onlyTriggerManually)
```
  - getOnlyTriggerManually
```
@Nullable
public ActionQueryOnlyTriggerManually getOnlyTriggerManually()
```
    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.
    
    Returns:
    
    onlyTriggerManually
  - setOnlyTriggerManually
```
public void setOnlyTriggerManually(ActionQueryOnlyTriggerManually onlyTriggerManually)
```
  - outputs
```
public ActionQueryProperties outputs(String outputs)
```
  - getOutputs
```
@Nullable
public String getOutputs()
```
    The post-query transformation function, which is a JavaScript function that changes the query's .outputs property after the query's execution.
    
    Returns:
    
    outputs
  - setOutputs
```
public void setOutputs(String outputs)
```
  - pollingIntervalInMs
```
public ActionQueryProperties pollingIntervalInMs(ActionQueryPollingIntervalInMs pollingIntervalInMs)
```
  - getPollingIntervalInMs
```
@Nullable
public ActionQueryPollingIntervalInMs getPollingIntervalInMs()
```
    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.
    
    Returns:
    
    pollingIntervalInMs
  - setPollingIntervalInMs
```
public void setPollingIntervalInMs(ActionQueryPollingIntervalInMs pollingIntervalInMs)
```
  - requiresConfirmation
```
public ActionQueryProperties requiresConfirmation(ActionQueryRequiresConfirmation requiresConfirmation)
```
  - getRequiresConfirmation
```
@Nullable
public ActionQueryRequiresConfirmation getRequiresConfirmation()
```
    Whether to prompt the user to confirm this query before it runs.
    
    Returns:
    
    requiresConfirmation
  - setRequiresConfirmation
```
public void setRequiresConfirmation(ActionQueryRequiresConfirmation requiresConfirmation)
```
  - showToastOnError
```
public ActionQueryProperties showToastOnError(ActionQueryShowToastOnError showToastOnError)
```
  - getShowToastOnError
```
@Nullable
public ActionQueryShowToastOnError getShowToastOnError()
```
    Whether to display a toast to the user when the query returns an error.
    
    Returns:
    
    showToastOnError
  - setShowToastOnError
```
public void setShowToastOnError(ActionQueryShowToastOnError showToastOnError)
```
  - spec
```
public ActionQueryProperties spec(ActionQuerySpec spec)
```
  - getSpec
```
public ActionQuerySpec getSpec()
```
    The definition of the action query.
    
    Returns:
    
    spec
  - setSpec
```
public void setSpec(ActionQuerySpec spec)
```
  - putAdditionalProperty
```
public ActionQueryProperties putAdditionalProperty(String key,
                                                   Object value)
```
    Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
    
    Parameters:
    
    key - The arbitrary key to set
    
    value - The associated value
    
    Returns:
    
    ActionQueryProperties
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
    Return the additional (undeclared) property.
    
    Returns:
    
    The additional properties
  - getAdditionalProperty
```
public Object getAdditionalProperty(String key)
```
    Return the additional (undeclared) property with the specified name.
    
    Parameters:
    
    key - The arbitrary key to get
    
    Returns:
    
    The specific additional property for the given key
  - equals
```
public boolean equals(Object o)
```
    Return true if this ActionQueryProperties object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ActionQueryProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_CONDITION

JSON_PROPERTY_DEBOUNCE_IN_MS

JSON_PROPERTY_MOCKED_OUTPUTS

JSON_PROPERTY_ONLY_TRIGGER_MANUALLY

JSON_PROPERTY_OUTPUTS

JSON_PROPERTY_POLLING_INTERVAL_IN_MS

JSON_PROPERTY_REQUIRES_CONFIRMATION

JSON_PROPERTY_SHOW_TOAST_ON_ERROR

JSON_PROPERTY_SPEC

Constructor Detail

ActionQueryProperties

ActionQueryProperties

Method Detail

condition

getCondition

setCondition

debounceInMs

getDebounceInMs

setDebounceInMs

mockedOutputs

getMockedOutputs

setMockedOutputs

onlyTriggerManually

getOnlyTriggerManually

setOnlyTriggerManually

outputs

getOutputs

setOutputs

pollingIntervalInMs

getPollingIntervalInMs

setPollingIntervalInMs

requiresConfirmation

getRequiresConfirmation

setRequiresConfirmation

showToastOnError

getShowToastOnError

setShowToastOnError

spec

getSpec

setSpec

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString