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.



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

def initialize
  clear
end

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



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

def active
  @active
end

#apply_device_filter ⇒ Object

Returns the value of attribute apply_device_filter.



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

def apply_device_filter
  @apply_device_filter
end

#device_filter ⇒ Object

Returns the value of attribute device_filter.



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

def device_filter
  @device_filter
end

#downgrade_newer ⇒ Object

Returns the value of attribute downgrade_newer.



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

def downgrade_newer
  @downgrade_newer
end

#force_upgrade_running ⇒ Object

Returns the value of attribute force_upgrade_running.



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

def force_upgrade_running
  @force_upgrade_running
end

#reinstall_current_ver ⇒ Object

Returns the value of attribute reinstall_current_ver.



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

def reinstall_current_ver
  @reinstall_current_ver
end

#start_time ⇒ Object

Returns the value of attribute start_time.



39
40
41
 
# File 'lib/comet/models/update_campaign_properties.rb', line 39

def start_time
  @start_time
end

#target_version ⇒ Object

Returns the value of attribute target_version.



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

def target_version
  @target_version
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#upgrade_older ⇒ Object

Returns the value of attribute upgrade_older.



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

def upgrade_older
  @upgrade_older
end

Instance Method Details

#clear ⇒ Object 



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

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) 


66
67
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
 
# File 'lib/comet/models/update_campaign_properties.rb', line 66

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) 


59
60
61
62
63
 
# File 'lib/comet/models/update_campaign_properties.rb', line 59

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



119
120
121
 
# File 'lib/comet/models/update_campaign_properties.rb', line 119

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



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

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



124
125
126
 
# File 'lib/comet/models/update_campaign_properties.rb', line 124

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