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

#initialize ⇒ ConstellationStatusAPIResponse

Returns a new instance of ConstellationStatusAPIResponse.



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

def initialize
  clear
end

Instance Attribute Details

#deletion_enabled ⇒ Object

Returns the value of attribute deletion_enabled.



16
17
18
 
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 16

def deletion_enabled
  @deletion_enabled
end

#stats ⇒ Object

Returns the value of attribute stats.



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

def stats
  @stats
end

#target_names ⇒ Object

This field is available in Comet 18.6.2 and later.



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

def target_names
  @target_names
end

#targets ⇒ Object

Returns the value of attribute targets.



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

def targets
  @targets
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

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

Raises:

  • (TypeError) 


50
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
 
# File 'lib/comet/models/constellation_status_apiresponse.rb', line 50

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

Raises:

  • (TypeError) 


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

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

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



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

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



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

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



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

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