class DatadogAPIClient::V1::TimeseriesWidgetDefinition

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

Attributes

events[RW]

List of widget events.

legend_columns[RW]

Columns displayed in the legend.

legend_layout[RW]
legend_size[RW]

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

markers[RW]

List of markers.

requests[RW]

List of timeseries widget requests.

right_yaxis[RW]
show_legend[RW]

(screenboard only) Show the legend for this widget.

time[RW]
title[RW]

Title of your widget.

title_align[RW]
title_size[RW]

Size of the title.

type[RW]
yaxis[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 83
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 62
def self.attribute_map
  {
    :'custom_links' => :'custom_links',
    :'events' => :'events',
    :'legend_columns' => :'legend_columns',
    :'legend_layout' => :'legend_layout',
    :'legend_size' => :'legend_size',
    :'markers' => :'markers',
    :'requests' => :'requests',
    :'right_yaxis' => :'right_yaxis',
    :'show_legend' => :'show_legend',
    :'time' => :'time',
    :'title' => :'title',
    :'title_align' => :'title_align',
    :'title_size' => :'title_size',
    :'type' => :'type',
    :'yaxis' => :'yaxis'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 281
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 116
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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 109
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 88
def self.openapi_types
  {
    :'custom_links' => :'Array<WidgetCustomLink>',
    :'events' => :'Array<WidgetEvent>',
    :'legend_columns' => :'Array<TimeseriesWidgetLegendColumn>',
    :'legend_layout' => :'TimeseriesWidgetLegendLayout',
    :'legend_size' => :'String',
    :'markers' => :'Array<WidgetMarker>',
    :'requests' => :'Array<TimeseriesWidgetRequest>',
    :'right_yaxis' => :'WidgetAxis',
    :'show_legend' => :'Boolean',
    :'time' => :'WidgetTime',
    :'title' => :'String',
    :'title_align' => :'WidgetTextAlign',
    :'title_size' => :'String',
    :'type' => :'TimeseriesWidgetDefinitionType',
    :'yaxis' => :'WidgetAxis'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 246
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      custom_links == o.custom_links &&
      events == o.events &&
      legend_columns == o.legend_columns &&
      legend_layout == o.legend_layout &&
      legend_size == o.legend_size &&
      markers == o.markers &&
      requests == o.requests &&
      right_yaxis == o.right_yaxis &&
      show_legend == o.show_legend &&
      time == o.time &&
      title == o.title &&
      title_align == o.title_align &&
      title_size == o.title_size &&
      type == o.type &&
      yaxis == o.yaxis
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 311
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)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 385
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 288
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 268
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 274
def hash
  [custom_links, events, legend_columns, legend_layout, legend_size, markers, requests, right_yaxis, show_legend, time, title, title_align, title_size, type, yaxis].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 204
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
requests=(requests) click to toggle source

Custom attribute writer method with validation @param [Object] requests Value to be assigned

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 232
def requests=(requests)
  if requests.nil?
    fail ArgumentError, 'requests cannot be nil'
  end

  if requests.length < 1
    fail ArgumentError, 'invalid value for "requests", number of items must be greater than or equal to 1.'
  end

  @requests = requests
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 361
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 367
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 355
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/datadog_api_client/v1/models/timeseries_widget_definition.rb, line 223
def valid?
  return false if @requests.nil?
  return false if @requests.length < 1
  return false if @type.nil?
  true
end