Package com.datadog.api.client.v1.model
Class Downtime
java.lang.Object
com.datadog.api.client.v1.model.Downtime
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class Downtime
extends Object
Downtiming gives you greater control over monitor notifications by allowing you to globally
exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times,
prevent all alerting related to specified Datadog tags.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringboolean -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddMonitorTagsItem(String monitorTagsItem) addNotifyEndStatesItem(NotifyEndState notifyEndStatesItem) addNotifyEndTypesItem(NotifyEndType notifyEndTypesItem) addScopeItem(String scopeItem) booleanReturn true if this Downtime object is equal to o.If a scheduled downtime currently exists.The downtime object definition of the active child for the original parent recurring downtime.org.openapitools.jackson.nullable.JsonNullable<DowntimeChild>Return the additional (undeclared) property.Return the additional (undeclared) property with the specified name.If a scheduled downtime is canceled.org.openapitools.jackson.nullable.JsonNullable<Long>User ID of the downtime creator.If a downtime has been disabled.0for a downtime applied on*or all,1when the downtime is only scoped to hosts, or2when the downtime is scoped to anything but hosts.getEnd()POSIX timestamp to end the downtime.org.openapitools.jackson.nullable.JsonNullable<Long>getId()The downtime ID.A message to include with notifications for this downtime.org.openapitools.jackson.nullable.JsonNullable<String>A single monitor to which the downtime applies.org.openapitools.jackson.nullable.JsonNullable<Long>A comma-separated list of monitor tags.If the first recovery notification during a downtime should be muted.States for whichnotify_end_typessends out notifications for.If set, notifies if a monitor is in an alert-worthy state (ALERT,WARNING, orNO DATA) when this downtime expires or is canceled.ID of the parent Downtime.org.openapitools.jackson.nullable.JsonNullable<Long>An object defining the recurrence of the downtime.org.openapitools.jackson.nullable.JsonNullable<DowntimeRecurrence>getScope()The scope(s) to which the downtime applies and must be inkey:valueformat.getStart()POSIX timestamp to start the downtime.The timezone in which to display the downtime's start and end times in Datadog applications.ID of the last user that updated the downtime.org.openapitools.jackson.nullable.JsonNullable<Integer>inthashCode()monitorTags(List<String> monitorTags) muteFirstRecoveryNotification(Boolean muteFirstRecoveryNotification) notifyEndStates(List<NotifyEndState> notifyEndStates) notifyEndTypes(List<NotifyEndType> notifyEndTypes) putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.recurrence(DowntimeRecurrence recurrence) voidsetDisabled(Boolean disabled) voidvoidsetEnd_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> end) voidsetMessage(String message) voidsetMessage_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> message) voidsetMonitorId(Long monitorId) voidsetMonitorId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> monitorId) voidsetMonitorTags(List<String> monitorTags) voidsetMuteFirstRecoveryNotification(Boolean muteFirstRecoveryNotification) voidsetNotifyEndStates(List<NotifyEndState> notifyEndStates) voidsetNotifyEndTypes(List<NotifyEndType> notifyEndTypes) voidsetParentId(Long parentId) voidsetParentId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> parentId) voidsetRecurrence(DowntimeRecurrence recurrence) voidsetRecurrence_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<DowntimeRecurrence> recurrence) voidvoidvoidsetTimezone(String timezone) toString()
-
Field Details
-
unparsed
public boolean unparsed -
JSON_PROPERTY_ACTIVE
- See Also:
-
JSON_PROPERTY_ACTIVE_CHILD
- See Also:
-
JSON_PROPERTY_CANCELED
- See Also:
-
JSON_PROPERTY_CREATOR_ID
- See Also:
-
JSON_PROPERTY_DISABLED
- See Also:
-
JSON_PROPERTY_DOWNTIME_TYPE
- See Also:
-
JSON_PROPERTY_END
- See Also:
-
JSON_PROPERTY_ID
- See Also:
-
JSON_PROPERTY_MESSAGE
- See Also:
-
JSON_PROPERTY_MONITOR_ID
- See Also:
-
JSON_PROPERTY_MONITOR_TAGS
- See Also:
-
JSON_PROPERTY_MUTE_FIRST_RECOVERY_NOTIFICATION
- See Also:
-
JSON_PROPERTY_NOTIFY_END_STATES
- See Also:
-
JSON_PROPERTY_NOTIFY_END_TYPES
- See Also:
-
JSON_PROPERTY_PARENT_ID
- See Also:
-
JSON_PROPERTY_RECURRENCE
- See Also:
-
JSON_PROPERTY_SCOPE
- See Also:
-
JSON_PROPERTY_START
- See Also:
-
JSON_PROPERTY_TIMEZONE
- See Also:
-
JSON_PROPERTY_UPDATER_ID
- See Also:
-
-
Constructor Details
-
Downtime
public Downtime()
-
-
Method Details
-
getActive
If a scheduled downtime currently exists.- Returns:
- active
-
getActiveChild
The downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.- Returns:
- activeChild
-
getActiveChild_JsonNullable
-
getCanceled
If a scheduled downtime is canceled.- Returns:
- canceled
-
getCanceled_JsonNullable
-
getCreatorId
User ID of the downtime creator. maximum: 2147483647- Returns:
- creatorId
-
disabled
-
getDisabled
If a downtime has been disabled.- Returns:
- disabled
-
setDisabled
-
getDowntimeType
0for a downtime applied on*or all,1when the downtime is only scoped to hosts, or2when the downtime is scoped to anything but hosts. maximum: 2147483647- Returns:
- downtimeType
-
end
-
getEnd
POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it.- Returns:
- end
-
getEnd_JsonNullable
-
setEnd_JsonNullable
-
setEnd
-
getId
The downtime ID.- Returns:
- id
-
message
-
getMessage
A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same@usernamenotation as events.- Returns:
- message
-
getMessage_JsonNullable
-
setMessage_JsonNullable
-
setMessage
-
monitorId
-
getMonitorId
A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors.- Returns:
- monitorId
-
getMonitorId_JsonNullable
-
setMonitorId_JsonNullable
public void setMonitorId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> monitorId) -
setMonitorId
-
monitorTags
-
addMonitorTagsItem
-
getMonitorTags
A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example,service:postgresANDteam:frontend.- Returns:
- monitorTags
-
setMonitorTags
-
muteFirstRecoveryNotification
-
getMuteFirstRecoveryNotification
If the first recovery notification during a downtime should be muted.- Returns:
- muteFirstRecoveryNotification
-
setMuteFirstRecoveryNotification
-
notifyEndStates
-
addNotifyEndStatesItem
-
getNotifyEndStates
States for whichnotify_end_typessends out notifications for.- Returns:
- notifyEndStates
-
setNotifyEndStates
-
notifyEndTypes
-
addNotifyEndTypesItem
-
getNotifyEndTypes
If set, notifies if a monitor is in an alert-worthy state (ALERT,WARNING, orNO DATA) when this downtime expires or is canceled. Applied to monitors that change states during the downtime (such as fromOKtoALERT,WARNING, orNO DATA), and to monitors that already have an alert-worthy state when downtime begins.- Returns:
- notifyEndTypes
-
setNotifyEndTypes
-
parentId
-
getParentId
ID of the parent Downtime.- Returns:
- parentId
-
getParentId_JsonNullable
-
setParentId_JsonNullable
-
setParentId
-
recurrence
-
getRecurrence
An object defining the recurrence of the downtime.- Returns:
- recurrence
-
getRecurrence_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<DowntimeRecurrence> getRecurrence_JsonNullable() -
setRecurrence_JsonNullable
public void setRecurrence_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<DowntimeRecurrence> recurrence) -
setRecurrence
-
scope
-
addScopeItem
-
getScope
The scope(s) to which the downtime applies and must be inkey:valueformat. For example,host:app2. Provide multiple scopes as a comma-separated list likeenv:dev,env:prod. The resulting downtime applies to sources that matches ALL provided scopes (env:devANDenv:prod).- Returns:
- scope
-
setScope
-
start
-
getStart
POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created.- Returns:
- start
-
setStart
-
timezone
-
getTimezone
The timezone in which to display the downtime's start and end times in Datadog applications.- Returns:
- timezone
-
setTimezone
-
getUpdaterId
ID of the last user that updated the downtime. maximum: 2147483647- Returns:
- updaterId
-
getUpdaterId_JsonNullable
-
putAdditionalProperty
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 setvalue- The associated value- Returns:
- Downtime
-
getAdditionalProperties
Return the additional (undeclared) property.- Returns:
- The additional properties
-
getAdditionalProperty
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
Return true if this Downtime object is equal to o. -
hashCode
public int hashCode() -
toString
-