Class: DatadogAPIClient::V1::MetricsQueryMetadata

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/metrics_query_metadata.rb

Overview

Object containing all metric names returned and their associated metadata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_end ⇒ Object

End of the time window, milliseconds since Unix epoch.



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

def _end
  @_end
end

#_unparsed ⇒ Object

whether the object has unparsed attributes



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

def _unparsed
  @_unparsed
end

#aggr ⇒ Object

Aggregation type.



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

def aggr
  @aggr
end

#display_name ⇒ Object

Display name of the metric.



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

def display_name
  @display_name
end

#expression ⇒ Object

Metric expression.



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

def expression
  @expression
end

#interval ⇒ Object

Number of milliseconds between data samples.



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

def interval
  @interval
end

#length ⇒ Object

Number of data samples.



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

def length
  @length
end

#metric ⇒ Object

Metric name.



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

def metric
  @metric
end

#pointlist ⇒ Object

List of points of the timeseries in milliseconds.



47
48
49
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 47

def pointlist
  @pointlist
end

#query_index ⇒ Object

The index of the series' query within the request.



50
51
52
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 50

def query_index
  @query_index
end

#scope ⇒ Object

Metric scope, comma separated list of tags.



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

def scope
  @scope
end

#start ⇒ Object

Start of the time window, milliseconds since Unix epoch.



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

def start
  @start
end

#tag_set ⇒ Object

Unique tags identifying this series.



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

def tag_set
  @tag_set
end

#unit ⇒ Object

Detailed information about the metric unit. The first element describes the "primary unit" (for example, bytes in bytes per second). The second element describes the "per unit" (for example, second in bytes per second). If the second element is not present, the API returns null.



62
63
64
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 62

def unit
  @unit
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 84

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



260
261
262
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 260

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 290

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 368

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 267

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


247
248
249
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 247

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



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 190

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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



344
345
346
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 344

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 350

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



338
339
340
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 338

def to_s
  to_hash.to_s
end