Class: Comet::ConstellationStatusAPIResponse

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConstellationStatusAPIResponse

Returns a new instance of ConstellationStatusAPIResponse.



32
33
34
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 32

def initialize
  clear
end

Instance Attribute Details

#deletion_enabledObject

Returns the value of attribute deletion_enabled.



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

def deletion_enabled
  @deletion_enabled
end

#statsObject

Returns the value of attribute stats.



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

def stats
  @stats
end

#target_namesObject

Returns the value of attribute target_names.



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

def target_names
  @target_names
end

#targetsObject

Returns the value of attribute targets.



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

def targets
  @targets
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



30
31
32
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 30

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



36
37
38
39
40
41
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 36

def clear
  @targets = []
  @target_names = []
  @stats = Comet::ConstellationStats.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 51

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 'DeletionEnabled'
      @deletion_enabled = v
    when 'Targets'
      if v.nil?
        @targets = []
      else
        @targets = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @targets[i1] = v1
        end
      end
    when 'TargetNames'
      if v.nil?
        @target_names = []
      else
        @target_names = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @target_names[i1] = v1
        end
      end
    when 'Stats'
      @stats = Comet::ConstellationStats.new
      @stats.from_hash(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



44
45
46
47
48
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 44

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



105
106
107
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 105

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



90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 90

def to_hash
  ret = {}
  ret['DeletionEnabled'] = @deletion_enabled
  ret['Targets'] = @targets
  unless @target_names.nil?
    ret['TargetNames'] = @target_names
  end
  ret['Stats'] = @stats
  @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



110
111
112
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 110

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