Class: Comet::OSInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/osinfo.rb

Overview

OSInfo is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeOSInfo

Returns a new instance of OSInfo.



29
30
31
# File 'lib/comet/models/osinfo.rb', line 29

def initialize
  clear
end

Instance Attribute Details

#buildObject

Returns the value of attribute build.



24
25
26
# File 'lib/comet/models/osinfo.rb', line 24

def build
  @build
end

#distributionObject

Returns the value of attribute distribution.



21
22
23
# File 'lib/comet/models/osinfo.rb', line 21

def distribution
  @distribution
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



27
28
29
# File 'lib/comet/models/osinfo.rb', line 27

def unknown_json_fields
  @unknown_json_fields
end

#versionObject

Returns the value of attribute version.



18
19
20
# File 'lib/comet/models/osinfo.rb', line 18

def version
  @version
end

Instance Method Details

#clearObject



33
34
35
36
37
38
# File 'lib/comet/models/osinfo.rb', line 33

def clear
  @version = ''
  @distribution = ''
  @build = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/comet/models/osinfo.rb', line 48

def from_hash(obj)
  raise TypeError "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'version'
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

      @version = v
    when 'distribution'
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

      @distribution = v
    when 'build'
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

      @build = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String)

    The complete object in JSON format



41
42
43
44
45
# File 'lib/comet/models/osinfo.rb', line 41

def from_json(json_string)
  raise TypeError "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



90
91
92
# File 'lib/comet/models/osinfo.rb', line 90

def to_h
  to_hash
end

#to_hashHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/comet/models/osinfo.rb', line 72

def to_hash
  ret = {}
  unless @version.nil?
    ret['version'] = @version
  end
  unless @distribution.nil?
    ret['distribution'] = @distribution
  end
  unless @build.nil?
    ret['build'] = @build
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String)

    The complete object as a JSON string



95
96
97
# File 'lib/comet/models/osinfo.rb', line 95

def to_json(options = {})
  to_hash.to_json(options)
end