Class: Comet::UpdateCampaignStatus

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeUpdateCampaignStatus

Returns a new instance of UpdateCampaignStatus.



48
49
50
# File 'lib/comet/models/update_campaign_status.rb', line 48

def initialize
  clear
end

Instance Attribute Details

#activeObject

Returns the value of attribute active.



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

def active
  @active
end

#apply_device_filterObject

Returns the value of attribute apply_device_filter.



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

def apply_device_filter
  @apply_device_filter
end

#device_filterObject

Returns the value of attribute device_filter.



34
35
36
# File 'lib/comet/models/update_campaign_status.rb', line 34

def device_filter
  @device_filter
end

#devicesObject

Returns the value of attribute devices.



43
44
45
# File 'lib/comet/models/update_campaign_status.rb', line 43

def devices
  @devices
end

#downgrade_newerObject

Returns the value of attribute downgrade_newer.



25
26
27
# File 'lib/comet/models/update_campaign_status.rb', line 25

def downgrade_newer
  @downgrade_newer
end

#force_upgrade_runningObject

Returns the value of attribute force_upgrade_running.



28
29
30
# File 'lib/comet/models/update_campaign_status.rb', line 28

def force_upgrade_running
  @force_upgrade_running
end

#reinstall_current_verObject

Returns the value of attribute reinstall_current_ver.



22
23
24
# File 'lib/comet/models/update_campaign_status.rb', line 22

def reinstall_current_ver
  @reinstall_current_ver
end

#start_timeObject

Returns the value of attribute start_time.



37
38
39
# File 'lib/comet/models/update_campaign_status.rb', line 37

def start_time
  @start_time
end

#target_versionObject

Returns the value of attribute target_version.



40
41
42
# File 'lib/comet/models/update_campaign_status.rb', line 40

def target_version
  @target_version
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



46
47
48
# File 'lib/comet/models/update_campaign_status.rb', line 46

def unknown_json_fields
  @unknown_json_fields
end

#upgrade_olderObject

Returns the value of attribute upgrade_older.



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

def upgrade_older
  @upgrade_older
end

Instance Method Details

#clearObject



52
53
54
55
56
57
58
# File 'lib/comet/models/update_campaign_status.rb', line 52

def clear
  @device_filter = Comet::SearchClause.new
  @start_time = 0
  @target_version = ''
  @devices = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/comet/models/update_campaign_status.rb', line 68

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 'Active'
      @active = v
    when 'UpgradeOlder'
      @upgrade_older = v
    when 'ReinstallCurrentVer'
      @reinstall_current_ver = v
    when 'DowngradeNewer'
      @downgrade_newer = v
    when 'ForceUpgradeRunning'
      @force_upgrade_running = v
    when 'ApplyDeviceFilter'
      @apply_device_filter = v
    when 'DeviceFilter'
      @device_filter = Comet::SearchClause.new
      @device_filter.from_hash(v)
    when 'StartTime'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

      @target_version = v
    when 'Devices'
      if v.nil?
        @devices = []
      else
        @devices = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @devices[i1] = Comet::UpdateCampaignStatusDeviceEntry.new
          @devices[i1].from_hash(v1)
        end
      end
    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)


61
62
63
64
65
# File 'lib/comet/models/update_campaign_status.rb', line 61

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



132
133
134
# File 'lib/comet/models/update_campaign_status.rb', line 132

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/comet/models/update_campaign_status.rb', line 113

def to_hash
  ret = {}
  ret['Active'] = @active
  ret['UpgradeOlder'] = @upgrade_older
  ret['ReinstallCurrentVer'] = @reinstall_current_ver
  ret['DowngradeNewer'] = @downgrade_newer
  ret['ForceUpgradeRunning'] = @force_upgrade_running
  ret['ApplyDeviceFilter'] = @apply_device_filter
  ret['DeviceFilter'] = @device_filter
  ret['StartTime'] = @start_time
  ret['TargetVersion'] = @target_version
  ret['Devices'] = @devices
  @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



137
138
139
# File 'lib/comet/models/update_campaign_status.rb', line 137

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