Class: DatadogAPIClient::V1::Host

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

Overview

Object representing a host.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsedObject

whether the object has unparsed attributes



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

def _unparsed
  @_unparsed
end

#aliasesObject

Host aliases collected by Datadog.



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

def aliases
  @aliases
end

#appsObject

The Datadog integrations reporting metrics for the host.



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

def apps
  @apps
end

#aws_nameObject

AWS name of your host.



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

def aws_name
  @aws_name
end

#host_nameObject

The host name.



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

def host_name
  @host_name
end

#idObject

The host ID.



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

def id
  @id
end

#is_mutedObject

If a host is muted or unmuted.



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

def is_muted
  @is_muted
end

#last_reported_timeObject

Last time the host reported a metric data point.



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

def last_reported_time
  @last_reported_time
end

#metaObject

Metadata associated with your host.



46
47
48
# File 'lib/datadog_api_client/v1/models/host.rb', line 46

def meta
  @meta
end

#metricsObject

Host Metrics collected.



49
50
51
# File 'lib/datadog_api_client/v1/models/host.rb', line 49

def metrics
  @metrics
end

#mute_timeoutObject

Timeout of the mute applied to your host.



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

def mute_timeout
  @mute_timeout
end

#nameObject

The host name.



54
55
56
# File 'lib/datadog_api_client/v1/models/host.rb', line 54

def name
  @name
end

#sourcesObject

Source or cloud provider associated with your host.



57
58
59
# File 'lib/datadog_api_client/v1/models/host.rb', line 57

def sources
  @sources
end

#tags_by_sourceObject

List of tags for each source (AWS, Datadog Agent, Chef..).



60
61
62
# File 'lib/datadog_api_client/v1/models/host.rb', line 60

def tags_by_source
  @tags_by_source
end

#upObject

Displays UP when the expected metrics are received and displays ??? if no metrics are received.



63
64
65
# File 'lib/datadog_api_client/v1/models/host.rb', line 63

def up
  @up
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



86
87
88
# File 'lib/datadog_api_client/v1/models/host.rb', line 86

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



245
246
247
# File 'lib/datadog_api_client/v1/models/host.rb', line 245

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
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
# File 'lib/datadog_api_client/v1/models/host.rb', line 275

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



353
354
355
356
357
358
359
360
361
362
363
364
365
# File 'lib/datadog_api_client/v1/models/host.rb', line 353

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/datadog_api_client/v1/models/host.rb', line 252

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


232
233
234
# File 'lib/datadog_api_client/v1/models/host.rb', line 232

def eql?(o)
  self == o
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



198
199
200
201
# File 'lib/datadog_api_client/v1/models/host.rb', line 198

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



329
330
331
# File 'lib/datadog_api_client/v1/models/host.rb', line 329

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'lib/datadog_api_client/v1/models/host.rb', line 335

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



323
324
325
# File 'lib/datadog_api_client/v1/models/host.rb', line 323

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



205
206
207
# File 'lib/datadog_api_client/v1/models/host.rb', line 205

def valid?
  true
end