Package com.datadog.api.client.v1.model

Class MonitorSummaryWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.MonitorSummaryWidgetDefinition

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

The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_COLOR_PREFERENCE
static final String	JSON_PROPERTY_COUNT
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_DISPLAY_FORMAT
static final String	JSON_PROPERTY_HIDE_ZERO_COUNTS
static final String	JSON_PROPERTY_QUERY
static final String	JSON_PROPERTY_SHOW_LAST_TRIGGERED
static final String	JSON_PROPERTY_SHOW_PRIORITY
static final String	JSON_PROPERTY_SORT
static final String	JSON_PROPERTY_START
static final String	JSON_PROPERTY_SUMMARY_TYPE
static final String	JSON_PROPERTY_TITLE
static final String	JSON_PROPERTY_TITLE_ALIGN
static final String	JSON_PROPERTY_TITLE_SIZE
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
MonitorSummaryWidgetDefinition()
MonitorSummaryWidgetDefinition(String query, MonitorSummaryWidgetDefinitionType type)

Method Summary

Modifier and Type	Method	Description
MonitorSummaryWidgetDefinition	colorPreference(WidgetColorPreference colorPreference)
MonitorSummaryWidgetDefinition	count(Long count)
MonitorSummaryWidgetDefinition	description(String description)
MonitorSummaryWidgetDefinition	displayFormat(WidgetMonitorSummaryDisplayFormat displayFormat)
boolean	equals(Object o)	Return true if this MonitorSummaryWidgetDefinition 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.
WidgetColorPreference	getColorPreference()	Which color to use on the widget.
Long	getCount()	Deprecated.
String	getDescription()	The description of the widget.
WidgetMonitorSummaryDisplayFormat	getDisplayFormat()	What to display on the widget.
Boolean	getHideZeroCounts()	Whether to show counts of 0 or not.
String	getQuery()	Query to filter the monitors with.
Boolean	getShowLastTriggered()	Whether to show the time that has elapsed since the monitor/group triggered.
Boolean	getShowPriority()	Whether to show the priorities column.
WidgetMonitorSummarySort	getSort()	Widget sorting methods.
Long	getStart()	Deprecated.
WidgetSummaryType	getSummaryType()	Which summary type should be used.
String	getTitle()	Title of the widget.
WidgetTextAlign	getTitleAlign()	How to align the text on the widget.
String	getTitleSize()	Size of the title.
MonitorSummaryWidgetDefinitionType	getType()	Type of the monitor summary widget.
int	hashCode()
MonitorSummaryWidgetDefinition	hideZeroCounts(Boolean hideZeroCounts)
MonitorSummaryWidgetDefinition	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
MonitorSummaryWidgetDefinition	query(String query)
void	setColorPreference(WidgetColorPreference colorPreference)
void	setCount(Long count)	Deprecated.
void	setDescription(String description)
void	setDisplayFormat(WidgetMonitorSummaryDisplayFormat displayFormat)
void	setHideZeroCounts(Boolean hideZeroCounts)
void	setQuery(String query)
void	setShowLastTriggered(Boolean showLastTriggered)
void	setShowPriority(Boolean showPriority)
void	setSort(WidgetMonitorSummarySort sort)
void	setStart(Long start)	Deprecated.
void	setSummaryType(WidgetSummaryType summaryType)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(MonitorSummaryWidgetDefinitionType type)
MonitorSummaryWidgetDefinition	showLastTriggered(Boolean showLastTriggered)
MonitorSummaryWidgetDefinition	showPriority(Boolean showPriority)
MonitorSummaryWidgetDefinition	sort(WidgetMonitorSummarySort sort)
MonitorSummaryWidgetDefinition	start(Long start)
MonitorSummaryWidgetDefinition	summaryType(WidgetSummaryType summaryType)
MonitorSummaryWidgetDefinition	title(String title)
MonitorSummaryWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
MonitorSummaryWidgetDefinition	titleSize(String titleSize)
String	toString()
MonitorSummaryWidgetDefinition	type(MonitorSummaryWidgetDefinitionType type)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_COLOR_PREFERENCE

public static final String JSON_PROPERTY_COLOR_PREFERENCE

See Also:

• Constant Field Values

JSON_PROPERTY_COUNT

public static final String JSON_PROPERTY_COUNT

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_DISPLAY_FORMAT

public static final String JSON_PROPERTY_DISPLAY_FORMAT

See Also:

• Constant Field Values

JSON_PROPERTY_HIDE_ZERO_COUNTS

public static final String JSON_PROPERTY_HIDE_ZERO_COUNTS

See Also:

• Constant Field Values

JSON_PROPERTY_QUERY

public static final String JSON_PROPERTY_QUERY

See Also:

• Constant Field Values

JSON_PROPERTY_SHOW_LAST_TRIGGERED

public static final String JSON_PROPERTY_SHOW_LAST_TRIGGERED

See Also:

• Constant Field Values

JSON_PROPERTY_SHOW_PRIORITY

public static final String JSON_PROPERTY_SHOW_PRIORITY

See Also:

• Constant Field Values

JSON_PROPERTY_SORT

public static final String JSON_PROPERTY_SORT

See Also:

• Constant Field Values

JSON_PROPERTY_START

public static final String JSON_PROPERTY_START

See Also:

• Constant Field Values

JSON_PROPERTY_SUMMARY_TYPE

public static final String JSON_PROPERTY_SUMMARY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE

public static final String JSON_PROPERTY_TITLE

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE_ALIGN

public static final String JSON_PROPERTY_TITLE_ALIGN

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE_SIZE

public static final String JSON_PROPERTY_TITLE_SIZE

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

MonitorSummaryWidgetDefinition

public MonitorSummaryWidgetDefinition()

MonitorSummaryWidgetDefinition

public MonitorSummaryWidgetDefinition(String query,
 MonitorSummaryWidgetDefinitionType type)

Method Details

colorPreference

public MonitorSummaryWidgetDefinition colorPreference(WidgetColorPreference colorPreference)

getColorPreference

@Nullable
public WidgetColorPreference getColorPreference()

Which color to use on the widget.

Returns:

colorPreference

setColorPreference

public void setColorPreference(WidgetColorPreference colorPreference)

count

public MonitorSummaryWidgetDefinition count(Long count)

getCount

@Deprecated
@Nullable
public Long getCount()

Deprecated.

The number of monitors to display.

Returns:

count

setCount

@Deprecated
public void setCount(Long count)

Deprecated.

description

public MonitorSummaryWidgetDefinition description(String description)

getDescription

@Nullable
public String getDescription()

The description of the widget.

Returns:

description

setDescription

public void setDescription(String description)

displayFormat

public MonitorSummaryWidgetDefinition displayFormat(WidgetMonitorSummaryDisplayFormat displayFormat)

getDisplayFormat

@Nullable
public WidgetMonitorSummaryDisplayFormat getDisplayFormat()

What to display on the widget.

Returns:

displayFormat

setDisplayFormat

public void setDisplayFormat(WidgetMonitorSummaryDisplayFormat displayFormat)

hideZeroCounts

public MonitorSummaryWidgetDefinition hideZeroCounts(Boolean hideZeroCounts)

getHideZeroCounts

@Nullable
public Boolean getHideZeroCounts()

Whether to show counts of 0 or not.

Returns:

hideZeroCounts

setHideZeroCounts

public void setHideZeroCounts(Boolean hideZeroCounts)

query

public MonitorSummaryWidgetDefinition query(String query)

getQuery

public String getQuery()

Query to filter the monitors with.

Returns:

query

setQuery

public void setQuery(String query)

showLastTriggered

public MonitorSummaryWidgetDefinition showLastTriggered(Boolean showLastTriggered)

getShowLastTriggered

@Nullable
public Boolean getShowLastTriggered()

Whether to show the time that has elapsed since the monitor/group triggered.

Returns:

showLastTriggered

setShowLastTriggered

public void setShowLastTriggered(Boolean showLastTriggered)

showPriority

public MonitorSummaryWidgetDefinition showPriority(Boolean showPriority)

getShowPriority

@Nullable
public Boolean getShowPriority()

Whether to show the priorities column.

Returns:

showPriority

setShowPriority

public void setShowPriority(Boolean showPriority)

sort

public MonitorSummaryWidgetDefinition sort(WidgetMonitorSummarySort sort)

getSort

@Nullable
public WidgetMonitorSummarySort getSort()

Widget sorting methods.

Returns:

sort

setSort

public void setSort(WidgetMonitorSummarySort sort)

start

public MonitorSummaryWidgetDefinition start(Long start)

getStart

@Deprecated
@Nullable
public Long getStart()

Deprecated.

The start of the list. Typically 0.

Returns:

start

setStart

@Deprecated
public void setStart(Long start)

Deprecated.

summaryType

public MonitorSummaryWidgetDefinition summaryType(WidgetSummaryType summaryType)

getSummaryType

@Nullable
public WidgetSummaryType getSummaryType()

Which summary type should be used.

Returns:

summaryType

setSummaryType

public void setSummaryType(WidgetSummaryType summaryType)

title

public MonitorSummaryWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of the widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

public MonitorSummaryWidgetDefinition titleAlign(WidgetTextAlign titleAlign)

getTitleAlign

@Nullable
public WidgetTextAlign getTitleAlign()

How to align the text on the widget.

Returns:

titleAlign

setTitleAlign

public void setTitleAlign(WidgetTextAlign titleAlign)

titleSize

public MonitorSummaryWidgetDefinition titleSize(String titleSize)

getTitleSize

@Nullable
public String getTitleSize()

Size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public MonitorSummaryWidgetDefinition type(MonitorSummaryWidgetDefinitionType type)

getType

public MonitorSummaryWidgetDefinitionType getType()

Type of the monitor summary widget.

Returns:

type

setType

public void setType(MonitorSummaryWidgetDefinitionType type)

putAdditionalProperty

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

MonitorSummaryWidgetDefinition

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