Class: DatadogAPIClient::V1::Monitor

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

Overview

Object describing a monitor.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



75
76
77
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 75

def additional_properties
  @additional_properties
end

#created ⇒ Object

Timestamp of the monitor creation.



25
26
27
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 25

def created
  @created
end

#creator ⇒ Object

Object describing the creator of the shared element.



28
29
30
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 28

def creator
  @creator
end

#deleted ⇒ Object

Whether or not the monitor is deleted. (Always ‘null`)



31
32
33
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 31

def deleted
  @deleted
end

#id ⇒ Object

ID of this monitor.



34
35
36
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 34

def id
  @id
end

#matching_downtimes ⇒ Object

A list of active v1 downtimes that match this monitor.



37
38
39
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 37

def matching_downtimes
  @matching_downtimes
end

#message ⇒ Object

A message to include with notifications for this monitor.



40
41
42
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 40

def message
  @message
end

#modified ⇒ Object

Last timestamp when the monitor was edited.



43
44
45
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 43

def modified
  @modified
end

#multi ⇒ Object

Whether or not the monitor is broken down on different groups.



46
47
48
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 46

def multi
  @multi
end

#name ⇒ Object

The monitor name.



49
50
51
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 49

def name
  @name
end

#options ⇒ Object

List of options associated with your monitor.



52
53
54
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 52

def options
  @options
end

#overall_state ⇒ Object

The different states your monitor can be in.



55
56
57
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 55

def overall_state
  @overall_state
end

#priority ⇒ Object

Integer from 1 (high) to 5 (low) indicating alert severity.



58
59
60
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 58

def priority
  @priority
end

#query ⇒ Object

The monitor query.



61
62
63
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 61

def query
  @query
end

#restricted_roles ⇒ Object

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](docs.datadoghq.com/api/latest/roles/#list-roles) 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](docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles.



64
65
66
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 64

def restricted_roles
  @restricted_roles
end

#state ⇒ Object

Wrapper object with the different monitor states.



67
68
69
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 67

def state
  @state
end

#tags ⇒ Object

Tags associated to your monitor.



70
71
72
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 70

def tags
  @tags
end

#type ⇒ Object

The type of the monitor. For more information about ‘type`, see the [monitor options](docs.datadoghq.com/monitors/guide/monitor_api_options/) docs.



73
74
75
 
# File 'lib/datadog_api_client/v1/models/monitor.rb', line 73

def type
  @type
end