Class: DatadogAPIClient::V1::TimeseriesWidgetDefinition

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

Overview

The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimeseriesWidgetDefinition

Initializes the object

Parameters:

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

    attributes Model attributes in the form of hash



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 124

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::TimeseriesWidgetDefinition` 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::TimeseriesWidgetDefinition`. 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?(:'events')
    if (value = attributes[:'events']).is_a?(Array)
      self.events = value
    end
  end

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

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

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

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

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

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

  if attributes.key?(:'show_legend')
    self.show_legend = attributes[:'show_legend']
  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 = 'timeseries'
  end

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

Instance Attribute Details

List of custom links.



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

def custom_links
  @custom_links
end

#events ⇒ Object

List of widget events.



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

def events
  @events
end

#legend_columns ⇒ Object

Columns displayed in the legend.



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

def legend_columns
  @legend_columns
end

#legend_layout ⇒ Object

Returns the value of attribute legend_layout.



35
36
37
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 35

def legend_layout
  @legend_layout
end

#legend_size ⇒ Object

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".



38
39
40
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 38

def legend_size
  @legend_size
end

#markers ⇒ Object

List of markers.



41
42
43
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 41

def markers
  @markers
end

#requests ⇒ Object

List of timeseries widget requests.



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

def requests
  @requests
end

#right_yaxis ⇒ Object

Returns the value of attribute right_yaxis.



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

def right_yaxis
  @right_yaxis
end

#show_legend ⇒ Object

(screenboard only) Show the legend for this widget.



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

def show_legend
  @show_legend
end

#time ⇒ Object

Returns the value of attribute time.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 51

def time
  @time
end

#title ⇒ Object

Title of your widget.



54
55
56
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 54

def title
  @title
end

#title_align ⇒ Object

Returns the value of attribute title_align.



56
57
58
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 56

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



59
60
61
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 59

def title_size
  @title_size
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#yaxis ⇒ Object

Returns the value of attribute yaxis.



63
64
65
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 63

def yaxis
  @yaxis
end