com.datadog.api.client.v1.model

Class SLOHistoryMonitor

java.lang.Object

com.datadog.api.client.v1.model.SLOHistoryMonitor

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

An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ERROR_BUDGET_REMAINING
static String	JSON_PROPERTY_ERRORS
static String	JSON_PROPERTY_GROUP
static String	JSON_PROPERTY_HISTORY
static String	JSON_PROPERTY_MONITOR_MODIFIED
static String	JSON_PROPERTY_MONITOR_TYPE
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_PRECISION
static String	JSON_PROPERTY_PREVIEW
static String	JSON_PROPERTY_SLI_VALUE
static String	JSON_PROPERTY_SPAN_PRECISION
static String	JSON_PROPERTY_UPTIME
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SLOHistoryMonitor()

Method Summary

Modifier and Type	Method and Description
SLOHistoryMonitor	addErrorsItem(SLOHistoryResponseErrorWithType errorsItem)
SLOHistoryMonitor	addHistoryItem(List<Double> historyItem)
boolean	equals(Object o) Return true if this SLOHistoryMonitor object is equal to o.
SLOHistoryMonitor	errorBudgetRemaining(Map<String,Double> errorBudgetRemaining)
SLOHistoryMonitor	errors(List<SLOHistoryResponseErrorWithType> errors)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
Map<String,Double>	getErrorBudgetRemaining() A mapping of threshold timeframe to the remaining error budget.
List<SLOHistoryResponseErrorWithType>	getErrors() An array of error objects returned while querying the history data for the service level objective.
String	getGroup() For groups in a grouped SLO, this is the group name.
List<List<Double>>	getHistory() The state transition history for the monitor.
Long	getMonitorModified() For monitor based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
String	getMonitorType() For monitor based SLOs, this describes the type of monitor.
String	getName() For groups in a grouped SLO, this is the group name.
Double	getPrecision() Deprecated.
Boolean	getPreview() For monitor based SLOs, when true this indicates that a replay is in progress to give an accurate uptime calculation.
org.openapitools.jackson.nullable.JsonNullable<Double>	getSliValue_JsonNullable()
Double	getSliValue() The current SLI value of the SLO over the history window.
Double	getSpanPrecision() The amount of decimal places the SLI value is accurate to for the given from && to timestamp.
Double	getUptime() Deprecated.
SLOHistoryMonitor	group(String group)
int	hashCode()
SLOHistoryMonitor	history(List<List<Double>> history)
SLOHistoryMonitor	monitorModified(Long monitorModified)
SLOHistoryMonitor	monitorType(String monitorType)
SLOHistoryMonitor	name(String name)
SLOHistoryMonitor	precision(Double precision)
SLOHistoryMonitor	preview(Boolean preview)
SLOHistoryMonitor	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SLOHistoryMonitor	putErrorBudgetRemainingItem(String key, Double errorBudgetRemainingItem)
void	setErrorBudgetRemaining(Map<String,Double> errorBudgetRemaining)
void	setErrors(List<SLOHistoryResponseErrorWithType> errors)
void	setGroup(String group)
void	setHistory(List<List<Double>> history)
void	setMonitorModified(Long monitorModified)
void	setMonitorType(String monitorType)
void	setName(String name)
void	setPrecision(Double precision) Deprecated.
void	setPreview(Boolean preview)
void	setSliValue_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Double> sliValue)
void	setSliValue(Double sliValue)
void	setSpanPrecision(Double spanPrecision)
void	setUptime(Double uptime) Deprecated.
SLOHistoryMonitor	sliValue(Double sliValue)
SLOHistoryMonitor	spanPrecision(Double spanPrecision)
String	toString()
SLOHistoryMonitor	uptime(Double uptime)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ERROR_BUDGET_REMAINING

public static final String JSON_PROPERTY_ERROR_BUDGET_REMAINING

See Also:

Constant Field Values

JSON_PROPERTY_ERRORS

public static final String JSON_PROPERTY_ERRORS

See Also:

Constant Field Values

JSON_PROPERTY_GROUP

public static final String JSON_PROPERTY_GROUP

See Also:

Constant Field Values

JSON_PROPERTY_HISTORY

public static final String JSON_PROPERTY_HISTORY

See Also:

Constant Field Values

JSON_PROPERTY_MONITOR_MODIFIED

public static final String JSON_PROPERTY_MONITOR_MODIFIED

See Also:

Constant Field Values

JSON_PROPERTY_MONITOR_TYPE

public static final String JSON_PROPERTY_MONITOR_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_PRECISION

public static final String JSON_PROPERTY_PRECISION

See Also:

Constant Field Values

JSON_PROPERTY_PREVIEW

public static final String JSON_PROPERTY_PREVIEW

See Also:

Constant Field Values

JSON_PROPERTY_SLI_VALUE

public static final String JSON_PROPERTY_SLI_VALUE

See Also:

Constant Field Values

JSON_PROPERTY_SPAN_PRECISION

public static final String JSON_PROPERTY_SPAN_PRECISION

See Also:

Constant Field Values

JSON_PROPERTY_UPTIME

public static final String JSON_PROPERTY_UPTIME

See Also:

Constant Field Values

Constructor Detail

SLOHistoryMonitor

public SLOHistoryMonitor()

Method Detail

errorBudgetRemaining

public SLOHistoryMonitor errorBudgetRemaining(Map<String,Double> errorBudgetRemaining)

putErrorBudgetRemainingItem

public SLOHistoryMonitor putErrorBudgetRemainingItem(String key,
                                                     Double errorBudgetRemainingItem)

getErrorBudgetRemaining

@Nullable
public Map<String,Double> getErrorBudgetRemaining()

A mapping of threshold timeframe to the remaining error budget.

Returns:

errorBudgetRemaining

setErrorBudgetRemaining

public void setErrorBudgetRemaining(Map<String,Double> errorBudgetRemaining)

errors

public SLOHistoryMonitor errors(List<SLOHistoryResponseErrorWithType> errors)

addErrorsItem

public SLOHistoryMonitor addErrorsItem(SLOHistoryResponseErrorWithType errorsItem)

getErrors

@Nullable
public List<SLOHistoryResponseErrorWithType> getErrors()

An array of error objects returned while querying the history data for the service level objective.

Returns:

errors

setErrors

public void setErrors(List<SLOHistoryResponseErrorWithType> errors)

group

public SLOHistoryMonitor group(String group)

getGroup

@Nullable
public String getGroup()

For groups in a grouped SLO, this is the group name.

Returns:

group

setGroup

public void setGroup(String group)

history

public SLOHistoryMonitor history(List<List<Double>> history)

addHistoryItem

public SLOHistoryMonitor addHistoryItem(List<Double> historyItem)

getHistory

@Nullable
public List<List<Double>> getHistory()

The state transition history for the monitor. It is represented as an array of pairs. Each pair is an array containing the timestamp of the transition as an integer in Unix epoch format in the first element, and the state as an integer in the second element. An integer value of 0 for state means uptime, 1 means downtime, and 2 means no data. Periods of no data are counted either as uptime or downtime depending on monitor settings. See SLO documentatio for detailed information.

Returns:

history

setHistory

public void setHistory(List<List<Double>> history)

monitorModified

public SLOHistoryMonitor monitorModified(Long monitorModified)

getMonitorModified

@Nullable
public Long getMonitorModified()

For monitor based SLOs, this is the last modified timestamp in epoch seconds of the monitor.

Returns:

monitorModified

setMonitorModified

public void setMonitorModified(Long monitorModified)

monitorType

public SLOHistoryMonitor monitorType(String monitorType)

getMonitorType

@Nullable
public String getMonitorType()

For monitor based SLOs, this describes the type of monitor.

Returns:

monitorType

setMonitorType

public void setMonitorType(String monitorType)

name

public SLOHistoryMonitor name(String name)

getName

@Nullable
public String getName()

For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.

Returns:

name

setName

public void setName(String name)

precision

public SLOHistoryMonitor precision(Double precision)

getPrecision

@Deprecated
 @Nullable
public Double getPrecision()

Deprecated.

The amount of decimal places the SLI value is accurate to for the given from && to timestamp. Use span_precision instead.

Returns:

precision

setPrecision

@Deprecated
public void setPrecision(Double precision)

Deprecated.

preview

public SLOHistoryMonitor preview(Boolean preview)

getPreview

@Nullable
public Boolean getPreview()

For monitor based SLOs, when true this indicates that a replay is in progress to give an accurate uptime calculation.

Returns:

preview

setPreview

public void setPreview(Boolean preview)

sliValue

public SLOHistoryMonitor sliValue(Double sliValue)

getSliValue

@Nullable
public Double getSliValue()

The current SLI value of the SLO over the history window.

Returns:

sliValue

getSliValue_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Double> getSliValue_JsonNullable()

setSliValue_JsonNullable

public void setSliValue_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Double> sliValue)

setSliValue

public void setSliValue(Double sliValue)

spanPrecision

public SLOHistoryMonitor spanPrecision(Double spanPrecision)

getSpanPrecision

@Nullable
public Double getSpanPrecision()

The amount of decimal places the SLI value is accurate to for the given from && to timestamp.

Returns:

spanPrecision

setSpanPrecision

public void setSpanPrecision(Double spanPrecision)

uptime

public SLOHistoryMonitor uptime(Double uptime)

getUptime

@Deprecated
 @Nullable
public Double getUptime()

Deprecated.

Use sli_value instead.

Returns:

uptime

setUptime

@Deprecated
public void setUptime(Double uptime)

Deprecated.

putAdditionalProperty

public SLOHistoryMonitor 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:

SLOHistoryMonitor

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 SLOHistoryMonitor 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