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

Class TimeseriesWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.TimeseriesWidgetDefinition

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

The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over 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_EVENTS
static final String	JSON_PROPERTY_LEGEND_COLUMNS
static final String	JSON_PROPERTY_LEGEND_LAYOUT
static final String	JSON_PROPERTY_LEGEND_SIZE
static final String	JSON_PROPERTY_MARKERS
static final String	JSON_PROPERTY_REQUESTS
static final String	JSON_PROPERTY_RIGHT_YAXIS
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_YAXIS
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
TimeseriesWidgetDefinition()
TimeseriesWidgetDefinition(List<TimeseriesWidgetRequest> requests, TimeseriesWidgetDefinitionType type)

Method Summary

Modifier and Type	Method	Description
TimeseriesWidgetDefinition	addCustomLinksItem(WidgetCustomLink customLinksItem)
TimeseriesWidgetDefinition	addEventsItem(WidgetEvent eventsItem)
TimeseriesWidgetDefinition	addLegendColumnsItem(TimeseriesWidgetLegendColumn legendColumnsItem)
TimeseriesWidgetDefinition	addMarkersItem(WidgetMarker markersItem)
TimeseriesWidgetDefinition	addRequestsItem(TimeseriesWidgetRequest requestsItem)
TimeseriesWidgetDefinition	customLinks(List<WidgetCustomLink> customLinks)
TimeseriesWidgetDefinition	description(String description)
boolean	equals(Object o)	Return true if this TimeseriesWidgetDefinition object is equal to o.
TimeseriesWidgetDefinition	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.
List<TimeseriesWidgetLegendColumn>	getLegendColumns()	Columns displayed in the legend.
TimeseriesWidgetLegendLayout	getLegendLayout()	Layout of the legend.
String	getLegendSize()	Available legend sizes for a widget.
List<WidgetMarker>	getMarkers()	List of markers.
List<TimeseriesWidgetRequest>	getRequests()	List of timeseries widget requests.
WidgetAxis	getRightYaxis()	Axis controls for the widget.
Boolean	getShowLegend()	(screenboard only) Show the legend for this widget.
WidgetTime	getTime()	Time setting for the widget.
String	getTitle()	Title of your widget.
WidgetTextAlign	getTitleAlign()	How to align the text on the widget.
String	getTitleSize()	Size of the title.
TimeseriesWidgetDefinitionType	getType()	Type of the timeseries widget.
WidgetAxis	getYaxis()	Axis controls for the widget.
int	hashCode()
TimeseriesWidgetDefinition	legendColumns(List<TimeseriesWidgetLegendColumn> legendColumns)
TimeseriesWidgetDefinition	legendLayout(TimeseriesWidgetLegendLayout legendLayout)
TimeseriesWidgetDefinition	legendSize(String legendSize)
TimeseriesWidgetDefinition	markers(List<WidgetMarker> markers)
TimeseriesWidgetDefinition	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
TimeseriesWidgetDefinition	requests(List<TimeseriesWidgetRequest> requests)
TimeseriesWidgetDefinition	rightYaxis(WidgetAxis rightYaxis)
void	setCustomLinks(List<WidgetCustomLink> customLinks)
void	setDescription(String description)
void	setEvents(List<WidgetEvent> events)	Deprecated.
void	setLegendColumns(List<TimeseriesWidgetLegendColumn> legendColumns)
void	setLegendLayout(TimeseriesWidgetLegendLayout legendLayout)
void	setLegendSize(String legendSize)
void	setMarkers(List<WidgetMarker> markers)
void	setRequests(List<TimeseriesWidgetRequest> requests)
void	setRightYaxis(WidgetAxis rightYaxis)
void	setShowLegend(Boolean showLegend)
void	setTime(WidgetTime time)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(TimeseriesWidgetDefinitionType type)
void	setYaxis(WidgetAxis yaxis)
TimeseriesWidgetDefinition	showLegend(Boolean showLegend)
TimeseriesWidgetDefinition	time(WidgetTime time)
TimeseriesWidgetDefinition	title(String title)
TimeseriesWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
TimeseriesWidgetDefinition	titleSize(String titleSize)
String	toString()
TimeseriesWidgetDefinition	type(TimeseriesWidgetDefinitionType type)
TimeseriesWidgetDefinition	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_COLUMNS

public static final String JSON_PROPERTY_LEGEND_COLUMNS

See Also:

• Constant Field Values

JSON_PROPERTY_LEGEND_LAYOUT

public static final String JSON_PROPERTY_LEGEND_LAYOUT

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_RIGHT_YAXIS

public static final String JSON_PROPERTY_RIGHT_YAXIS

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 Details

TimeseriesWidgetDefinition

public TimeseriesWidgetDefinition()

TimeseriesWidgetDefinition

public TimeseriesWidgetDefinition(List<TimeseriesWidgetRequest> requests,
 TimeseriesWidgetDefinitionType type)

Method Details

customLinks

public TimeseriesWidgetDefinition customLinks(List<WidgetCustomLink> customLinks)

addCustomLinksItem

public TimeseriesWidgetDefinition addCustomLinksItem(WidgetCustomLink customLinksItem)

getCustomLinks

@Nullable
public List<WidgetCustomLink> getCustomLinks()

List of custom links.

Returns:

customLinks

setCustomLinks

public void setCustomLinks(List<WidgetCustomLink> customLinks)

description

public TimeseriesWidgetDefinition description(String description)

getDescription

@Nullable
public String getDescription()

The description of the widget.

Returns:

description

setDescription

public void setDescription(String description)

events

public TimeseriesWidgetDefinition events(List<WidgetEvent> events)

addEventsItem

public TimeseriesWidgetDefinition 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.

legendColumns

public TimeseriesWidgetDefinition legendColumns(List<TimeseriesWidgetLegendColumn> legendColumns)

addLegendColumnsItem

public TimeseriesWidgetDefinition addLegendColumnsItem(TimeseriesWidgetLegendColumn legendColumnsItem)

getLegendColumns

@Nullable
public List<TimeseriesWidgetLegendColumn> getLegendColumns()

Columns displayed in the legend.

Returns:

legendColumns

setLegendColumns

public void setLegendColumns(List<TimeseriesWidgetLegendColumn> legendColumns)

legendLayout

public TimeseriesWidgetDefinition legendLayout(TimeseriesWidgetLegendLayout legendLayout)

getLegendLayout

@Nullable
public TimeseriesWidgetLegendLayout getLegendLayout()

Layout of the legend.

Returns:

legendLayout

setLegendLayout

public void setLegendLayout(TimeseriesWidgetLegendLayout legendLayout)

legendSize

public TimeseriesWidgetDefinition 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 TimeseriesWidgetDefinition markers(List<WidgetMarker> markers)

addMarkersItem

public TimeseriesWidgetDefinition addMarkersItem(WidgetMarker markersItem)

getMarkers

@Nullable
public List<WidgetMarker> getMarkers()

List of markers.

Returns:

markers

setMarkers

public void setMarkers(List<WidgetMarker> markers)

requests

public TimeseriesWidgetDefinition requests(List<TimeseriesWidgetRequest> requests)

addRequestsItem

public TimeseriesWidgetDefinition addRequestsItem(TimeseriesWidgetRequest requestsItem)

getRequests

public List<TimeseriesWidgetRequest> getRequests()

List of timeseries widget requests.

Returns:

requests

setRequests

public void setRequests(List<TimeseriesWidgetRequest> requests)

rightYaxis

public TimeseriesWidgetDefinition rightYaxis(WidgetAxis rightYaxis)

getRightYaxis

@Nullable
public WidgetAxis getRightYaxis()

Axis controls for the widget.

Returns:

rightYaxis

setRightYaxis

public void setRightYaxis(WidgetAxis rightYaxis)

showLegend

public TimeseriesWidgetDefinition showLegend(Boolean showLegend)

getShowLegend

@Nullable
public Boolean getShowLegend()

(screenboard only) Show the legend for this widget.

Returns:

showLegend

setShowLegend

public void setShowLegend(Boolean showLegend)

time

public TimeseriesWidgetDefinition time(WidgetTime time)

getTime

@Nullable
public WidgetTime getTime()

Time setting for the widget.

Returns:

time

setTime

public void setTime(WidgetTime time)

title

public TimeseriesWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of your widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

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

getTitleSize

@Nullable
public String getTitleSize()

Size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public TimeseriesWidgetDefinition type(TimeseriesWidgetDefinitionType type)

getType

public TimeseriesWidgetDefinitionType getType()

Type of the timeseries widget.

Returns:

type

setType

public void setType(TimeseriesWidgetDefinitionType type)

yaxis

public TimeseriesWidgetDefinition yaxis(WidgetAxis yaxis)

getYaxis

@Nullable
public WidgetAxis getYaxis()

Axis controls for the widget.

Returns:

yaxis

setYaxis

public void setYaxis(WidgetAxis yaxis)

putAdditionalProperty

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

TimeseriesWidgetDefinition

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