class DatadogAPIClient::V1::WidgetLayout

The layout for a widget on a `free` or **new dashboard layout** dashboard.

Attributes

height[RW]

The height of the widget. Should be a non-negative integer.

is_column_break[RW]

Whether the widget should be the first one on the second column in high density or not. Note: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`.

width[RW]

The width of the widget. Should be a non-negative integer.

x[RW]

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

y[RW]

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

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/widget_layout.rb, line 49
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/widget_layout.rb, line 38
def self.attribute_map
  {
    :'height' => :'height',
    :'is_column_break' => :'is_column_break',
    :'width' => :'width',
    :'x' => :'x',
    :'y' => :'y'
  }
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/widget_layout.rb, line 242
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/widget_layout.rb, line 72
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::WidgetLayout` 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::WidgetLayout`. 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?(:'height')
    self.height = attributes[:'height']
  end

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

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

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

  if attributes.key?(:'y')
    self.y = attributes[:'y']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/datadog_api_client/v1/models/widget_layout.rb, line 54
def self.openapi_types
  {
    :'height' => :'Integer',
    :'is_column_break' => :'Boolean',
    :'width' => :'Integer',
    :'x' => :'Integer',
    :'y' => :'Integer'
  }
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/widget_layout.rb, line 217
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      height == o.height &&
      is_column_break == o.is_column_break &&
      width == o.width &&
      x == o.x &&
      y == o.y
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/widget_layout.rb, line 272
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/widget_layout.rb, line 346
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/widget_layout.rb, line 249
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/widget_layout.rb, line 229
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/widget_layout.rb, line 235
def hash
  [height, is_column_break, width, x, y].hash
end
height=(height) click to toggle source

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

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

  if height < 0
    fail ArgumentError, 'invalid value for "height", must be greater than or equal to 0.'
  end

  @height = height
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/widget_layout.rb, line 108
def list_invalid_properties
  invalid_properties = Array.new
  if @height.nil?
    invalid_properties.push('invalid value for "height", height cannot be nil.')
  end

  if @height < 0
    invalid_properties.push('invalid value for "height", must be greater than or equal to 0.')
  end

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

  if @width < 0
    invalid_properties.push('invalid value for "width", must be greater than or equal to 0.')
  end

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

  if @x < 0
    invalid_properties.push('invalid value for "x", must be greater than or equal to 0.')
  end

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

  if @y < 0
    invalid_properties.push('invalid value for "y", must be greater than or equal to 0.')
  end

  invalid_properties
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/widget_layout.rb, line 322
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/widget_layout.rb, line 328
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/widget_layout.rb, line 316
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/widget_layout.rb, line 147
def valid?
  return false if @height.nil?
  return false if @height < 0
  return false if @width.nil?
  return false if @width < 0
  return false if @x.nil?
  return false if @x < 0
  return false if @y.nil?
  return false if @y < 0
  true
end
width=(width) click to toggle source

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

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

  if width < 0
    fail ArgumentError, 'invalid value for "width", must be greater than or equal to 0.'
  end

  @width = width
end
x=(x) click to toggle source

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

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

  if x < 0
    fail ArgumentError, 'invalid value for "x", must be greater than or equal to 0.'
  end

  @x = x
end
y=(y) click to toggle source

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

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

  if y < 0
    fail ArgumentError, 'invalid value for "y", must be greater than or equal to 0.'
  end

  @y = y
end