com.datadog.api.client.v1.model

Class MonitorOptions

java.lang.Object

com.datadog.api.client.v1.model.MonitorOptions

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

List of options associated with your monitor.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_AGGREGATION
static String	JSON_PROPERTY_DEVICE_IDS
static String	JSON_PROPERTY_ENABLE_LOGS_SAMPLE
static String	JSON_PROPERTY_ENABLE_SAMPLES
static String	JSON_PROPERTY_ESCALATION_MESSAGE
static String	JSON_PROPERTY_EVALUATION_DELAY
static String	JSON_PROPERTY_GROUP_RETENTION_DURATION
static String	JSON_PROPERTY_GROUPBY_SIMPLE_MONITOR
static String	JSON_PROPERTY_INCLUDE_TAGS
static String	JSON_PROPERTY_LOCKED
static String	JSON_PROPERTY_MIN_FAILURE_DURATION
static String	JSON_PROPERTY_MIN_LOCATION_FAILED
static String	JSON_PROPERTY_NEW_GROUP_DELAY
static String	JSON_PROPERTY_NEW_HOST_DELAY
static String	JSON_PROPERTY_NO_DATA_TIMEFRAME
static String	JSON_PROPERTY_NOTIFICATION_PRESET_NAME
static String	JSON_PROPERTY_NOTIFY_AUDIT
static String	JSON_PROPERTY_NOTIFY_BY
static String	JSON_PROPERTY_NOTIFY_NO_DATA
static String	JSON_PROPERTY_ON_MISSING_DATA
static String	JSON_PROPERTY_RENOTIFY_INTERVAL
static String	JSON_PROPERTY_RENOTIFY_OCCURRENCES
static String	JSON_PROPERTY_RENOTIFY_STATUSES
static String	JSON_PROPERTY_REQUIRE_FULL_WINDOW
static String	JSON_PROPERTY_SCHEDULING_OPTIONS
static String	JSON_PROPERTY_SILENCED
static String	JSON_PROPERTY_SYNTHETICS_CHECK_ID
static String	JSON_PROPERTY_THRESHOLD_WINDOWS
static String	JSON_PROPERTY_THRESHOLDS
static String	JSON_PROPERTY_TIMEOUT_H
static String	JSON_PROPERTY_VARIABLES
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
MonitorOptions()

Method Summary

Modifier and Type	Method and Description
MonitorOptions	addNotifyByItem(String notifyByItem)
MonitorOptions	addRenotifyStatusesItem(MonitorRenotifyStatusType renotifyStatusesItem)
MonitorOptions	addVariablesItem(MonitorFormulaAndFunctionQueryDefinition variablesItem)
MonitorOptions	enableLogsSample(Boolean enableLogsSample) Deprecated.
MonitorOptions	enableSamples(Boolean enableSamples)
boolean	equals(Object o) Return true if this MonitorOptions object is equal to o.
MonitorOptions	escalationMessage(String escalationMessage)
MonitorOptions	evaluationDelay(Long evaluationDelay)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
MonitorOptionsAggregation	getAggregation() Type of aggregation performed in the monitor query.
List<MonitorDeviceID>	getDeviceIds() Deprecated.
Boolean	getEnableLogsSample() Whether or not to send a log sample when the log monitor triggers.
Boolean	getEnableSamples() Whether or not to send a list of samples when the monitor triggers.
String	getEscalationMessage() We recommend using the is_renotify, block in the original message instead.
org.openapitools.jackson.nullable.JsonNullable<Long>	getEvaluationDelay_JsonNullable()
Long	getEvaluationDelay() Time (in seconds) to delay evaluation, as a non-negative integer.
Boolean	getGroupbySimpleMonitor() Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold.
String	getGroupRetentionDuration() The time span after which groups with missing data are dropped from the monitor state.
Boolean	getIncludeTags() A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.
Boolean	getLocked() Deprecated.
org.openapitools.jackson.nullable.JsonNullable<Long>	getMinFailureDuration_JsonNullable()
Long	getMinFailureDuration() How long the test should be in failure before alerting (integer, number of seconds, max 7200).
org.openapitools.jackson.nullable.JsonNullable<Long>	getMinLocationFailed_JsonNullable()
Long	getMinLocationFailed() The minimum number of locations in failure at the same time during at least one moment in the min_failure_duration period (min_location_failed and min_failure_duration are part of the advanced alerting rules - integer, >= 1).
org.openapitools.jackson.nullable.JsonNullable<Long>	getNewGroupDelay_JsonNullable()
Long	getNewGroupDelay() Time (in seconds) to skip evaluations for new groups.
org.openapitools.jackson.nullable.JsonNullable<Long>	getNewHostDelay_JsonNullable() Deprecated.
Long	getNewHostDelay() Deprecated.
org.openapitools.jackson.nullable.JsonNullable<Long>	getNoDataTimeframe_JsonNullable()
Long	getNoDataTimeframe() The number of minutes before a monitor notifies after data stops reporting.
MonitorOptionsNotificationPresets	getNotificationPresetName() Toggles the display of additional content sent in the monitor notification.
Boolean	getNotifyAudit() A Boolean indicating whether tagged users is notified on changes to this monitor.
List<String>	getNotifyBy() Controls what granularity a monitor alerts on.
Boolean	getNotifyNoData() A Boolean indicating whether this monitor notifies when data stops reporting.
OnMissingDataOption	getOnMissingData() Controls how groups or monitors are treated if an evaluation does not return any data points.
org.openapitools.jackson.nullable.JsonNullable<Long>	getRenotifyInterval_JsonNullable()
Long	getRenotifyInterval() The number of minutes after the last notification before a monitor re-notifies on the current status.
org.openapitools.jackson.nullable.JsonNullable<Long>	getRenotifyOccurrences_JsonNullable()
Long	getRenotifyOccurrences() The number of times re-notification messages should be sent on the current status at the provided re-notification interval.
org.openapitools.jackson.nullable.JsonNullable<List<MonitorRenotifyStatusType>>	getRenotifyStatuses_JsonNullable()
List<MonitorRenotifyStatusType>	getRenotifyStatuses() The types of monitor statuses for which re-notification messages are sent.
Boolean	getRequireFullWindow() A Boolean indicating whether this monitor needs a full window of data before it’s evaluated.
MonitorOptionsSchedulingOptions	getSchedulingOptions() Configuration options for scheduling.
Map<String,Long>	getSilenced() Deprecated.
org.openapitools.jackson.nullable.JsonNullable<String>	getSyntheticsCheckId_JsonNullable() Deprecated.
String	getSyntheticsCheckId() Deprecated.
MonitorThresholds	getThresholds() List of the different monitor threshold available.
MonitorThresholdWindowOptions	getThresholdWindows() Alerting time window options.
org.openapitools.jackson.nullable.JsonNullable<Long>	getTimeoutH_JsonNullable()
Long	getTimeoutH() The number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
List<MonitorFormulaAndFunctionQueryDefinition>	getVariables() List of requests that can be used in the monitor query.
MonitorOptions	groupbySimpleMonitor(Boolean groupbySimpleMonitor)
MonitorOptions	groupRetentionDuration(String groupRetentionDuration)
int	hashCode()
MonitorOptions	includeTags(Boolean includeTags)
MonitorOptions	locked(Boolean locked)
MonitorOptions	minFailureDuration(Long minFailureDuration)
MonitorOptions	minLocationFailed(Long minLocationFailed)
MonitorOptions	newGroupDelay(Long newGroupDelay)
MonitorOptions	newHostDelay(Long newHostDelay)
MonitorOptions	noDataTimeframe(Long noDataTimeframe)
MonitorOptions	notificationPresetName(MonitorOptionsNotificationPresets notificationPresetName)
MonitorOptions	notifyAudit(Boolean notifyAudit)
MonitorOptions	notifyBy(List<String> notifyBy)
MonitorOptions	notifyNoData(Boolean notifyNoData)
MonitorOptions	onMissingData(OnMissingDataOption onMissingData)
MonitorOptions	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
MonitorOptions	putSilencedItem(String key, Long silencedItem)
MonitorOptions	renotifyInterval(Long renotifyInterval)
MonitorOptions	renotifyOccurrences(Long renotifyOccurrences)
MonitorOptions	renotifyStatuses(List<MonitorRenotifyStatusType> renotifyStatuses)
MonitorOptions	requireFullWindow(Boolean requireFullWindow)
MonitorOptions	schedulingOptions(MonitorOptionsSchedulingOptions schedulingOptions)
void	setEnableLogsSample(Boolean enableLogsSample)
void	setEnableSamples(Boolean enableSamples)
void	setEscalationMessage(String escalationMessage)
void	setEvaluationDelay_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> evaluationDelay)
void	setEvaluationDelay(Long evaluationDelay)
void	setGroupbySimpleMonitor(Boolean groupbySimpleMonitor)
void	setGroupRetentionDuration(String groupRetentionDuration)
void	setIncludeTags(Boolean includeTags)
void	setLocked(Boolean locked) Deprecated.
void	setMinFailureDuration_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> minFailureDuration)
void	setMinFailureDuration(Long minFailureDuration)
void	setMinLocationFailed_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> minLocationFailed)
void	setMinLocationFailed(Long minLocationFailed)
void	setNewGroupDelay_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> newGroupDelay)
void	setNewGroupDelay(Long newGroupDelay)
void	setNewHostDelay_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> newHostDelay)
void	setNewHostDelay(Long newHostDelay)
void	setNoDataTimeframe_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> noDataTimeframe)
void	setNoDataTimeframe(Long noDataTimeframe)
void	setNotificationPresetName(MonitorOptionsNotificationPresets notificationPresetName)
void	setNotifyAudit(Boolean notifyAudit)
void	setNotifyBy(List<String> notifyBy)
void	setNotifyNoData(Boolean notifyNoData)
void	setOnMissingData(OnMissingDataOption onMissingData)
void	setRenotifyInterval_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> renotifyInterval)
void	setRenotifyInterval(Long renotifyInterval)
void	setRenotifyOccurrences_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> renotifyOccurrences)
void	setRenotifyOccurrences(Long renotifyOccurrences)
void	setRenotifyStatuses_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<MonitorRenotifyStatusType>> renotifyStatuses)
void	setRenotifyStatuses(List<MonitorRenotifyStatusType> renotifyStatuses)
void	setRequireFullWindow(Boolean requireFullWindow)
void	setSchedulingOptions(MonitorOptionsSchedulingOptions schedulingOptions)
void	setSilenced(Map<String,Long> silenced) Deprecated.
void	setSyntheticsCheckId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> syntheticsCheckId)
void	setSyntheticsCheckId(String syntheticsCheckId)
void	setThresholds(MonitorThresholds thresholds)
void	setThresholdWindows(MonitorThresholdWindowOptions thresholdWindows)
void	setTimeoutH_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> timeoutH)
void	setTimeoutH(Long timeoutH)
void	setVariables(List<MonitorFormulaAndFunctionQueryDefinition> variables)
MonitorOptions	silenced(Map<String,Long> silenced)
MonitorOptions	syntheticsCheckId(String syntheticsCheckId)
MonitorOptions	thresholds(MonitorThresholds thresholds)
MonitorOptions	thresholdWindows(MonitorThresholdWindowOptions thresholdWindows)
MonitorOptions	timeoutH(Long timeoutH)
String	toString()
MonitorOptions	variables(List<MonitorFormulaAndFunctionQueryDefinition> variables)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_AGGREGATION

public static final String JSON_PROPERTY_AGGREGATION

See Also:

Constant Field Values

JSON_PROPERTY_DEVICE_IDS

public static final String JSON_PROPERTY_DEVICE_IDS

See Also:

Constant Field Values

JSON_PROPERTY_ENABLE_LOGS_SAMPLE

public static final String JSON_PROPERTY_ENABLE_LOGS_SAMPLE

See Also:

Constant Field Values

JSON_PROPERTY_ENABLE_SAMPLES

public static final String JSON_PROPERTY_ENABLE_SAMPLES

See Also:

Constant Field Values

JSON_PROPERTY_ESCALATION_MESSAGE

public static final String JSON_PROPERTY_ESCALATION_MESSAGE

See Also:

Constant Field Values

JSON_PROPERTY_EVALUATION_DELAY

public static final String JSON_PROPERTY_EVALUATION_DELAY

See Also:

Constant Field Values

JSON_PROPERTY_GROUP_RETENTION_DURATION

public static final String JSON_PROPERTY_GROUP_RETENTION_DURATION

See Also:

Constant Field Values

JSON_PROPERTY_GROUPBY_SIMPLE_MONITOR

public static final String JSON_PROPERTY_GROUPBY_SIMPLE_MONITOR

See Also:

Constant Field Values

JSON_PROPERTY_INCLUDE_TAGS

public static final String JSON_PROPERTY_INCLUDE_TAGS

See Also:

Constant Field Values

JSON_PROPERTY_LOCKED

public static final String JSON_PROPERTY_LOCKED

See Also:

Constant Field Values

JSON_PROPERTY_MIN_FAILURE_DURATION

public static final String JSON_PROPERTY_MIN_FAILURE_DURATION

See Also:

Constant Field Values

JSON_PROPERTY_MIN_LOCATION_FAILED

public static final String JSON_PROPERTY_MIN_LOCATION_FAILED

See Also:

Constant Field Values

JSON_PROPERTY_NEW_GROUP_DELAY

public static final String JSON_PROPERTY_NEW_GROUP_DELAY

See Also:

Constant Field Values

JSON_PROPERTY_NEW_HOST_DELAY

public static final String JSON_PROPERTY_NEW_HOST_DELAY

See Also:

Constant Field Values

JSON_PROPERTY_NO_DATA_TIMEFRAME

public static final String JSON_PROPERTY_NO_DATA_TIMEFRAME

See Also:

Constant Field Values

JSON_PROPERTY_NOTIFICATION_PRESET_NAME

public static final String JSON_PROPERTY_NOTIFICATION_PRESET_NAME

See Also:

Constant Field Values

JSON_PROPERTY_NOTIFY_AUDIT

public static final String JSON_PROPERTY_NOTIFY_AUDIT

See Also:

Constant Field Values

JSON_PROPERTY_NOTIFY_BY

public static final String JSON_PROPERTY_NOTIFY_BY

See Also:

Constant Field Values

JSON_PROPERTY_NOTIFY_NO_DATA

public static final String JSON_PROPERTY_NOTIFY_NO_DATA

See Also:

Constant Field Values

JSON_PROPERTY_ON_MISSING_DATA

public static final String JSON_PROPERTY_ON_MISSING_DATA

See Also:

Constant Field Values

JSON_PROPERTY_RENOTIFY_INTERVAL

public static final String JSON_PROPERTY_RENOTIFY_INTERVAL

See Also:

Constant Field Values

JSON_PROPERTY_RENOTIFY_OCCURRENCES

public static final String JSON_PROPERTY_RENOTIFY_OCCURRENCES

See Also:

Constant Field Values

JSON_PROPERTY_RENOTIFY_STATUSES

public static final String JSON_PROPERTY_RENOTIFY_STATUSES

See Also:

Constant Field Values

JSON_PROPERTY_REQUIRE_FULL_WINDOW

public static final String JSON_PROPERTY_REQUIRE_FULL_WINDOW

See Also:

Constant Field Values

JSON_PROPERTY_SCHEDULING_OPTIONS

public static final String JSON_PROPERTY_SCHEDULING_OPTIONS

See Also:

Constant Field Values

JSON_PROPERTY_SILENCED

public static final String JSON_PROPERTY_SILENCED

See Also:

Constant Field Values

JSON_PROPERTY_SYNTHETICS_CHECK_ID

public static final String JSON_PROPERTY_SYNTHETICS_CHECK_ID

See Also:

Constant Field Values

JSON_PROPERTY_THRESHOLD_WINDOWS

public static final String JSON_PROPERTY_THRESHOLD_WINDOWS

See Also:

Constant Field Values

JSON_PROPERTY_THRESHOLDS

public static final String JSON_PROPERTY_THRESHOLDS

See Also:

Constant Field Values

JSON_PROPERTY_TIMEOUT_H

public static final String JSON_PROPERTY_TIMEOUT_H

See Also:

Constant Field Values

JSON_PROPERTY_VARIABLES

public static final String JSON_PROPERTY_VARIABLES

See Also:

Constant Field Values

Constructor Detail

MonitorOptions

public MonitorOptions()

Method Detail

getAggregation

@Nullable
public MonitorOptionsAggregation getAggregation()

Type of aggregation performed in the monitor query.

Returns:

aggregation

getDeviceIds

@Deprecated
 @Nullable
public List<MonitorDeviceID> getDeviceIds()

Deprecated.

IDs of the device the Synthetics monitor is running on.

Returns:

deviceIds

enableLogsSample

@Deprecated
public MonitorOptions enableLogsSample(Boolean enableLogsSample)

Deprecated.

getEnableLogsSample

@Nullable
public Boolean getEnableLogsSample()

Whether or not to send a log sample when the log monitor triggers.

Returns:

enableLogsSample

setEnableLogsSample

public void setEnableLogsSample(Boolean enableLogsSample)

enableSamples

public MonitorOptions enableSamples(Boolean enableSamples)

getEnableSamples

@Nullable
public Boolean getEnableSamples()

Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.

Returns:

enableSamples

setEnableSamples

public void setEnableSamples(Boolean enableSamples)

escalationMessage

public MonitorOptions escalationMessage(String escalationMessage)

getEscalationMessage

@Nullable
public String getEscalationMessage()

We recommend using the is_renotify, block in the original message instead. A message to include with a re-notification. Supports the @username notification we allow elsewhere. Not applicable if renotify_interval is None.

Returns:

escalationMessage

setEscalationMessage

public void setEscalationMessage(String escalationMessage)

evaluationDelay

public MonitorOptions evaluationDelay(Long evaluationDelay)

getEvaluationDelay

@Nullable
public Long getEvaluationDelay()

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

Returns:

evaluationDelay

getEvaluationDelay_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getEvaluationDelay_JsonNullable()

setEvaluationDelay_JsonNullable

public void setEvaluationDelay_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> evaluationDelay)

setEvaluationDelay

public void setEvaluationDelay(Long evaluationDelay)

groupRetentionDuration

public MonitorOptions groupRetentionDuration(String groupRetentionDuration)

getGroupRetentionDuration

@Nullable
public String getGroupRetentionDuration()

The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: "60m", "1h", and "2d". This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

Returns:

groupRetentionDuration

setGroupRetentionDuration

public void setGroupRetentionDuration(String groupRetentionDuration)

groupbySimpleMonitor

public MonitorOptions groupbySimpleMonitor(Boolean groupbySimpleMonitor)

getGroupbySimpleMonitor

@Nullable
public Boolean getGroupbySimpleMonitor()

Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold.

Returns:

groupbySimpleMonitor

setGroupbySimpleMonitor

public void setGroupbySimpleMonitor(Boolean groupbySimpleMonitor)

includeTags

public MonitorOptions includeTags(Boolean includeTags)

getIncludeTags

@Nullable
public Boolean getIncludeTags()

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title.

Examples - If True, [Triggered on {host:h1}] Monitor Title - If False, [Triggered] Monitor Title

Returns:

includeTags

setIncludeTags

public void setIncludeTags(Boolean includeTags)

locked

public MonitorOptions locked(Boolean locked)

getLocked

@Deprecated
 @Nullable
public Boolean getLocked()

Deprecated.

Whether or not the monitor is locked (only editable by creator and admins). Use restricted_roles instead.

Returns:

locked

setLocked

@Deprecated
public void setLocked(Boolean locked)

Deprecated.

minFailureDuration

public MonitorOptions minFailureDuration(Long minFailureDuration)

getMinFailureDuration

@Nullable
public Long getMinFailureDuration()

How long the test should be in failure before alerting (integer, number of seconds, max 7200). minimum: 0 maximum: 7200

Returns:

minFailureDuration

getMinFailureDuration_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getMinFailureDuration_JsonNullable()

setMinFailureDuration_JsonNullable

public void setMinFailureDuration_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> minFailureDuration)

setMinFailureDuration

public void setMinFailureDuration(Long minFailureDuration)

minLocationFailed

public MonitorOptions minLocationFailed(Long minLocationFailed)

getMinLocationFailed

@Nullable
public Long getMinLocationFailed()

The minimum number of locations in failure at the same time during at least one moment in the min_failure_duration period (min_location_failed and min_failure_duration are part of the advanced alerting rules - integer, >= 1).

Returns:

minLocationFailed

getMinLocationFailed_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getMinLocationFailed_JsonNullable()

setMinLocationFailed_JsonNullable

public void setMinLocationFailed_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> minLocationFailed)

setMinLocationFailed

public void setMinLocationFailed(Long minLocationFailed)

newGroupDelay

public MonitorOptions newGroupDelay(Long newGroupDelay)

getNewGroupDelay

@Nullable
public Long getNewGroupDelay()

Time (in seconds) to skip evaluations for new groups.

For example, this option can be used to skip evaluations for new hosts while they initialize.

Must be a non negative integer.

Returns:

newGroupDelay

getNewGroupDelay_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getNewGroupDelay_JsonNullable()

setNewGroupDelay_JsonNullable

public void setNewGroupDelay_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> newGroupDelay)

setNewGroupDelay

public void setNewGroupDelay(Long newGroupDelay)

newHostDelay

public MonitorOptions newHostDelay(Long newHostDelay)

getNewHostDelay

@Deprecated
 @Nullable
public Long getNewHostDelay()

Deprecated.

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer.

Use new_group_delay instead.

Returns:

newHostDelay

getNewHostDelay_JsonNullable

@Deprecated
public org.openapitools.jackson.nullable.JsonNullable<Long> getNewHostDelay_JsonNullable()

Deprecated.

setNewHostDelay_JsonNullable

public void setNewHostDelay_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> newHostDelay)

setNewHostDelay

public void setNewHostDelay(Long newHostDelay)

noDataTimeframe

public MonitorOptions noDataTimeframe(Long noDataTimeframe)

getNoDataTimeframe

@Nullable
public Long getNoDataTimeframe()

The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

Returns:

noDataTimeframe

getNoDataTimeframe_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getNoDataTimeframe_JsonNullable()

setNoDataTimeframe_JsonNullable

public void setNoDataTimeframe_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> noDataTimeframe)

setNoDataTimeframe

public void setNoDataTimeframe(Long noDataTimeframe)

notificationPresetName

public MonitorOptions notificationPresetName(MonitorOptionsNotificationPresets notificationPresetName)

getNotificationPresetName

@Nullable
public MonitorOptionsNotificationPresets getNotificationPresetName()

Toggles the display of additional content sent in the monitor notification.

Returns:

notificationPresetName

setNotificationPresetName

public void setNotificationPresetName(MonitorOptionsNotificationPresets notificationPresetName)

notifyAudit

public MonitorOptions notifyAudit(Boolean notifyAudit)

getNotifyAudit

@Nullable
public Boolean getNotifyAudit()

A Boolean indicating whether tagged users is notified on changes to this monitor.

Returns:

notifyAudit

setNotifyAudit

public void setNotifyAudit(Boolean notifyAudit)

notifyBy

public MonitorOptions notifyBy(List<String> notifyBy)

addNotifyByItem

public MonitorOptions addNotifyByItem(String notifyByItem)

getNotifyBy

@Nullable
public List<String> getNotifyBy()

Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ["cluster"]. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region . Setting notify_by to [*] configures the monitor to notify as a simple-alert.

Returns:

notifyBy

setNotifyBy

public void setNotifyBy(List<String> notifyBy)

notifyNoData

public MonitorOptions notifyNoData(Boolean notifyNoData)

getNotifyNoData

@Nullable
public Boolean getNotifyNoData()

A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to false.

Returns:

notifyNoData

setNotifyNoData

public void setNotifyNoData(Boolean notifyNoData)

onMissingData

public MonitorOptions onMissingData(OnMissingDataOption onMissingData)

getOnMissingData

@Nullable
public OnMissingDataOption getOnMissingData()

Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.

Returns:

onMissingData

setOnMissingData

public void setOnMissingData(OnMissingDataOption onMissingData)

renotifyInterval

public MonitorOptions renotifyInterval(Long renotifyInterval)

getRenotifyInterval

@Nullable
public Long getRenotifyInterval()

The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved.

Returns:

renotifyInterval

getRenotifyInterval_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getRenotifyInterval_JsonNullable()

setRenotifyInterval_JsonNullable

public void setRenotifyInterval_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> renotifyInterval)

setRenotifyInterval

public void setRenotifyInterval(Long renotifyInterval)

renotifyOccurrences

public MonitorOptions renotifyOccurrences(Long renotifyOccurrences)

getRenotifyOccurrences

@Nullable
public Long getRenotifyOccurrences()

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

Returns:

renotifyOccurrences

getRenotifyOccurrences_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getRenotifyOccurrences_JsonNullable()

setRenotifyOccurrences_JsonNullable

public void setRenotifyOccurrences_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> renotifyOccurrences)

setRenotifyOccurrences

public void setRenotifyOccurrences(Long renotifyOccurrences)

renotifyStatuses

public MonitorOptions renotifyStatuses(List<MonitorRenotifyStatusType> renotifyStatuses)

addRenotifyStatusesItem

public MonitorOptions addRenotifyStatusesItem(MonitorRenotifyStatusType renotifyStatusesItem)

getRenotifyStatuses

@Nullable
public List<MonitorRenotifyStatusType> getRenotifyStatuses()

The types of monitor statuses for which re-notification messages are sent. Default: null if renotify_interval is null. If renotify_interval is set, defaults to renotify on Alert and No Data .

Returns:

renotifyStatuses

getRenotifyStatuses_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<List<MonitorRenotifyStatusType>> getRenotifyStatuses_JsonNullable()

setRenotifyStatuses_JsonNullable

public void setRenotifyStatuses_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<MonitorRenotifyStatusType>> renotifyStatuses)

setRenotifyStatuses

public void setRenotifyStatuses(List<MonitorRenotifyStatusType> renotifyStatuses)

requireFullWindow

public MonitorOptions requireFullWindow(Boolean requireFullWindow)

getRequireFullWindow

@Nullable
public Boolean getRequireFullWindow()

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to false for sparse metrics, otherwise some evaluations are skipped. Default is false. This setting only applies to metric monitors.

Returns:

requireFullWindow

setRequireFullWindow

public void setRequireFullWindow(Boolean requireFullWindow)

schedulingOptions

public MonitorOptions schedulingOptions(MonitorOptionsSchedulingOptions schedulingOptions)

getSchedulingOptions

@Nullable
public MonitorOptionsSchedulingOptions getSchedulingOptions()

Configuration options for scheduling.

Returns:

schedulingOptions

setSchedulingOptions

public void setSchedulingOptions(MonitorOptionsSchedulingOptions schedulingOptions)

silenced

public MonitorOptions silenced(Map<String,Long> silenced)

putSilencedItem

public MonitorOptions putSilencedItem(String key,
                                      Long silencedItem)

getSilenced

@Deprecated
 @Nullable
public Map<String,Long> getSilenced()

Deprecated.

Information about the downtime applied to the monitor. Only shows v1 downtimes.

Returns:

silenced

setSilenced

@Deprecated
public void setSilenced(Map<String,Long> silenced)

Deprecated.

syntheticsCheckId

public MonitorOptions syntheticsCheckId(String syntheticsCheckId)

getSyntheticsCheckId

@Deprecated
 @Nullable
public String getSyntheticsCheckId()

Deprecated.

ID of the corresponding Synthetic check.

Returns:

syntheticsCheckId

getSyntheticsCheckId_JsonNullable

@Deprecated
public org.openapitools.jackson.nullable.JsonNullable<String> getSyntheticsCheckId_JsonNullable()

Deprecated.

setSyntheticsCheckId_JsonNullable

public void setSyntheticsCheckId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> syntheticsCheckId)

setSyntheticsCheckId

public void setSyntheticsCheckId(String syntheticsCheckId)

thresholdWindows

public MonitorOptions thresholdWindows(MonitorThresholdWindowOptions thresholdWindows)

getThresholdWindows

@Nullable
public MonitorThresholdWindowOptions getThresholdWindows()

Alerting time window options.

Returns:

thresholdWindows

setThresholdWindows

public void setThresholdWindows(MonitorThresholdWindowOptions thresholdWindows)

thresholds

public MonitorOptions thresholds(MonitorThresholds thresholds)

getThresholds

@Nullable
public MonitorThresholds getThresholds()

List of the different monitor threshold available.

Returns:

thresholds

setThresholds

public void setThresholds(MonitorThresholds thresholds)

timeoutH

public MonitorOptions timeoutH(Long timeoutH)

getTimeoutH

@Nullable
public Long getTimeoutH()

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

Returns:

timeoutH

getTimeoutH_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getTimeoutH_JsonNullable()

setTimeoutH_JsonNullable

public void setTimeoutH_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> timeoutH)

setTimeoutH

public void setTimeoutH(Long timeoutH)

variables

public MonitorOptions variables(List<MonitorFormulaAndFunctionQueryDefinition> variables)

addVariablesItem

public MonitorOptions addVariablesItem(MonitorFormulaAndFunctionQueryDefinition variablesItem)

getVariables

@Nullable
public List<MonitorFormulaAndFunctionQueryDefinition> getVariables()

List of requests that can be used in the monitor query. This feature is currently in beta.

Returns:

variables

setVariables

public void setVariables(List<MonitorFormulaAndFunctionQueryDefinition> variables)

putAdditionalProperty

public MonitorOptions 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:

MonitorOptions

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 MonitorOptions 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