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

Class HostMapWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.HostMapWidgetDefinition

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

The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.

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_GROUP
static final String	JSON_PROPERTY_NO_GROUP_HOSTS
static final String	JSON_PROPERTY_NO_METRIC_HOSTS
static final String	JSON_PROPERTY_NODE_TYPE
static final String	JSON_PROPERTY_NOTES
static final String	JSON_PROPERTY_REQUESTS
static final String	JSON_PROPERTY_SCOPE
static final String	JSON_PROPERTY_STYLE
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
HostMapWidgetDefinition()
HostMapWidgetDefinition(HostMapWidgetDefinitionRequests requests, HostMapWidgetDefinitionType type)

Method Summary

Modifier and Type	Method	Description
HostMapWidgetDefinition	addCustomLinksItem(WidgetCustomLink customLinksItem)
HostMapWidgetDefinition	addGroupItem(String groupItem)
HostMapWidgetDefinition	addScopeItem(String scopeItem)
HostMapWidgetDefinition	customLinks(List<WidgetCustomLink> customLinks)
HostMapWidgetDefinition	description(String description)
boolean	equals(Object o)	Return true if this HostMapWidgetDefinition 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<String>	getGroup()	Deprecated.
WidgetNodeType	getNodeType()	Which type of node to use in the map.
Boolean	getNoGroupHosts()	Deprecated.
Boolean	getNoMetricHosts()	Deprecated.
String	getNotes()	Notes on the title.
HostMapWidgetDefinitionRequests	getRequests()	Query definition for the host map widget.
List<String>	getScope()	Deprecated.
HostMapWidgetDefinitionStyle	getStyle()	Deprecated.
String	getTitle()	Title of the widget.
WidgetTextAlign	getTitleAlign()	How to align the text on the widget.
String	getTitleSize()	Size of the title.
HostMapWidgetDefinitionType	getType()	Type of the host map widget.
HostMapWidgetDefinition	group(List<String> group)
int	hashCode()
HostMapWidgetDefinition	nodeType(WidgetNodeType nodeType)
HostMapWidgetDefinition	noGroupHosts(Boolean noGroupHosts)
HostMapWidgetDefinition	noMetricHosts(Boolean noMetricHosts)
HostMapWidgetDefinition	notes(String notes)
HostMapWidgetDefinition	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
HostMapWidgetDefinition	requests(HostMapWidgetDefinitionRequests requests)
HostMapWidgetDefinition	scope(List<String> scope)
void	setCustomLinks(List<WidgetCustomLink> customLinks)
void	setDescription(String description)
void	setGroup(List<String> group)	Deprecated.
void	setNodeType(WidgetNodeType nodeType)
void	setNoGroupHosts(Boolean noGroupHosts)	Deprecated.
void	setNoMetricHosts(Boolean noMetricHosts)	Deprecated.
void	setNotes(String notes)
void	setRequests(HostMapWidgetDefinitionRequests requests)
void	setScope(List<String> scope)	Deprecated.
void	setStyle(HostMapWidgetDefinitionStyle style)	Deprecated.
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(HostMapWidgetDefinitionType type)
HostMapWidgetDefinition	style(HostMapWidgetDefinitionStyle style)
HostMapWidgetDefinition	title(String title)
HostMapWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
HostMapWidgetDefinition	titleSize(String titleSize)
String	toString()
HostMapWidgetDefinition	type(HostMapWidgetDefinitionType 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_GROUP

public static final String JSON_PROPERTY_GROUP

See Also:

• Constant Field Values

JSON_PROPERTY_NO_GROUP_HOSTS

public static final String JSON_PROPERTY_NO_GROUP_HOSTS

See Also:

• Constant Field Values

JSON_PROPERTY_NO_METRIC_HOSTS

public static final String JSON_PROPERTY_NO_METRIC_HOSTS

See Also:

• Constant Field Values

JSON_PROPERTY_NODE_TYPE

public static final String JSON_PROPERTY_NODE_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_NOTES

public static final String JSON_PROPERTY_NOTES

See Also:

• Constant Field Values

JSON_PROPERTY_REQUESTS

public static final String JSON_PROPERTY_REQUESTS

See Also:

• Constant Field Values

JSON_PROPERTY_SCOPE

public static final String JSON_PROPERTY_SCOPE

See Also:

• Constant Field Values

JSON_PROPERTY_STYLE

public static final String JSON_PROPERTY_STYLE

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

HostMapWidgetDefinition

public HostMapWidgetDefinition()

HostMapWidgetDefinition

public HostMapWidgetDefinition(HostMapWidgetDefinitionRequests requests,
 HostMapWidgetDefinitionType type)

Method Details

customLinks

public HostMapWidgetDefinition customLinks(List<WidgetCustomLink> customLinks)

addCustomLinksItem

public HostMapWidgetDefinition addCustomLinksItem(WidgetCustomLink customLinksItem)

getCustomLinks

@Nullable
public List<WidgetCustomLink> getCustomLinks()

List of custom links.

Returns:

customLinks

setCustomLinks

public void setCustomLinks(List<WidgetCustomLink> customLinks)

description

public HostMapWidgetDefinition description(String description)

getDescription

@Nullable
public String getDescription()

The description of the widget.

Returns:

description

setDescription

public void setDescription(String description)

group

public HostMapWidgetDefinition group(List<String> group)

addGroupItem

public HostMapWidgetDefinition addGroupItem(String groupItem)

getGroup

@Deprecated
@Nullable
public List<String> getGroup()

Deprecated.

Deprecated - Only used by the legacy metric-based format. Use group_by (infrastructure) or a group dimension (DDSQL) inside requests instead.

Returns:

group

setGroup

@Deprecated
public void setGroup(List<String> group)

Deprecated.

noGroupHosts

public HostMapWidgetDefinition noGroupHosts(Boolean noGroupHosts)

getNoGroupHosts

@Deprecated
@Nullable
public Boolean getNoGroupHosts()

Deprecated.

Deprecated - Only used by the legacy metric-based format. Use no_group_hosts inside requests instead.

Returns:

noGroupHosts

setNoGroupHosts

@Deprecated
public void setNoGroupHosts(Boolean noGroupHosts)

Deprecated.

noMetricHosts

public HostMapWidgetDefinition noMetricHosts(Boolean noMetricHosts)

getNoMetricHosts

@Deprecated
@Nullable
public Boolean getNoMetricHosts()

Deprecated.

Deprecated - Only used by the legacy metric-based format. Use no_metric_hosts inside requests instead.

Returns:

noMetricHosts

setNoMetricHosts

@Deprecated
public void setNoMetricHosts(Boolean noMetricHosts)

Deprecated.

nodeType

public HostMapWidgetDefinition nodeType(WidgetNodeType nodeType)

getNodeType

@Nullable
public WidgetNodeType getNodeType()

Which type of node to use in the map.

Returns:

nodeType

setNodeType

public void setNodeType(WidgetNodeType nodeType)

notes

public HostMapWidgetDefinition notes(String notes)

getNotes

@Nullable
public String getNotes()

Notes on the title.

Returns:

notes

setNotes

public void setNotes(String notes)

requests

public HostMapWidgetDefinition requests(HostMapWidgetDefinitionRequests requests)

getRequests

public HostMapWidgetDefinitionRequests getRequests()

Query definition for the host map widget. Supports three mutually exclusive formats distinguished by request_type: the deprecated legacy metric-based format ( fill/size, no request_type), the infrastructure-backed format (request_type: infrastructure_hostmap), and the DDSQL published-dataset format ( request_type: data_projection).

Returns:

requests

setRequests

public void setRequests(HostMapWidgetDefinitionRequests requests)

scope

public HostMapWidgetDefinition scope(List<String> scope)

addScopeItem

public HostMapWidgetDefinition addScopeItem(String scopeItem)

getScope

@Deprecated
@Nullable
public List<String> getScope()

Deprecated.

Deprecated - Only used by the legacy metric-based format. Use filter inside requests instead.

Returns:

scope

setScope

@Deprecated
public void setScope(List<String> scope)

Deprecated.

style

public HostMapWidgetDefinition style(HostMapWidgetDefinitionStyle style)

getStyle

@Deprecated
@Nullable
public HostMapWidgetDefinitionStyle getStyle()

Deprecated.

Deprecated - The style to apply to the legacy metric-based host map widget. Use HostMapWidgetInfrastructureStyle instead.

Returns:

style

setStyle

@Deprecated
public void setStyle(HostMapWidgetDefinitionStyle style)

Deprecated.

title

public HostMapWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of the widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

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

getTitleSize

@Nullable
public String getTitleSize()

Size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public HostMapWidgetDefinition type(HostMapWidgetDefinitionType type)

getType

public HostMapWidgetDefinitionType getType()

Type of the host map widget.

Returns:

type

setType

public void setType(HostMapWidgetDefinitionType type)

putAdditionalProperty

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

HostMapWidgetDefinition

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