Class: DatadogAPIClient::V1::HostMapWidgetDefinition

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

Overview

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

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



66
67
68
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 66

def additional_properties
  @additional_properties
end

#custom_links ⇒ Object

List of custom links.



25
26
27
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 25

def custom_links
  @custom_links
end

#description ⇒ Object

The description of the widget.



28
29
30
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 28

def description
  @description
end

#group ⇒ Object

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



31
32
33
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 31

def group
  @group
end

#no_group_hosts ⇒ Object

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



34
35
36
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 34

def no_group_hosts
  @no_group_hosts
end

#no_metric_hosts ⇒ Object

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



37
38
39
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 37

def no_metric_hosts
  @no_metric_hosts
end

#node_type ⇒ Object

Which type of node to use in the map.



40
41
42
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 40

def node_type
  @node_type
end

#notes ⇒ Object

Notes on the title.



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

def notes
  @notes
end

#requests ⇒ 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).



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

def requests
  @requests
end

#scope ⇒ Object

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



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

def scope
  @scope
end

#style ⇒ Object

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



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

def style
  @style
end

#title ⇒ Object

Title of the widget.



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

def title
  @title
end

#title_align ⇒ Object

How to align the text on the widget.



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

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Type of the host map widget.



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

def type
  @type
end