Class: DatadogAPIClient::V1::ServiceLevelObjectiveRequest

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

Overview

A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (‘name`, `description`, `tags`, etc.).

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



79
80
81
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 79

def additional_properties
  @additional_properties
end

#description ⇒ Object

A user-defined description of the service level objective.

Always included in service level objective responses (but may be ‘null`). Optional in create/update requests.



29
30
31
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 29

def description
  @description
end

#groups ⇒ Object

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the ‘monitor_ids` field is one.



36
37
38
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 36

def groups
  @groups
end

#monitor_ids ⇒ Object

A list of monitor IDs that defines the scope of a monitor service level objective. **Required if type is ‘monitor`**.



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

def monitor_ids
  @monitor_ids
end

#name ⇒ Object

The name of the service level objective object.



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

def name
  @name
end

#query ⇒ Object

A metric-based SLO. **Required if type is ‘metric`**. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.



48
49
50
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 48

def query
  @query
end

#sli_specification ⇒ Object

A generic SLI specification. This is currently used for time-slice SLOs only.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 51

def sli_specification
  @sli_specification
end

#tags ⇒ Object

A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests.



56
57
58
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 56

def tags
  @tags
end

#target_threshold ⇒ Object

The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met.



60
61
62
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 60

def target_threshold
  @target_threshold
end

#thresholds ⇒ Object

The thresholds (timeframes and associated targets) for this service level objective object.



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

def thresholds
  @thresholds
end

#timeframe ⇒ Object

The SLO time window options. Note that “custom” is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes.



68
69
70
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 68

def timeframe
  @timeframe
end

#type ⇒ Object

The type of the service level objective.



71
72
73
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 71

def type
  @type
end

#warning_threshold ⇒ Object

The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a “warning” state. This value must be greater than the target threshold.



77
78
79
 
# File 'lib/datadog_api_client/v1/models/service_level_objective_request.rb', line 77

def warning_threshold
  @warning_threshold
end