Class: DatadogAPIClient::V1::MetricsQueryResponse

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

Overview

Response Object that includes your query and the list of metrics retrieved.

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/metrics_query_response.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 51

def additional_properties
  @additional_properties
end

#error ⇒ Object

Message indicating the errors if status is not ok.



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

def error
  @error
end

#from_date ⇒ Object

Start of requested time window, milliseconds since Unix epoch.



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

def from_date
  @from_date
end

#group_by ⇒ Object

List of tag keys on which to group.



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

def group_by
  @group_by
end

#message ⇒ Object

Message indicating success if status is ok.



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

def message
  @message
end

#query ⇒ Object

Query string



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

def query
  @query
end

#res_type ⇒ Object

Type of response.



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

def res_type
  @res_type
end

#series ⇒ Object

List of timeseries queried.



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

def series
  @series
end

#status ⇒ Object

Status of the query.



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

def status
  @status
end

#to_date ⇒ Object

End of requested time window, milliseconds since Unix epoch.



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

def to_date
  @to_date
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 68

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



193
194
195
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 193

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 88

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 223

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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 301

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 200

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


180
181
182
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 180

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



151
152
153
154
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 151

def list_invalid_properties
  invalid_properties = Array.new
  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



277
278
279
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 277

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



158
159
160
 
# File 'lib/datadog_api_client/v1/models/metrics_query_response.rb', line 158

def valid?
  true
end