Class: Comet::UpdateCampaignOptions

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

Overview

target version criteria (UpgradeOlder/ReinstallCurrentVer/DowngradeNewer) and the target device criteria (ApplyDeviceFilter/DeviceFilter) must be met in order for the remote upgrade to be applied.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ UpdateCampaignOptions

Returns a new instance of UpdateCampaignOptions.



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

def initialize
  clear
end

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



20
21
22
 
# File 'lib/comet/models/update_campaign_options.rb', line 20

def active
  @active
end

#apply_device_filter ⇒ Object

If true, then the UserFilter will be used to restrict which accounts and devices will be eligible for the software update. If false, all users and devices will be eligible for the software update.



38
39
40
 
# File 'lib/comet/models/update_campaign_options.rb', line 38

def apply_device_filter
  @apply_device_filter
end

#device_filter ⇒ Object

Returns the value of attribute device_filter.



41
42
43
 
# File 'lib/comet/models/update_campaign_options.rb', line 41

def device_filter
  @device_filter
end

#downgrade_newer ⇒ Object

Returns the value of attribute downgrade_newer.



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

def downgrade_newer
  @downgrade_newer
end

#force_upgrade_running ⇒ Object

Choose whether this bulk upgrade campaign is allowed to interrupt a running backup job.



33
34
35
 
# File 'lib/comet/models/update_campaign_options.rb', line 33

def force_upgrade_running
  @force_upgrade_running
end

#reinstall_current_ver ⇒ Object

Returns the value of attribute reinstall_current_ver.



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

def reinstall_current_ver
  @reinstall_current_ver
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



44
45
46
 
# File 'lib/comet/models/update_campaign_options.rb', line 44

def unknown_json_fields
  @unknown_json_fields
end

#upgrade_older ⇒ Object

Returns the value of attribute upgrade_older.



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

def upgrade_older
  @upgrade_older
end

Instance Method Details

#clear ⇒ Object 



50
51
52
53
 
# File 'lib/comet/models/update_campaign_options.rb', line 50

def clear
  @device_filter = Comet::SearchClause.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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/update_campaign_options.rb', line 63

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)
    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) 


56
57
58
59
60
 
# File 'lib/comet/models/update_campaign_options.rb', line 56

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



106
107
108
 
# File 'lib/comet/models/update_campaign_options.rb', line 106

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



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

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
  @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



111
112
113
 
# File 'lib/comet/models/update_campaign_options.rb', line 111

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