Class: DatadogAPIClient::V1::GeomapWidgetDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/models/geomap_widget_definition.rb

Overview

This visualization displays a series of values by country on a world map.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GeomapWidgetDefinition

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    attributes Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/datadog_api_client/v1/models/geomap_widget_definition.rb', line 95

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::GeomapWidgetDefinition` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::GeomapWidgetDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'custom_links')
    if (value = attributes[:'custom_links']).is_a?(Array)
      self.custom_links = value
    end
  end

  if attributes.key?(:'requests')
    if (value = attributes[:'requests']).is_a?(Array)
      self.requests = value
    end
  end

  if attributes.key?(:'style')
    self.style = attributes[:'style']
  end

  if attributes.key?(:'time')
    self.time = attributes[:'time']
  end

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.key?(:'title_align')
    self.title_align = attributes[:'title_align']
  end

  if attributes.key?(:'title_size')
    self.title_size = attributes[:'title_size']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'geomap'
  end

  if attributes.key?(:'view')
    self.view = attributes[:'view']
  end
end

Instance Attribute Details

A list of custom links.



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

def custom_links
  @custom_links
end

#requests ⇒ Object

Array of one request object to display in the widget. The request must contain a ‘group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`.



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

def requests
  @requests
end

#style ⇒ Object

Returns the value of attribute style.



32
33
34
 
# File 'lib/datadog_api_client/v1/models/geomap_widget_definition.rb', line 32

def style
  @style
end

#time ⇒ Object

Returns the value of attribute time.



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

def time
  @time
end

#title ⇒ Object

The title of your widget.



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

def title
  @title
end

#title_align ⇒ Object

Returns the value of attribute title_align.



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

def title_align
  @title_align
end

#title_size ⇒ Object

The size of the title.



42
43
44
 
# File 'lib/datadog_api_client/v1/models/geomap_widget_definition.rb', line 42

def title_size
  @title_size
end

#type ⇒ Object

Returns the value of attribute type.



44
45
46
 
# File 'lib/datadog_api_client/v1/models/geomap_widget_definition.rb', line 44

def type
  @type
end

#view ⇒ Object

Returns the value of attribute view.



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

def view
  @view
end