Class: DatadogAPIClient::V1::HostMapWidgetDefinitionRequests

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb

Overview

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

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



72
73
74
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 72

def additional_properties
  @additional_properties
end

#child ⇒ Object

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



27
28
29
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 27

def child
  @child
end

#conditional_formats ⇒ Object

List of conditional formatting rules applied to fill values.



30
31
32
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 30

def conditional_formats
  @conditional_formats
end

#enrichments ⇒ Object

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



33
34
35
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 33

def enrichments
  @enrichments
end

#fill ⇒ Object

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



36
37
38
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 36

def fill
  @fill
end

#filter ⇒ Object

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



39
40
41
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 39

def filter
  @filter
end

#group_by ⇒ Object

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



43
44
45
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 43

def group_by
  @group_by
end

#limit ⇒ Object

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



46
47
48
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 46

def limit
  @limit
end

#no_group_hosts ⇒ Object

Whether to hide entities that have no group assignment.



49
50
51
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 49

def no_group_hosts
  @no_group_hosts
end

#no_metric_hosts ⇒ Object

Whether to hide entities that have no enrichment data.



52
53
54
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 52

def no_metric_hosts
  @no_metric_hosts
end

#node_type ⇒ Object

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



55
56
57
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 55

def node_type
  @node_type
end

#projection ⇒ Object

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.



58
59
60
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 58

def projection
  @projection
end

#query ⇒ Object

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



61
62
63
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 61

def query
  @query
end

#request_type ⇒ Object

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



64
65
66
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 64

def request_type
  @request_type
end

#size ⇒ Object

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



67
68
69
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 67

def size
  @size
end

#style ⇒ Object

Style configuration for the infrastructure host map.



70
71
72
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb', line 70

def style
  @style
end