Class: Comet::ScheduleConfig

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ScheduleConfig 



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

def initialize
  clear
end

Instance Attribute Details

#frequency_type ⇒ Object

Returns the value of attribute frequency_type.



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

def frequency_type
  @frequency_type
end

#offset ⇒ Object

Returns the value of attribute offset.



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

def offset
  @offset
end

#seconds_past ⇒ Object

Returns the value of attribute seconds_past.



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

def seconds_past
  @seconds_past
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @frequency_type = 0
  @seconds_past = 0
  @offset = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Raises:

  • (TypeError) 


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/schedule_config.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 'FrequencyType'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @frequency_type = v
    when 'SecondsPast'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @seconds_past = v
    when 'Offset'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

#from_json(json_string) ⇒ Object

Raises:

  • (TypeError) 


41
42
43
44
45
 
# File 'lib/comet/models/schedule_config.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_h ⇒ Hash 



86
87
88
 
# File 'lib/comet/models/schedule_config.rb', line 86

def to_h
  to_hash
end

#to_hash ⇒ Hash 



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/comet/models/schedule_config.rb', line 72

def to_hash
  ret = {}
  ret['FrequencyType'] = @frequency_type
  ret['SecondsPast'] = @seconds_past
  unless @offset.nil?
    ret['Offset'] = @offset
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String 



91
92
93
 
# File 'lib/comet/models/schedule_config.rb', line 91

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