com.datadog.api.client.v1.model

Class HeatMapWidgetDefinition

java.lang.Object

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

@Generated(value="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 and Description
static String	JSON_PROPERTY_CUSTOM_LINKS
static String	JSON_PROPERTY_EVENTS
static String	JSON_PROPERTY_LEGEND_SIZE
static String	JSON_PROPERTY_REQUESTS
static String	JSON_PROPERTY_SHOW_LEGEND
static String	JSON_PROPERTY_TIME
static String	JSON_PROPERTY_TITLE
static String	JSON_PROPERTY_TITLE_ALIGN
static String	JSON_PROPERTY_TITLE_SIZE
static String	JSON_PROPERTY_TYPE
static String	JSON_PROPERTY_YAXIS
boolean	unparsed

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HeatMapWidgetDefinition	addCustomLinksItem(WidgetCustomLink customLinksItem)
HeatMapWidgetDefinition	addEventsItem(WidgetEvent eventsItem)
HeatMapWidgetDefinition	addRequestsItem(HeatMapWidgetRequest requestsItem)
HeatMapWidgetDefinition	customLinks(List<WidgetCustomLink> customLinks)
boolean	equals(Object o) Return true if this HeatMapWidgetDefinition object is equal to o.
HeatMapWidgetDefinition	events(List<WidgetEvent> events)
List<WidgetCustomLink>	getCustomLinks() List of custom links.
List<WidgetEvent>	getEvents() List of widget events.
String	getLegendSize() Available legend sizes for a widget.
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.
WidgetAxis	getYaxis() Axis controls for the widget.
int	hashCode()
HeatMapWidgetDefinition	legendSize(String legendSize)
HeatMapWidgetDefinition	requests(List<HeatMapWidgetRequest> requests)
void	setCustomLinks(List<WidgetCustomLink> customLinks)
void	setEvents(List<WidgetEvent> events)
void	setLegendSize(String legendSize)
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	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	yaxis(WidgetAxis yaxis)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_CUSTOM_LINKS

public static final String JSON_PROPERTY_CUSTOM_LINKS

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_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_YAXIS

public static final String JSON_PROPERTY_YAXIS

See Also:

Constant Field Values

Constructor Detail

HeatMapWidgetDefinition

public HeatMapWidgetDefinition()

HeatMapWidgetDefinition

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

Method Detail

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)

events

public HeatMapWidgetDefinition events(List<WidgetEvent> events)

addEventsItem

public HeatMapWidgetDefinition addEventsItem(WidgetEvent eventsItem)

getEvents

@Nullable
public List<WidgetEvent> getEvents()

List of widget events.

Returns:

events

setEvents

public void setEvents(List<WidgetEvent> events)

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)

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)

yaxis

public HeatMapWidgetDefinition yaxis(WidgetAxis yaxis)

getYaxis

@Nullable
public WidgetAxis getYaxis()

Axis controls for the widget.

Returns:

yaxis

setYaxis

public void setYaxis(WidgetAxis yaxis)

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