Monitor (datadog-api-client 2.56.0 API)

java.lang.Object
- com.datadog.api.client.v1.model.Monitor

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

Object describing a monitor.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_ASSETS`
`static String`	`JSON_PROPERTY_CREATED`
`static String`	`JSON_PROPERTY_CREATOR`
`static String`	`JSON_PROPERTY_DELETED`
`static String`	`JSON_PROPERTY_DRAFT_STATUS`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_MATCHING_DOWNTIMES`
`static String`	`JSON_PROPERTY_MESSAGE`
`static String`	`JSON_PROPERTY_MODIFIED`
`static String`	`JSON_PROPERTY_MULTI`
`static String`	`JSON_PROPERTY_NAME`
`static String`	`JSON_PROPERTY_OPTIONS`
`static String`	`JSON_PROPERTY_OVERALL_STATE`
`static String`	`JSON_PROPERTY_PRIORITY`
`static String`	`JSON_PROPERTY_QUERY`
`static String`	`JSON_PROPERTY_RESTRICTED_ROLES`
`static String`	`JSON_PROPERTY_STATE`
`static String`	`JSON_PROPERTY_TAGS`
`static String`	`JSON_PROPERTY_TYPE`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

Monitor()

Monitor(String query, MonitorType type)

Constructors
Constructor and Description
`Monitor()`
`Monitor(String query, MonitorType type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Monitor`	`addAssetsItem(MonitorAsset assetsItem)`
`Monitor`	`addMatchingDowntimesItem(MatchingDowntime matchingDowntimesItem)`
`Monitor`	`addRestrictedRolesItem(String restrictedRolesItem)`
`Monitor`	`addTagsItem(String tagsItem)`
`Monitor`	`assets(List<MonitorAsset> assets)`
`Monitor`	`draftStatus(MonitorDraftStatus draftStatus)`
`boolean`	`equals(Object o)` Return true if this Monitor 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.
`List<MonitorAsset>`	`getAssets()` The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks).
`OffsetDateTime`	`getCreated()` Timestamp of the monitor creation.
`Creator`	`getCreator()` Object describing the creator of the shared element.
`org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime>`	`getDeleted_JsonNullable()`
`OffsetDateTime`	`getDeleted()` Whether or not the monitor is deleted.
`MonitorDraftStatus`	`getDraftStatus()` Indicates whether the monitor is in a draft or published state.
`Long`	`getId()` ID of this monitor.
`List<MatchingDowntime>`	`getMatchingDowntimes()` A list of active v1 downtimes that match this monitor.
`String`	`getMessage()` A message to include with notifications for this monitor.
`OffsetDateTime`	`getModified()` Last timestamp when the monitor was edited.
`Boolean`	`getMulti()` Whether or not the monitor is broken down on different groups.
`String`	`getName()` The monitor name.
`MonitorOptions`	`getOptions()` List of options associated with your monitor.
`MonitorOverallStates`	`getOverallState()` The different states your monitor can be in.
`org.openapitools.jackson.nullable.JsonNullable<Long>`	`getPriority_JsonNullable()`
`Long`	`getPriority()` Integer from 1 (high) to 5 (low) indicating alert severity.
`String`	`getQuery()` The monitor query.
`org.openapitools.jackson.nullable.JsonNullable<List<String>>`	`getRestrictedRoles_JsonNullable()`
`List<String>`	`getRestrictedRoles()` A list of unique role identifiers to define which roles are allowed to edit the monitor.
`MonitorState`	`getState()` Wrapper object with the different monitor states.
`List<String>`	`getTags()` Tags associated to your monitor.
`MonitorType`	`getType()` The type of the monitor.
`int`	`hashCode()`
`Monitor`	`matchingDowntimes(List<MatchingDowntime> matchingDowntimes)`
`Monitor`	`message(String message)`
`Monitor`	`name(String name)`
`Monitor`	`options(MonitorOptions options)`
`Monitor`	`priority(Long priority)`
`Monitor`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`Monitor`	`query(String query)`
`Monitor`	`restrictedRoles(List<String> restrictedRoles)`
`void`	`setAssets(List<MonitorAsset> assets)`
`void`	`setDraftStatus(MonitorDraftStatus draftStatus)`
`void`	`setMatchingDowntimes(List<MatchingDowntime> matchingDowntimes)`
`void`	`setMessage(String message)`
`void`	`setName(String name)`
`void`	`setOptions(MonitorOptions options)`
`void`	`setPriority_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> priority)`
`void`	`setPriority(Long priority)`
`void`	`setQuery(String query)`
`void`	`setRestrictedRoles_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> restrictedRoles)`
`void`	`setRestrictedRoles(List<String> restrictedRoles)`
`void`	`setTags(List<String> tags)`
`void`	`setType(MonitorType type)`
`Monitor`	`tags(List<String> tags)`
`String`	`toString()`
`Monitor`	`type(MonitorType type)`

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

- Field Detail
  - unparsed
```
public boolean unparsed
```
  - JSON_PROPERTY_ASSETS
```
public static final String JSON_PROPERTY_ASSETS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CREATED
```
public static final String JSON_PROPERTY_CREATED
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CREATOR
```
public static final String JSON_PROPERTY_CREATOR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DELETED
```
public static final String JSON_PROPERTY_DELETED
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DRAFT_STATUS
```
public static final String JSON_PROPERTY_DRAFT_STATUS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ID
```
public static final String JSON_PROPERTY_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MATCHING_DOWNTIMES
```
public static final String JSON_PROPERTY_MATCHING_DOWNTIMES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MESSAGE
```
public static final String JSON_PROPERTY_MESSAGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MODIFIED
```
public static final String JSON_PROPERTY_MODIFIED
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MULTI
```
public static final String JSON_PROPERTY_MULTI
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NAME
```
public static final String JSON_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_OPTIONS
```
public static final String JSON_PROPERTY_OPTIONS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_OVERALL_STATE
```
public static final String JSON_PROPERTY_OVERALL_STATE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PRIORITY
```
public static final String JSON_PROPERTY_PRIORITY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_QUERY
```
public static final String JSON_PROPERTY_QUERY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RESTRICTED_ROLES
```
public static final String JSON_PROPERTY_RESTRICTED_ROLES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STATE
```
public static final String JSON_PROPERTY_STATE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TAGS
```
public static final String JSON_PROPERTY_TAGS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Monitor
```
public Monitor()
```
  - Monitor
```
public Monitor(String query,
               MonitorType type)
```
- Method Detail
  - assets
```
public Monitor assets(List<MonitorAsset> assets)
```
  - addAssetsItem
```
public Monitor addAssetsItem(MonitorAsset assetsItem)
```
  - getAssets
```
@Nullable
public List<MonitorAsset> getAssets()
```
    The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks).
    
    Returns:
    
    assets
  - setAssets
```
public void setAssets(List<MonitorAsset> assets)
```
  - getCreated
```
@Nullable
public OffsetDateTime getCreated()
```
    Timestamp of the monitor creation.
    
    Returns:
    
    created
  - getCreator
```
@Nullable
public Creator getCreator()
```
    Object describing the creator of the shared element.
    
    Returns:
    
    creator
  - getDeleted
```
@Nullable
public OffsetDateTime getDeleted()
```
    Whether or not the monitor is deleted. (Always null)
    
    Returns:
    
    deleted
  - getDeleted_JsonNullable
```
public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getDeleted_JsonNullable()
```
  - draftStatus
```
public Monitor draftStatus(MonitorDraftStatus draftStatus)
```
  - getDraftStatus
```
@Nullable
public MonitorDraftStatus getDraftStatus()
```
    Indicates whether the monitor is in a draft or published state.
    draft: The monitor appears as Draft and does not send notifications. published: The monitor is active and evaluates conditions and notify as configured.
    This field is in preview. The draft value is only available to customers with the feature enabled.
    
    Returns:
    
    draftStatus
  - setDraftStatus
```
public void setDraftStatus(MonitorDraftStatus draftStatus)
```
  - getId
```
@Nullable
public Long getId()
```
    ID of this monitor.
    
    Returns:
    
    id
  - matchingDowntimes
```
public Monitor matchingDowntimes(List<MatchingDowntime> matchingDowntimes)
```
  - addMatchingDowntimesItem
```
public Monitor addMatchingDowntimesItem(MatchingDowntime matchingDowntimesItem)
```
  - getMatchingDowntimes
```
@Nullable
public List<MatchingDowntime> getMatchingDowntimes()
```
    A list of active v1 downtimes that match this monitor.
    
    Returns:
    
    matchingDowntimes
  - setMatchingDowntimes
```
public void setMatchingDowntimes(List<MatchingDowntime> matchingDowntimes)
```
  - message
```
public Monitor message(String message)
```
  - getMessage
```
@Nullable
public String getMessage()
```
    A message to include with notifications for this monitor.
    
    Returns:
    
    message
  - setMessage
```
public void setMessage(String message)
```
  - getModified
```
@Nullable
public OffsetDateTime getModified()
```
    Last timestamp when the monitor was edited.
    
    Returns:
    
    modified
  - getMulti
```
@Nullable
public Boolean getMulti()
```
    Whether or not the monitor is broken down on different groups.
    
    Returns:
    
    multi
  - name
```
public Monitor name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    The monitor name.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - options
```
public Monitor options(MonitorOptions options)
```
  - getOptions
```
@Nullable
public MonitorOptions getOptions()
```
    List of options associated with your monitor.
    
    Returns:
    
    options
  - setOptions
```
public void setOptions(MonitorOptions options)
```
  - getOverallState
```
@Nullable
public MonitorOverallStates getOverallState()
```
    The different states your monitor can be in.
    
    Returns:
    
    overallState
  - priority
```
public Monitor priority(Long priority)
```
  - getPriority
```
@Nullable
public Long getPriority()
```
    Integer from 1 (high) to 5 (low) indicating alert severity.
    
    Returns:
    
    priority
  - getPriority_JsonNullable
```
public org.openapitools.jackson.nullable.JsonNullable<Long> getPriority_JsonNullable()
```
  - setPriority_JsonNullable
```
public void setPriority_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> priority)
```
  - setPriority
```
public void setPriority(Long priority)
```
  - query
```
public Monitor query(String query)
```
  - getQuery
```
public String getQuery()
```
    The monitor query.
    
    Returns:
    
    query
  - setQuery
```
public void setQuery(String query)
```
  - restrictedRoles
```
public Monitor restrictedRoles(List<String> restrictedRoles)
```
  - addRestrictedRolesItem
```
public Monitor addRestrictedRolesItem(String restrictedRolesItem)
```
  - getRestrictedRoles
```
@Nullable
public List<String> getRestrictedRoles()
```
    A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.
    
    Returns:
    
    restrictedRoles
  - getRestrictedRoles_JsonNullable
```
public org.openapitools.jackson.nullable.JsonNullable<List<String>> getRestrictedRoles_JsonNullable()
```
  - setRestrictedRoles_JsonNullable
```
public void setRestrictedRoles_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> restrictedRoles)
```
  - setRestrictedRoles
```
public void setRestrictedRoles(List<String> restrictedRoles)
```
  - getState
```
@Nullable
public MonitorState getState()
```
    Wrapper object with the different monitor states.
    
    Returns:
    
    state
  - tags
```
public Monitor tags(List<String> tags)
```
  - addTagsItem
```
public Monitor addTagsItem(String tagsItem)
```
  - getTags
```
@Nullable
public List<String> getTags()
```
    Tags associated to your monitor.
    
    Returns:
    
    tags
  - setTags
```
public void setTags(List<String> tags)
```
  - type
```
public Monitor type(MonitorType type)
```
  - getType
```
public MonitorType getType()
```
    The type of the monitor. For more information about type, see the monitor options docs.
    
    Returns:
    
    type
  - setType
```
public void setType(MonitorType type)
```
  - putAdditionalProperty
```
public Monitor 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:
    
    Monitor
  - 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 Monitor 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 Monitor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_ASSETS

JSON_PROPERTY_CREATED

JSON_PROPERTY_CREATOR

JSON_PROPERTY_DELETED

JSON_PROPERTY_DRAFT_STATUS

JSON_PROPERTY_ID

JSON_PROPERTY_MATCHING_DOWNTIMES

JSON_PROPERTY_MESSAGE

JSON_PROPERTY_MODIFIED

JSON_PROPERTY_MULTI

JSON_PROPERTY_NAME

JSON_PROPERTY_OPTIONS

JSON_PROPERTY_OVERALL_STATE

JSON_PROPERTY_PRIORITY

JSON_PROPERTY_QUERY

JSON_PROPERTY_RESTRICTED_ROLES

JSON_PROPERTY_STATE

JSON_PROPERTY_TAGS

JSON_PROPERTY_TYPE

Constructor Detail

Monitor

Monitor

Method Detail

assets

addAssetsItem

getAssets

setAssets

getCreated

getCreator

getDeleted

getDeleted_JsonNullable

draftStatus

getDraftStatus

setDraftStatus

getId

matchingDowntimes

addMatchingDowntimesItem

getMatchingDowntimes

setMatchingDowntimes

message

getMessage

setMessage

getModified

getMulti

name

getName

setName

options

getOptions

setOptions

getOverallState

priority

getPriority

getPriority_JsonNullable

setPriority_JsonNullable

setPriority

query

getQuery

setQuery

restrictedRoles

addRestrictedRolesItem

getRestrictedRoles

getRestrictedRoles_JsonNullable

setRestrictedRoles_JsonNullable

setRestrictedRoles

getState

tags

addTagsItem

getTags

setTags

type

getType

setType