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

Class HeatMapWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.HeatMapWidgetDefinition

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

The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CUSTOM_LINKS
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_EVENTS
static final String	JSON_PROPERTY_LEGEND_SIZE
static final String	JSON_PROPERTY_MARKERS
static final String	JSON_PROPERTY_REQUESTS
static final String	JSON_PROPERTY_SHOW_LEGEND
static final String	JSON_PROPERTY_TIME
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
static final String	JSON_PROPERTY_XAXIS
static final String	JSON_PROPERTY_YAXIS
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
HeatMapWidgetDefinition()
HeatMapWidgetDefinition(List<HeatMapWidgetRequest> requests, HeatMapWidgetDefinitionType type)

Method Summary

Modifier and Type	Method	Description
HeatMapWidgetDefinition	addCustomLinksItem(WidgetCustomLink customLinksItem)
HeatMapWidgetDefinition	addEventsItem(WidgetEvent eventsItem)
HeatMapWidgetDefinition	addMarkersItem(WidgetMarker markersItem)
HeatMapWidgetDefinition	addRequestsItem(HeatMapWidgetRequest requestsItem)
HeatMapWidgetDefinition	customLinks(List<WidgetCustomLink> customLinks)
HeatMapWidgetDefinition	description(String description)
boolean	equals(Object o)	Return true if this HeatMapWidgetDefinition object is equal to o.
HeatMapWidgetDefinition	events(List<WidgetEvent> events)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
List<WidgetCustomLink>	getCustomLinks()	List of custom links.
String	getDescription()	The description of the widget.
List<WidgetEvent>	getEvents()	Deprecated.
String	getLegendSize()	Available legend sizes for a widget.
List<WidgetMarker>	getMarkers()	List of markers.
List<HeatMapWidgetRequest>	getRequests()	List of widget types.
Boolean	getShowLegend()	Whether or not to display the legend on this widget.
WidgetTime	getTime()	Time setting for the widget.
String	getTitle()	Title of the widget.
WidgetTextAlign	getTitleAlign()	How to align the text on the widget.
String	getTitleSize()	Size of the title.
HeatMapWidgetDefinitionType	getType()	Type of the heat map widget.
HeatMapWidgetXAxis	getXaxis()	X Axis controls for the heat map widget.
WidgetAxis	getYaxis()	Axis controls for the widget.
int	hashCode()
HeatMapWidgetDefinition	legendSize(String legendSize)
HeatMapWidgetDefinition	markers(List<WidgetMarker> markers)
HeatMapWidgetDefinition	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
HeatMapWidgetDefinition	requests(List<HeatMapWidgetRequest> requests)
void	setCustomLinks(List<WidgetCustomLink> customLinks)
void	setDescription(String description)
void	setEvents(List<WidgetEvent> events)	Deprecated.
void	setLegendSize(String legendSize)
void	setMarkers(List<WidgetMarker> markers)
void	setRequests(List<HeatMapWidgetRequest> requests)
void	setShowLegend(Boolean showLegend)
void	setTime(WidgetTime time)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(HeatMapWidgetDefinitionType type)
void	setXaxis(HeatMapWidgetXAxis xaxis)
void	setYaxis(WidgetAxis yaxis)
HeatMapWidgetDefinition	showLegend(Boolean showLegend)
HeatMapWidgetDefinition	time(WidgetTime time)
HeatMapWidgetDefinition	title(String title)
HeatMapWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
HeatMapWidgetDefinition	titleSize(String titleSize)
String	toString()
HeatMapWidgetDefinition	type(HeatMapWidgetDefinitionType type)
HeatMapWidgetDefinition	xaxis(HeatMapWidgetXAxis xaxis)
HeatMapWidgetDefinition	yaxis(WidgetAxis yaxis)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_CUSTOM_LINKS

public static final String JSON_PROPERTY_CUSTOM_LINKS

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_EVENTS

public static final String JSON_PROPERTY_EVENTS

See Also:

• Constant Field Values

JSON_PROPERTY_LEGEND_SIZE

public static final String JSON_PROPERTY_LEGEND_SIZE

See Also:

• Constant Field Values

JSON_PROPERTY_MARKERS

public static final String JSON_PROPERTY_MARKERS

See Also:

• Constant Field Values

JSON_PROPERTY_REQUESTS

public static final String JSON_PROPERTY_REQUESTS

See Also:

• Constant Field Values

JSON_PROPERTY_SHOW_LEGEND

public static final String JSON_PROPERTY_SHOW_LEGEND

See Also:

• Constant Field Values

JSON_PROPERTY_TIME

public static final String JSON_PROPERTY_TIME

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

JSON_PROPERTY_XAXIS

public static final String JSON_PROPERTY_XAXIS

See Also:

• Constant Field Values

JSON_PROPERTY_YAXIS

public static final String JSON_PROPERTY_YAXIS

See Also:

• Constant Field Values

Constructor Details

HeatMapWidgetDefinition

public HeatMapWidgetDefinition()

HeatMapWidgetDefinition

public HeatMapWidgetDefinition(List<HeatMapWidgetRequest> requests,
 HeatMapWidgetDefinitionType type)

Method Details

customLinks

public HeatMapWidgetDefinition customLinks(List<WidgetCustomLink> customLinks)

addCustomLinksItem

public HeatMapWidgetDefinition addCustomLinksItem(WidgetCustomLink customLinksItem)

getCustomLinks

@Nullable
public List<WidgetCustomLink> getCustomLinks()

List of custom links.

Returns:

customLinks

setCustomLinks

public void setCustomLinks(List<WidgetCustomLink> customLinks)

description

public HeatMapWidgetDefinition description(String description)

getDescription

@Nullable
public String getDescription()

The description of the widget.

Returns:

description

setDescription

public void setDescription(String description)

events

public HeatMapWidgetDefinition events(List<WidgetEvent> events)

addEventsItem

public HeatMapWidgetDefinition addEventsItem(WidgetEvent eventsItem)

getEvents

@Deprecated
@Nullable
public List<WidgetEvent> getEvents()

Deprecated.

List of widget events. Deprecated - Use overlay request type instead.

Returns:

events

setEvents

@Deprecated
public void setEvents(List<WidgetEvent> events)

Deprecated.

legendSize

public HeatMapWidgetDefinition legendSize(String legendSize)

getLegendSize

@Nullable
public String getLegendSize()

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".

Returns:

legendSize

setLegendSize

public void setLegendSize(String legendSize)

markers

public HeatMapWidgetDefinition markers(List<WidgetMarker> markers)

addMarkersItem

public HeatMapWidgetDefinition addMarkersItem(WidgetMarker markersItem)

getMarkers

@Nullable
public List<WidgetMarker> getMarkers()

List of markers.

Returns:

markers

setMarkers

public void setMarkers(List<WidgetMarker> markers)

requests

public HeatMapWidgetDefinition requests(List<HeatMapWidgetRequest> requests)

addRequestsItem

public HeatMapWidgetDefinition addRequestsItem(HeatMapWidgetRequest requestsItem)

getRequests

public List<HeatMapWidgetRequest> getRequests()

List of widget types.

Returns:

requests

setRequests

public void setRequests(List<HeatMapWidgetRequest> requests)

showLegend

public HeatMapWidgetDefinition showLegend(Boolean showLegend)

getShowLegend

@Nullable
public Boolean getShowLegend()

Whether or not to display the legend on this widget.

Returns:

showLegend

setShowLegend

public void setShowLegend(Boolean showLegend)

time

public HeatMapWidgetDefinition time(WidgetTime time)

getTime

@Nullable
public WidgetTime getTime()

Time setting for the widget.

Returns:

time

setTime

public void setTime(WidgetTime time)

title

public HeatMapWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of the widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

public HeatMapWidgetDefinition 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 HeatMapWidgetDefinition titleSize(String titleSize)

getTitleSize

@Nullable
public String getTitleSize()

Size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public HeatMapWidgetDefinition type(HeatMapWidgetDefinitionType type)

getType

public HeatMapWidgetDefinitionType getType()

Type of the heat map widget.

Returns:

type

setType

public void setType(HeatMapWidgetDefinitionType type)

xaxis

public HeatMapWidgetDefinition xaxis(HeatMapWidgetXAxis xaxis)

getXaxis

@Nullable
public HeatMapWidgetXAxis getXaxis()

X Axis controls for the heat map widget.

Returns:

xaxis

setXaxis

public void setXaxis(HeatMapWidgetXAxis xaxis)

yaxis

public HeatMapWidgetDefinition yaxis(WidgetAxis yaxis)

getYaxis

@Nullable
public WidgetAxis getYaxis()

Axis controls for the widget.

Returns:

yaxis

setYaxis

public void setYaxis(WidgetAxis yaxis)

putAdditionalProperty

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

HeatMapWidgetDefinition

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