class DatadogAPIClient::V1::MetricsQueryMetadata

Object containing all metric names returned and their associated metadata.

Attributes

_end[RW]

End of the time window, milliseconds since Unix epoch.

aggr[RW]

Aggregation type.

display_name[RW]

Display name of the metric.

expression[RW]

Metric expression.

interval[RW]

Number of seconds between data samples.

length[RW]

Number of data samples.

metric[RW]

Metric name.

pointlist[RW]

List of points of the time series.

query_index[RW]

The index of the series' query within the request.

scope[RW]

Metric scope, comma separated list of tags.

start[RW]

Start of the time window, milliseconds since Unix epoch.

tag_set[RW]

Unique tags identifying this series.

unit[RW]

Detailed information about the metric unit. First element describes the "primary unit" (for example, `bytes` in `bytes per second`), second describes the "per unit" (for example, `second` in `bytes per second`).

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/metrics_query_metadata.rb, line 81
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/metrics_query_metadata.rb, line 62
def self.attribute_map
  {
    :'aggr' => :'aggr',
    :'display_name' => :'display_name',
    :'_end' => :'end',
    :'expression' => :'expression',
    :'interval' => :'interval',
    :'length' => :'length',
    :'metric' => :'metric',
    :'pointlist' => :'pointlist',
    :'query_index' => :'query_index',
    :'scope' => :'scope',
    :'start' => :'start',
    :'tag_set' => :'tag_set',
    :'unit' => :'unit'
  }
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/metrics_query_metadata.rb, line 256
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/metrics_query_metadata.rb, line 112
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::MetricsQueryMetadata` 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::MetricsQueryMetadata`. 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?(:'aggr')
    self.aggr = attributes[:'aggr']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'unit')
    if (value = attributes[:'unit']).is_a?(Array)
      self.unit = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/datadog_api_client/v1/models/metrics_query_metadata.rb, line 86
def self.openapi_types
  {
    :'aggr' => :'String',
    :'display_name' => :'String',
    :'_end' => :'Integer',
    :'expression' => :'String',
    :'interval' => :'Integer',
    :'length' => :'Integer',
    :'metric' => :'String',
    :'pointlist' => :'Array<Array>',
    :'query_index' => :'Integer',
    :'scope' => :'String',
    :'start' => :'Integer',
    :'tag_set' => :'Array<String>',
    :'unit' => :'Array<MetricsQueryUnit>'
  }
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/metrics_query_metadata.rb, line 223
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      aggr == o.aggr &&
      display_name == o.display_name &&
      _end == o._end &&
      expression == o.expression &&
      interval == o.interval &&
      length == o.length &&
      metric == o.metric &&
      pointlist == o.pointlist &&
      query_index == o.query_index &&
      scope == o.scope &&
      start == o.start &&
      tag_set == o.tag_set &&
      unit == o.unit
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/metrics_query_metadata.rb, line 286
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/metrics_query_metadata.rb, line 360
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/metrics_query_metadata.rb, line 263
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/metrics_query_metadata.rb, line 243
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/metrics_query_metadata.rb, line 249
def hash
  [aggr, display_name, _end, expression, interval, length, metric, pointlist, query_index, scope, start, tag_set, unit].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/metrics_query_metadata.rb, line 186
def list_invalid_properties
  invalid_properties = Array.new
  if !@unit.nil? && @unit.length > 2
    invalid_properties.push('invalid value for "unit", number of items must be less than or equal to 2.')
  end

  if !@unit.nil? && @unit.length < 2
    invalid_properties.push('invalid value for "unit", number of items must be greater than or equal to 2.')
  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/metrics_query_metadata.rb, line 336
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/metrics_query_metadata.rb, line 342
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/metrics_query_metadata.rb, line 330
def to_s
  to_hash.to_s
end
unit=(unit) click to toggle source

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

# File lib/datadog_api_client/v1/models/metrics_query_metadata.rb, line 209
def unit=(unit)
  if !unit.nil? && unit.length > 2
    fail ArgumentError, 'invalid value for "unit", number of items must be less than or equal to 2.'
  end

  if !unit.nil? && unit.length < 2
    fail ArgumentError, 'invalid value for "unit", number of items must be greater than or equal to 2.'
  end

  @unit = unit
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/metrics_query_metadata.rb, line 201
def valid?
  return false if !@unit.nil? && @unit.length > 2
  return false if !@unit.nil? && @unit.length < 2
  true
end