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

Class DistributionWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.DistributionWidgetDefinition

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

The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time.

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_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
DistributionWidgetDefinition()
DistributionWidgetDefinition(List<DistributionWidgetRequest> requests, DistributionWidgetDefinitionType type)

Method Summary

Modifier and Type	Method	Description
DistributionWidgetDefinition	addCustomLinksItem(WidgetCustomLink customLinksItem)
DistributionWidgetDefinition	addMarkersItem(WidgetMarker markersItem)
DistributionWidgetDefinition	addRequestsItem(DistributionWidgetRequest requestsItem)
DistributionWidgetDefinition	customLinks(List<WidgetCustomLink> customLinks)
DistributionWidgetDefinition	description(String description)
boolean	equals(Object o)	Return true if this DistributionWidgetDefinition 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.
List<WidgetCustomLink>	getCustomLinks()	A list of custom links.
String	getDescription()	The description of the widget.
String	getLegendSize()	Deprecated.
List<WidgetMarker>	getMarkers()	List of markers.
List<DistributionWidgetRequest>	getRequests()	Array of one request object to display in the widget.
Boolean	getShowLegend()	Deprecated.
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.
DistributionWidgetDefinitionType	getType()	Type of the distribution widget.
DistributionWidgetXAxis	getXaxis()	X Axis controls for the distribution widget.
DistributionWidgetYAxis	getYaxis()	Y Axis controls for the distribution widget.
int	hashCode()
DistributionWidgetDefinition	legendSize(String legendSize)
DistributionWidgetDefinition	markers(List<WidgetMarker> markers)
DistributionWidgetDefinition	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
DistributionWidgetDefinition	requests(List<DistributionWidgetRequest> requests)
void	setCustomLinks(List<WidgetCustomLink> customLinks)
void	setDescription(String description)
void	setLegendSize(String legendSize)	Deprecated.
void	setMarkers(List<WidgetMarker> markers)
void	setRequests(List<DistributionWidgetRequest> requests)
void	setShowLegend(Boolean showLegend)	Deprecated.
void	setTime(WidgetTime time)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(DistributionWidgetDefinitionType type)
void	setXaxis(DistributionWidgetXAxis xaxis)
void	setYaxis(DistributionWidgetYAxis yaxis)
DistributionWidgetDefinition	showLegend(Boolean showLegend)
DistributionWidgetDefinition	time(WidgetTime time)
DistributionWidgetDefinition	title(String title)
DistributionWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
DistributionWidgetDefinition	titleSize(String titleSize)
String	toString()
DistributionWidgetDefinition	type(DistributionWidgetDefinitionType type)
DistributionWidgetDefinition	xaxis(DistributionWidgetXAxis xaxis)
DistributionWidgetDefinition	yaxis(DistributionWidgetYAxis 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_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

DistributionWidgetDefinition

public DistributionWidgetDefinition()

DistributionWidgetDefinition

public DistributionWidgetDefinition(List<DistributionWidgetRequest> requests,
 DistributionWidgetDefinitionType type)

Method Details

customLinks

public DistributionWidgetDefinition customLinks(List<WidgetCustomLink> customLinks)

addCustomLinksItem

public DistributionWidgetDefinition addCustomLinksItem(WidgetCustomLink customLinksItem)

getCustomLinks

@Nullable
public List<WidgetCustomLink> getCustomLinks()

A list of custom links.

Returns:

customLinks

setCustomLinks

public void setCustomLinks(List<WidgetCustomLink> customLinks)

description

public DistributionWidgetDefinition description(String description)

getDescription

@Nullable
public String getDescription()

The description of the widget.

Returns:

description

setDescription

public void setDescription(String description)

legendSize

public DistributionWidgetDefinition legendSize(String legendSize)

getLegendSize

@Deprecated
@Nullable
public String getLegendSize()

Deprecated.

(Deprecated) The widget legend was replaced by a tooltip and sidebar.

Returns:

legendSize

setLegendSize

@Deprecated
public void setLegendSize(String legendSize)

Deprecated.

markers

public DistributionWidgetDefinition markers(List<WidgetMarker> markers)

addMarkersItem

public DistributionWidgetDefinition addMarkersItem(WidgetMarker markersItem)

getMarkers

@Nullable
public List<WidgetMarker> getMarkers()

List of markers.

Returns:

markers

setMarkers

public void setMarkers(List<WidgetMarker> markers)

requests

public DistributionWidgetDefinition requests(List<DistributionWidgetRequest> requests)

addRequestsItem

public DistributionWidgetDefinition addRequestsItem(DistributionWidgetRequest requestsItem)

getRequests

public List<DistributionWidgetRequest> getRequests()

Array of one request object to display in the widget.

See the dedicated Request JSON schema documentation to learn how to build the REQUEST_SCHEMA.

Returns:

requests

setRequests

public void setRequests(List<DistributionWidgetRequest> requests)

showLegend

public DistributionWidgetDefinition showLegend(Boolean showLegend)

getShowLegend

@Deprecated
@Nullable
public Boolean getShowLegend()

Deprecated.

(Deprecated) The widget legend was replaced by a tooltip and sidebar.

Returns:

showLegend

setShowLegend

@Deprecated
public void setShowLegend(Boolean showLegend)

Deprecated.

time

public DistributionWidgetDefinition time(WidgetTime time)

getTime

@Nullable
public WidgetTime getTime()

Time setting for the widget.

Returns:

time

setTime

public void setTime(WidgetTime time)

title

public DistributionWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of the widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

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

getTitleSize

@Nullable
public String getTitleSize()

Size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public DistributionWidgetDefinition type(DistributionWidgetDefinitionType type)

getType

public DistributionWidgetDefinitionType getType()

Type of the distribution widget.

Returns:

type

setType

public void setType(DistributionWidgetDefinitionType type)

xaxis

public DistributionWidgetDefinition xaxis(DistributionWidgetXAxis xaxis)

getXaxis

@Nullable
public DistributionWidgetXAxis getXaxis()

X Axis controls for the distribution widget.

Returns:

xaxis

setXaxis

public void setXaxis(DistributionWidgetXAxis xaxis)

yaxis

public DistributionWidgetDefinition yaxis(DistributionWidgetYAxis yaxis)

getYaxis

@Nullable
public DistributionWidgetYAxis getYaxis()

Y Axis controls for the distribution widget.

Returns:

yaxis

setYaxis

public void setYaxis(DistributionWidgetYAxis yaxis)

putAdditionalProperty

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

DistributionWidgetDefinition

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