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

Class HostMapWidgetDefinitionRequests

java.lang.Object

com.datadog.api.client.v1.model.HostMapWidgetDefinitionRequests

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

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).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CHILD
static final String	JSON_PROPERTY_CONDITIONAL_FORMATS
static final String	JSON_PROPERTY_ENRICHMENTS
static final String	JSON_PROPERTY_FILL
static final String	JSON_PROPERTY_FILTER
static final String	JSON_PROPERTY_GROUP_BY
static final String	JSON_PROPERTY_LIMIT
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_PROJECTION
static final String	JSON_PROPERTY_QUERY
static final String	JSON_PROPERTY_REQUEST_TYPE
static final String	JSON_PROPERTY_SIZE
static final String	JSON_PROPERTY_STYLE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
HostMapWidgetDefinitionRequests()

Method Summary

Modifier and Type	Method	Description
HostMapWidgetDefinitionRequests	addConditionalFormatsItem(WidgetConditionalFormat conditionalFormatsItem)
HostMapWidgetDefinitionRequests	addEnrichmentsItem(HostMapWidgetScalarRequest enrichmentsItem)
HostMapWidgetDefinitionRequests	addGroupByItem(HostMapWidgetGroupBy groupByItem)
HostMapWidgetDefinitionRequests	child(HostMapWidgetInfrastructureRequest child)
HostMapWidgetDefinitionRequests	conditionalFormats(List<WidgetConditionalFormat> conditionalFormats)
HostMapWidgetDefinitionRequests	enrichments(List<HostMapWidgetScalarRequest> enrichments)
boolean	equals(Object o)	Return true if this HostMapWidgetDefinitionRequests object is equal to o.
HostMapWidgetDefinitionRequests	fill(HostMapRequest fill)
HostMapWidgetDefinitionRequests	filter(String filter)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
HostMapWidgetInfrastructureRequest	getChild()	Infrastructure-backed request for the host map widget.
List<WidgetConditionalFormat>	getConditionalFormats()	List of conditional formatting rules applied to fill values.
List<HostMapWidgetScalarRequest>	getEnrichments()	Metric or event queries joined to the entity set.
HostMapRequest	getFill()	Deprecated.
String	getFilter()	Filter string for the entity set in tag format (for example, env:prod).
List<HostMapWidgetGroupBy>	getGroupBy()	Defines how entities are grouped into tiles.
Long	getLimit()	Maximum number of rows to return from the dataset query.
HostMapWidgetNodeType	getNodeType()	Which type of infrastructure entity to visualize in the host map.
Boolean	getNoGroupHosts()	Whether to hide entities that have no group assignment.
Boolean	getNoMetricHosts()	Whether to hide entities that have no enrichment data.
HostMapWidgetProjection	getProjection()	Projection for the DDSQL host map request.
DatasetListQuery	getQuery()	Query that lists the rows of a published dataset (a DDSQL query) without aggregation.
HostMapWidgetDefinitionRequestType	getRequestType()	Identifies which host map request format the sibling fields on HostMapWidgetDefinitionRequests describe: an infrastructure-backed request or a DDSQL published-dataset request.
HostMapRequest	getSize()	Deprecated.
HostMapWidgetInfrastructureStyle	getStyle()	Style configuration for the infrastructure host map.
HostMapWidgetDefinitionRequests	groupBy(List<HostMapWidgetGroupBy> groupBy)
int	hashCode()
HostMapWidgetDefinitionRequests	limit(Long limit)
HostMapWidgetDefinitionRequests	nodeType(HostMapWidgetNodeType nodeType)
HostMapWidgetDefinitionRequests	noGroupHosts(Boolean noGroupHosts)
HostMapWidgetDefinitionRequests	noMetricHosts(Boolean noMetricHosts)
HostMapWidgetDefinitionRequests	projection(HostMapWidgetProjection projection)
HostMapWidgetDefinitionRequests	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
HostMapWidgetDefinitionRequests	query(DatasetListQuery query)
HostMapWidgetDefinitionRequests	requestType(HostMapWidgetDefinitionRequestType requestType)
void	setChild(HostMapWidgetInfrastructureRequest child)
void	setConditionalFormats(List<WidgetConditionalFormat> conditionalFormats)
void	setEnrichments(List<HostMapWidgetScalarRequest> enrichments)
void	setFill(HostMapRequest fill)	Deprecated.
void	setFilter(String filter)
void	setGroupBy(List<HostMapWidgetGroupBy> groupBy)
void	setLimit(Long limit)
void	setNodeType(HostMapWidgetNodeType nodeType)
void	setNoGroupHosts(Boolean noGroupHosts)
void	setNoMetricHosts(Boolean noMetricHosts)
void	setProjection(HostMapWidgetProjection projection)
void	setQuery(DatasetListQuery query)
void	setRequestType(HostMapWidgetDefinitionRequestType requestType)
void	setSize(HostMapRequest size)	Deprecated.
void	setStyle(HostMapWidgetInfrastructureStyle style)
HostMapWidgetDefinitionRequests	size(HostMapRequest size)
HostMapWidgetDefinitionRequests	style(HostMapWidgetInfrastructureStyle style)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_CHILD

public static final String JSON_PROPERTY_CHILD

See Also:

• Constant Field Values

JSON_PROPERTY_CONDITIONAL_FORMATS

public static final String JSON_PROPERTY_CONDITIONAL_FORMATS

See Also:

• Constant Field Values

JSON_PROPERTY_ENRICHMENTS

public static final String JSON_PROPERTY_ENRICHMENTS

See Also:

• Constant Field Values

JSON_PROPERTY_FILL

public static final String JSON_PROPERTY_FILL

See Also:

• Constant Field Values

JSON_PROPERTY_FILTER

public static final String JSON_PROPERTY_FILTER

See Also:

• Constant Field Values

JSON_PROPERTY_GROUP_BY

public static final String JSON_PROPERTY_GROUP_BY

See Also:

• Constant Field Values

JSON_PROPERTY_LIMIT

public static final String JSON_PROPERTY_LIMIT

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_PROJECTION

public static final String JSON_PROPERTY_PROJECTION

See Also:

• Constant Field Values

JSON_PROPERTY_QUERY

public static final String JSON_PROPERTY_QUERY

See Also:

• Constant Field Values

JSON_PROPERTY_REQUEST_TYPE

public static final String JSON_PROPERTY_REQUEST_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_SIZE

public static final String JSON_PROPERTY_SIZE

See Also:

• Constant Field Values

JSON_PROPERTY_STYLE

public static final String JSON_PROPERTY_STYLE

See Also:

• Constant Field Values

Constructor Details

HostMapWidgetDefinitionRequests

public HostMapWidgetDefinitionRequests()

Method Details

child

public HostMapWidgetDefinitionRequests child(HostMapWidgetInfrastructureRequest child)

getChild

@Nullable
public HostMapWidgetInfrastructureRequest getChild()

Infrastructure-backed request for the host map widget. Supports entity-based visualization with metric query enrichments, tag-based filtering, flexible grouping, and hierarchical views.

Returns:

child

setChild

public void setChild(HostMapWidgetInfrastructureRequest child)

conditionalFormats

public HostMapWidgetDefinitionRequests conditionalFormats(List<WidgetConditionalFormat> conditionalFormats)

addConditionalFormatsItem

public HostMapWidgetDefinitionRequests addConditionalFormatsItem(WidgetConditionalFormat conditionalFormatsItem)

getConditionalFormats

@Nullable
public List<WidgetConditionalFormat> getConditionalFormats()

List of conditional formatting rules applied to fill values.

Returns:

conditionalFormats

setConditionalFormats

public void setConditionalFormats(List<WidgetConditionalFormat> conditionalFormats)

enrichments

public HostMapWidgetDefinitionRequests enrichments(List<HostMapWidgetScalarRequest> enrichments)

addEnrichmentsItem

public HostMapWidgetDefinitionRequests addEnrichmentsItem(HostMapWidgetScalarRequest enrichmentsItem)

getEnrichments

@Nullable
public List<HostMapWidgetScalarRequest> getEnrichments()

Metric or event queries joined to the entity set. Each formula specifies a visual dimension. Only used by the infrastructure-backed format.

Returns:

enrichments

setEnrichments

public void setEnrichments(List<HostMapWidgetScalarRequest> enrichments)

fill

public HostMapWidgetDefinitionRequests fill(HostMapRequest fill)

getFill

@Deprecated
@Nullable
public HostMapRequest getFill()

Deprecated.

Deprecated - Legacy metric-based host map request. Use the infrastructure-backed ( request_type: infrastructure_hostmap) or DDSQL (request_type: data_projection ) format instead.

Returns:

fill

setFill

@Deprecated
public void setFill(HostMapRequest fill)

Deprecated.

filter

public HostMapWidgetDefinitionRequests filter(String filter)

getFilter

@Nullable
public String getFilter()

Filter string for the entity set in tag format (for example, env:prod). Only used by the infrastructure-backed format.

Returns:

filter

setFilter

public void setFilter(String filter)

groupBy

public HostMapWidgetDefinitionRequests groupBy(List<HostMapWidgetGroupBy> groupBy)

addGroupByItem

public HostMapWidgetDefinitionRequests addGroupByItem(HostMapWidgetGroupBy groupByItem)

getGroupBy

@Nullable
public List<HostMapWidgetGroupBy> getGroupBy()

Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. Only used by the infrastructure-backed format.

Returns:

groupBy

setGroupBy

public void setGroupBy(List<HostMapWidgetGroupBy> groupBy)

limit

public HostMapWidgetDefinitionRequests limit(Long limit)

getLimit

@Nullable
public Long getLimit()

Maximum number of rows to return from the dataset query. Only used by the DDSQL format.

Returns:

limit

setLimit

public void setLimit(Long limit)

noGroupHosts

public HostMapWidgetDefinitionRequests noGroupHosts(Boolean noGroupHosts)

getNoGroupHosts

@Nullable
public Boolean getNoGroupHosts()

Whether to hide entities that have no group assignment.

Returns:

noGroupHosts

setNoGroupHosts

public void setNoGroupHosts(Boolean noGroupHosts)

noMetricHosts

public HostMapWidgetDefinitionRequests noMetricHosts(Boolean noMetricHosts)

getNoMetricHosts

@Nullable
public Boolean getNoMetricHosts()

Whether to hide entities that have no enrichment data.

Returns:

noMetricHosts

setNoMetricHosts

public void setNoMetricHosts(Boolean noMetricHosts)

nodeType

public HostMapWidgetDefinitionRequests nodeType(HostMapWidgetNodeType nodeType)

getNodeType

@Nullable
public HostMapWidgetNodeType getNodeType()

Which type of infrastructure entity to visualize in the host map.

Returns:

nodeType

setNodeType

public void setNodeType(HostMapWidgetNodeType nodeType)

projection

public HostMapWidgetDefinitionRequests projection(HostMapWidgetProjection projection)

getProjection

@Nullable
public HostMapWidgetProjection getProjection()

Projection for the DDSQL host map request. Maps dataset columns to map dimensions: node identifies the entity, repeated group entries define the grouping hierarchy (outermost first), and fill/size drive the tile color and size.

Returns:

projection

setProjection

public void setProjection(HostMapWidgetProjection projection)

query

public HostMapWidgetDefinitionRequests query(DatasetListQuery query)

getQuery

@Nullable
public DatasetListQuery getQuery()

Query that lists the rows of a published dataset (a DDSQL query) without aggregation.

Returns:

query

setQuery

public void setQuery(DatasetListQuery query)

requestType

public HostMapWidgetDefinitionRequests requestType(HostMapWidgetDefinitionRequestType requestType)

getRequestType

@Nullable
public HostMapWidgetDefinitionRequestType getRequestType()

Identifies which host map request format the sibling fields on HostMapWidgetDefinitionRequests describe: an infrastructure-backed request or a DDSQL published-dataset request.

Returns:

requestType

setRequestType

public void setRequestType(HostMapWidgetDefinitionRequestType requestType)

size

public HostMapWidgetDefinitionRequests size(HostMapRequest size)

getSize

@Deprecated
@Nullable
public HostMapRequest getSize()

Deprecated.

Deprecated - Legacy metric-based host map request. Use the infrastructure-backed ( request_type: infrastructure_hostmap) or DDSQL (request_type: data_projection ) format instead.

Returns:

size

setSize

@Deprecated
public void setSize(HostMapRequest size)

Deprecated.

style

public HostMapWidgetDefinitionRequests style(HostMapWidgetInfrastructureStyle style)

getStyle

@Nullable
public HostMapWidgetInfrastructureStyle getStyle()

Style configuration for the infrastructure host map.

Returns:

style

setStyle

public void setStyle(HostMapWidgetInfrastructureStyle style)

putAdditionalProperty

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

HostMapWidgetDefinitionRequests

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