ServiceLevelObjectiveRequest (datadog-api-client 2.27.0 API)

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

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

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

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_GROUPS`
`static String`	`JSON_PROPERTY_MONITOR_IDS`
`static String`	`JSON_PROPERTY_NAME`
`static String`	`JSON_PROPERTY_QUERY`
`static String`	`JSON_PROPERTY_SLI_SPECIFICATION`
`static String`	`JSON_PROPERTY_TAGS`
`static String`	`JSON_PROPERTY_TARGET_THRESHOLD`
`static String`	`JSON_PROPERTY_THRESHOLDS`
`static String`	`JSON_PROPERTY_TIMEFRAME`
`static String`	`JSON_PROPERTY_TYPE`
`static String`	`JSON_PROPERTY_WARNING_THRESHOLD`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description
`ServiceLevelObjectiveRequest()`
`ServiceLevelObjectiveRequest(String name, List<SLOThreshold> thresholds, SLOType type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceLevelObjectiveRequest`	`addGroupsItem(String groupsItem)`
`ServiceLevelObjectiveRequest`	`addMonitorIdsItem(Long monitorIdsItem)`
`ServiceLevelObjectiveRequest`	`addTagsItem(String tagsItem)`
`ServiceLevelObjectiveRequest`	`addThresholdsItem(SLOThreshold thresholdsItem)`
`ServiceLevelObjectiveRequest`	`description(String description)`
`boolean`	`equals(Object o)` Return true if this ServiceLevelObjectiveRequest 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.
`org.openapitools.jackson.nullable.JsonNullable<String>`	`getDescription_JsonNullable()`
`String`	`getDescription()` A user-defined description of the service level objective.
`List<String>`	`getGroups()` A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
`List<Long>`	`getMonitorIds()` A list of monitor IDs that defines the scope of a monitor service level objective.
`String`	`getName()` The name of the service level objective object.
`ServiceLevelObjectiveQuery`	`getQuery()` A metric-based SLO.
`SLOSliSpec`	`getSliSpecification()` A generic SLI specification.
`List<String>`	`getTags()` A list of tags associated with this service level objective.
`Double`	`getTargetThreshold()` The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met.
`List<SLOThreshold>`	`getThresholds()` The thresholds (timeframes and associated targets) for this service level objective object.
`SLOTimeframe`	`getTimeframe()` The SLO time window options.
`SLOType`	`getType()` The type of the service level objective.
`Double`	`getWarningThreshold()` 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.
`ServiceLevelObjectiveRequest`	`groups(List<String> groups)`
`int`	`hashCode()`
`ServiceLevelObjectiveRequest`	`monitorIds(List<Long> monitorIds)`
`ServiceLevelObjectiveRequest`	`name(String name)`
`ServiceLevelObjectiveRequest`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`ServiceLevelObjectiveRequest`	`query(ServiceLevelObjectiveQuery query)`
`void`	`setDescription_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> description)`
`void`	`setDescription(String description)`
`void`	`setGroups(List<String> groups)`
`void`	`setMonitorIds(List<Long> monitorIds)`
`void`	`setName(String name)`
`void`	`setQuery(ServiceLevelObjectiveQuery query)`
`void`	`setSliSpecification(SLOSliSpec sliSpecification)`
`void`	`setTags(List<String> tags)`
`void`	`setTargetThreshold(Double targetThreshold)`
`void`	`setThresholds(List<SLOThreshold> thresholds)`
`void`	`setTimeframe(SLOTimeframe timeframe)`
`void`	`setType(SLOType type)`
`void`	`setWarningThreshold(Double warningThreshold)`
`ServiceLevelObjectiveRequest`	`sliSpecification(SLOSliSpec sliSpecification)`
`ServiceLevelObjectiveRequest`	`tags(List<String> tags)`
`ServiceLevelObjectiveRequest`	`targetThreshold(Double targetThreshold)`
`ServiceLevelObjectiveRequest`	`thresholds(List<SLOThreshold> thresholds)`
`ServiceLevelObjectiveRequest`	`timeframe(SLOTimeframe timeframe)`
`String`	`toString()`
`ServiceLevelObjectiveRequest`	`type(SLOType type)`
`ServiceLevelObjectiveRequest`	`warningThreshold(Double warningThreshold)`

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

- Field Detail
  - unparsed
```
public boolean unparsed
```
  - JSON_PROPERTY_DESCRIPTION
```
public static final String JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_GROUPS
```
public static final String JSON_PROPERTY_GROUPS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MONITOR_IDS
```
public static final String JSON_PROPERTY_MONITOR_IDS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NAME
```
public static final String JSON_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_QUERY
```
public static final String JSON_PROPERTY_QUERY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SLI_SPECIFICATION
```
public static final String JSON_PROPERTY_SLI_SPECIFICATION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TAGS
```
public static final String JSON_PROPERTY_TAGS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TARGET_THRESHOLD
```
public static final String JSON_PROPERTY_TARGET_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_THRESHOLDS
```
public static final String JSON_PROPERTY_THRESHOLDS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TIMEFRAME
```
public static final String JSON_PROPERTY_TIMEFRAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_WARNING_THRESHOLD
```
public static final String JSON_PROPERTY_WARNING_THRESHOLD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ServiceLevelObjectiveRequest
```
public ServiceLevelObjectiveRequest()
```
  - ServiceLevelObjectiveRequest
```
public ServiceLevelObjectiveRequest(String name,
                                    List<SLOThreshold> thresholds,
                                    SLOType type)
```
- Method Detail
  - description
```
public ServiceLevelObjectiveRequest description(String description)
```
  - getDescription
```
@Nullable
public String getDescription()
```
    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.
    
    Returns:
    
    description
  - getDescription_JsonNullable
```
public org.openapitools.jackson.nullable.JsonNullable<String> getDescription_JsonNullable()
```
  - setDescription_JsonNullable
```
public void setDescription_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> description)
```
  - setDescription
```
public void setDescription(String description)
```
  - groups
```
public ServiceLevelObjectiveRequest groups(List<String> groups)
```
  - addGroupsItem
```
public ServiceLevelObjectiveRequest addGroupsItem(String groupsItem)
```
  - getGroups
```
@Nullable
public List<String> getGroups()
```
    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.
    
    Returns:
    
    groups
  - setGroups
```
public void setGroups(List<String> groups)
```
  - monitorIds
```
public ServiceLevelObjectiveRequest monitorIds(List<Long> monitorIds)
```
  - addMonitorIdsItem
```
public ServiceLevelObjectiveRequest addMonitorIdsItem(Long monitorIdsItem)
```
  - getMonitorIds
```
@Nullable
public List<Long> getMonitorIds()
```
    A list of monitor IDs that defines the scope of a monitor service level objective. Required if type is monitor.
    
    Returns:
    
    monitorIds
  - setMonitorIds
```
public void setMonitorIds(List<Long> monitorIds)
```
  - name
```
public ServiceLevelObjectiveRequest name(String name)
```
  - getName
```
public String getName()
```
    The name of the service level objective object.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - query
```
public ServiceLevelObjectiveRequest query(ServiceLevelObjectiveQuery query)
```
  - getQuery
```
@Nullable
public ServiceLevelObjectiveQuery getQuery()
```
    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.
    
    Returns:
    
    query
  - setQuery
```
public void setQuery(ServiceLevelObjectiveQuery query)
```
  - sliSpecification
```
public ServiceLevelObjectiveRequest sliSpecification(SLOSliSpec sliSpecification)
```
  - getSliSpecification
```
@Nullable
public SLOSliSpec getSliSpecification()
```
    A generic SLI specification. This is currently used for time-slice SLOs only.
    
    Returns:
    
    sliSpecification
  - setSliSpecification
```
public void setSliSpecification(SLOSliSpec sliSpecification)
```
  - tags
```
public ServiceLevelObjectiveRequest tags(List<String> tags)
```
  - addTagsItem
```
public ServiceLevelObjectiveRequest addTagsItem(String tagsItem)
```
  - getTags
```
@Nullable
public List<String> getTags()
```
    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.
    
    Returns:
    
    tags
  - setTags
```
public void setTags(List<String> tags)
```
  - targetThreshold
```
public ServiceLevelObjectiveRequest targetThreshold(Double targetThreshold)
```
  - getTargetThreshold
```
@Nullable
public Double getTargetThreshold()
```
    The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met.
    
    Returns:
    
    targetThreshold
  - setTargetThreshold
```
public void setTargetThreshold(Double targetThreshold)
```
  - thresholds
```
public ServiceLevelObjectiveRequest thresholds(List<SLOThreshold> thresholds)
```
  - addThresholdsItem
```
public ServiceLevelObjectiveRequest addThresholdsItem(SLOThreshold thresholdsItem)
```
  - getThresholds
```
public List<SLOThreshold> getThresholds()
```
    The thresholds (timeframes and associated targets) for this service level objective object.
    
    Returns:
    
    thresholds
  - setThresholds
```
public void setThresholds(List<SLOThreshold> thresholds)
```
  - timeframe
```
public ServiceLevelObjectiveRequest timeframe(SLOTimeframe timeframe)
```
  - getTimeframe
```
@Nullable
public SLOTimeframe getTimeframe()
```
    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.
    
    Returns:
    
    timeframe
  - setTimeframe
```
public void setTimeframe(SLOTimeframe timeframe)
```
  - type
```
public ServiceLevelObjectiveRequest type(SLOType type)
```
  - getType
```
public SLOType getType()
```
    The type of the service level objective.
    
    Returns:
    
    type
  - setType
```
public void setType(SLOType type)
```
  - warningThreshold
```
public ServiceLevelObjectiveRequest warningThreshold(Double warningThreshold)
```
  - getWarningThreshold
```
@Nullable
public Double getWarningThreshold()
```
    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.
    
    Returns:
    
    warningThreshold
  - setWarningThreshold
```
public void setWarningThreshold(Double warningThreshold)
```
  - putAdditionalProperty
```
public ServiceLevelObjectiveRequest 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:
    
    ServiceLevelObjectiveRequest
  - 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 ServiceLevelObjectiveRequest 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 ServiceLevelObjectiveRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_GROUPS

JSON_PROPERTY_MONITOR_IDS

JSON_PROPERTY_NAME

JSON_PROPERTY_QUERY

JSON_PROPERTY_SLI_SPECIFICATION

JSON_PROPERTY_TAGS

JSON_PROPERTY_TARGET_THRESHOLD

JSON_PROPERTY_THRESHOLDS

JSON_PROPERTY_TIMEFRAME

JSON_PROPERTY_TYPE

JSON_PROPERTY_WARNING_THRESHOLD

Constructor Detail

ServiceLevelObjectiveRequest

ServiceLevelObjectiveRequest

Method Detail

description

getDescription

getDescription_JsonNullable

setDescription_JsonNullable

setDescription

groups

addGroupsItem

getGroups

setGroups

monitorIds

addMonitorIdsItem

getMonitorIds

setMonitorIds

name

getName

setName

query

getQuery

setQuery

sliSpecification

getSliSpecification

setSliSpecification

tags

addTagsItem

getTags

setTags

targetThreshold

getTargetThreshold

setTargetThreshold

thresholds

addThresholdsItem

getThresholds

setThresholds

timeframe

getTimeframe

setTimeframe

type

getType

setType

warningThreshold

getWarningThreshold

setWarningThreshold

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString