Class: DatadogAPIClient::V1::TimeseriesWidgetDefinition

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
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

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 23

def _unparsed
  @_unparsed
end

#custom_links ⇒ Object

List of custom links.



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

def custom_links
  @custom_links
end

#events ⇒ Object

List of widget events.



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

def events
  @events
end

#legend_columns ⇒ Object

Columns displayed in the legend.



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

def legend_columns
  @legend_columns
end

#legend_layout ⇒ Object

Layout of the legend.



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

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



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

def legend_size
  @legend_size
end

#markers ⇒ Object

List of markers.



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

def markers
  @markers
end

#requests ⇒ Object

List of timeseries widget requests.



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

def requests
  @requests
end

#right_yaxis ⇒ Object

Axis controls for the widget.



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.



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

def show_legend
  @show_legend
end

#time ⇒ Object

Time setting for the widget.



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

def time
  @time
end

#title ⇒ Object

Title of your widget.



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

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/timeseries_widget_definition.rb', line 58

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Type of the timeseries widget.



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

def type
  @type
end

#yaxis ⇒ Object

Axis controls for the widget.



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

def yaxis
  @yaxis
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



284
285
286
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 284

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 112

def self.openapi_nullable
  Set.new([
  ])
end

Instance Method Details

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 314

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when :Array
    # generic array, return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = DatadogAPIClient::V1.const_get(type)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V1::UnparsedObject
      self._unparsed = true
    end
    res
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 392

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 291

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


271
272
273
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 271

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 207

def list_invalid_properties
  invalid_properties = Array.new
  if @requests.nil?
    invalid_properties.push('invalid value for "requests", requests cannot be nil.')
  end

  if @requests.length < 1
    invalid_properties.push('invalid value for "requests", number of items must be greater than or equal to 1.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



368
369
370
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 368

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 374

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



362
363
364
 
# File 'lib/datadog_api_client/v1/models/timeseries_widget_definition.rb', line 362

def to_s
  to_hash.to_s
end