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

Class ToplistWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.ToplistWidgetDefinition

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

The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.

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_REQUESTS
static final String	JSON_PROPERTY_STYLE
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
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ToplistWidgetDefinition()
ToplistWidgetDefinition(List<ToplistWidgetRequest> requests, ToplistWidgetDefinitionType type)

Method Summary

Modifier and Type	Method	Description
ToplistWidgetDefinition	addCustomLinksItem(WidgetCustomLink customLinksItem)
ToplistWidgetDefinition	addRequestsItem(ToplistWidgetRequest requestsItem)
ToplistWidgetDefinition	customLinks(List<WidgetCustomLink> customLinks)
ToplistWidgetDefinition	description(String description)
boolean	equals(Object o)	Return true if this ToplistWidgetDefinition 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()	List of custom links.
String	getDescription()	The description of the widget.
List<ToplistWidgetRequest>	getRequests()	List of top list widget requests.
ToplistWidgetStyle	getStyle()	Style customization for a top list 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.
ToplistWidgetDefinitionType	getType()	Type of the top list widget.
int	hashCode()
ToplistWidgetDefinition	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
ToplistWidgetDefinition	requests(List<ToplistWidgetRequest> requests)
void	setCustomLinks(List<WidgetCustomLink> customLinks)
void	setDescription(String description)
void	setRequests(List<ToplistWidgetRequest> requests)
void	setStyle(ToplistWidgetStyle style)
void	setTime(WidgetTime time)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(ToplistWidgetDefinitionType type)
ToplistWidgetDefinition	style(ToplistWidgetStyle style)
ToplistWidgetDefinition	time(WidgetTime time)
ToplistWidgetDefinition	title(String title)
ToplistWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
ToplistWidgetDefinition	titleSize(String titleSize)
String	toString()
ToplistWidgetDefinition	type(ToplistWidgetDefinitionType type)

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_REQUESTS

public static final String JSON_PROPERTY_REQUESTS

See Also:

• Constant Field Values

JSON_PROPERTY_STYLE

public static final String JSON_PROPERTY_STYLE

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

Constructor Details

ToplistWidgetDefinition

public ToplistWidgetDefinition()

ToplistWidgetDefinition

public ToplistWidgetDefinition(List<ToplistWidgetRequest> requests,
 ToplistWidgetDefinitionType type)

Method Details

customLinks

public ToplistWidgetDefinition customLinks(List<WidgetCustomLink> customLinks)

addCustomLinksItem

public ToplistWidgetDefinition addCustomLinksItem(WidgetCustomLink customLinksItem)

getCustomLinks

@Nullable
public List<WidgetCustomLink> getCustomLinks()

List of custom links.

Returns:

customLinks

setCustomLinks

public void setCustomLinks(List<WidgetCustomLink> customLinks)

description

public ToplistWidgetDefinition description(String description)

getDescription

@Nullable
public String getDescription()

The description of the widget.

Returns:

description

setDescription

public void setDescription(String description)

requests

public ToplistWidgetDefinition requests(List<ToplistWidgetRequest> requests)

addRequestsItem

public ToplistWidgetDefinition addRequestsItem(ToplistWidgetRequest requestsItem)

getRequests

public List<ToplistWidgetRequest> getRequests()

List of top list widget requests.

Returns:

requests

setRequests

public void setRequests(List<ToplistWidgetRequest> requests)

style

public ToplistWidgetDefinition style(ToplistWidgetStyle style)

getStyle

@Nullable
public ToplistWidgetStyle getStyle()

Style customization for a top list widget.

Returns:

style

setStyle

public void setStyle(ToplistWidgetStyle style)

time

public ToplistWidgetDefinition time(WidgetTime time)

getTime

@Nullable
public WidgetTime getTime()

Time setting for the widget.

Returns:

time

setTime

public void setTime(WidgetTime time)

title

public ToplistWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of your widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

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

getTitleSize

@Nullable
public String getTitleSize()

Size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public ToplistWidgetDefinition type(ToplistWidgetDefinitionType type)

getType

public ToplistWidgetDefinitionType getType()

Type of the top list widget.

Returns:

type

setType

public void setType(ToplistWidgetDefinitionType type)

putAdditionalProperty

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

ToplistWidgetDefinition

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