Class: Comet::UpdateCampaignProperties

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ UpdateCampaignProperties

Returns a new instance of UpdateCampaignProperties.



49
50
51
 
# File 'lib/comet/models/update_campaign_properties.rb', line 49

def initialize
  clear
end

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



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

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.



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

def apply_device_filter
  @apply_device_filter
end

#device_filter ⇒ Object

Returns the value of attribute device_filter.



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

def device_filter
  @device_filter
end

#downgrade_newer ⇒ Object

Returns the value of attribute downgrade_newer.



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

def downgrade_newer
  @downgrade_newer
end

#force_upgrade_running ⇒ Object

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



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

def force_upgrade_running
  @force_upgrade_running
end

#reinstall_current_ver ⇒ Object

Returns the value of attribute reinstall_current_ver.



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

def reinstall_current_ver
  @reinstall_current_ver
end

#start_time ⇒ Object

Unix timestamp, in seconds



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

def start_time
  @start_time
end

#target_version ⇒ Object

Returns the value of attribute target_version.



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

def target_version
  @target_version
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



47
48
49
 
# File 'lib/comet/models/update_campaign_properties.rb', line 47

def unknown_json_fields
  @unknown_json_fields
end

#upgrade_older ⇒ Object

Returns the value of attribute upgrade_older.



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

def upgrade_older
  @upgrade_older
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @device_filter = Comet::SearchClause.new
  @start_time = 0
  @target_version = ''
  @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
 
# File 'lib/comet/models/update_campaign_properties.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
    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_properties.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_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



121
122
123
 
# File 'lib/comet/models/update_campaign_properties.rb', line 121

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/comet/models/update_campaign_properties.rb', line 103

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



126
127
128
 
# File 'lib/comet/models/update_campaign_properties.rb', line 126

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