Class: MParticle::DeviceCurrentState

Inherits:
Object
  • Object
show all
Defined in:
lib/mparticle/models/device_current_state.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeviceCurrentState

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/mparticle/models/device_current_state.rb', line 106

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'time_since_start_ms')
    self.time_since_start_ms = attributes[:'time_since_start_ms']
  end

  if attributes.has_key?(:'battery_level')
    self.battery_level = attributes[:'battery_level']
  end

  if attributes.has_key?(:'data_connection_type')
    self.data_connection_type = attributes[:'data_connection_type']
  end

  if attributes.has_key?(:'data_connection_type_detail')
    self.data_connection_type_detail = attributes[:'data_connection_type_detail']
  end

  if attributes.has_key?(:'gps_state')
    self.gps_state = attributes[:'gps_state']
  end

  if attributes.has_key?(:'total_system_memory_usage_bytes')
    self.total_system_memory_usage_bytes = attributes[:'total_system_memory_usage_bytes']
  end

  if attributes.has_key?(:'disk_space_free_bytes')
    self.disk_space_free_bytes = attributes[:'disk_space_free_bytes']
  end

  if attributes.has_key?(:'cpu')
    self.cpu = attributes[:'cpu']
  end

  if attributes.has_key?(:'system_memory_available_bytes')
    self.system_memory_available_bytes = attributes[:'system_memory_available_bytes']
  end

  if attributes.has_key?(:'system_memory_low')
    self.system_memory_low = attributes[:'system_memory_low']
  end

  if attributes.has_key?(:'system_memory_threshold_bytes')
    self.system_memory_threshold_bytes = attributes[:'system_memory_threshold_bytes']
  end

  if attributes.has_key?(:'application_memory_available_bytes')
    self.application_memory_available_bytes = attributes[:'application_memory_available_bytes']
  end

  if attributes.has_key?(:'application_memory_max_bytes')
    self.application_memory_max_bytes = attributes[:'application_memory_max_bytes']
  end

  if attributes.has_key?(:'application_memory_total_bytes')
    self.application_memory_total_bytes = attributes[:'application_memory_total_bytes']
  end

  if attributes.has_key?(:'device_orientation')
    self.device_orientation = attributes[:'device_orientation']
  end

  if attributes.has_key?(:'status_bar_orientation')
    self.status_bar_orientation = attributes[:'status_bar_orientation']
  end

end

Instance Attribute Details

#application_memory_available_bytes ⇒ Object

Returns the value of attribute application_memory_available_bytes.



28
29
30
 
# File 'lib/mparticle/models/device_current_state.rb', line 28

def application_memory_available_bytes
  @application_memory_available_bytes
end

#application_memory_max_bytes ⇒ Object

Returns the value of attribute application_memory_max_bytes.



30
31
32
 
# File 'lib/mparticle/models/device_current_state.rb', line 30

def application_memory_max_bytes
  @application_memory_max_bytes
end

#application_memory_total_bytes ⇒ Object

Returns the value of attribute application_memory_total_bytes.



32
33
34
 
# File 'lib/mparticle/models/device_current_state.rb', line 32

def application_memory_total_bytes
  @application_memory_total_bytes
end

#battery_level ⇒ Object

Returns the value of attribute battery_level.



8
9
10
 
# File 'lib/mparticle/models/device_current_state.rb', line 8

def battery_level
  @battery_level
end

#cpu ⇒ Object

Returns the value of attribute cpu.



20
21
22
 
# File 'lib/mparticle/models/device_current_state.rb', line 20

def cpu
  @cpu
end

#data_connection_type ⇒ Object

Returns the value of attribute data_connection_type.



10
11
12
 
# File 'lib/mparticle/models/device_current_state.rb', line 10

def data_connection_type
  @data_connection_type
end

#data_connection_type_detail ⇒ Object

Returns the value of attribute data_connection_type_detail.



12
13
14
 
# File 'lib/mparticle/models/device_current_state.rb', line 12

def data_connection_type_detail
  @data_connection_type_detail
end

#device_orientation ⇒ Object

Returns the value of attribute device_orientation.



34
35
36
 
# File 'lib/mparticle/models/device_current_state.rb', line 34

def device_orientation
  @device_orientation
end

#disk_space_free_bytes ⇒ Object

Returns the value of attribute disk_space_free_bytes.



18
19
20
 
# File 'lib/mparticle/models/device_current_state.rb', line 18

def disk_space_free_bytes
  @disk_space_free_bytes
end

#gps_state ⇒ Object

Returns the value of attribute gps_state.



14
15
16
 
# File 'lib/mparticle/models/device_current_state.rb', line 14

def gps_state
  @gps_state
end

#status_bar_orientation ⇒ Object

Returns the value of attribute status_bar_orientation.



36
37
38
 
# File 'lib/mparticle/models/device_current_state.rb', line 36

def status_bar_orientation
  @status_bar_orientation
end

#system_memory_available_bytes ⇒ Object

Returns the value of attribute system_memory_available_bytes.



22
23
24
 
# File 'lib/mparticle/models/device_current_state.rb', line 22

def system_memory_available_bytes
  @system_memory_available_bytes
end

#system_memory_low ⇒ Object

Returns the value of attribute system_memory_low.



24
25
26
 
# File 'lib/mparticle/models/device_current_state.rb', line 24

def system_memory_low
  @system_memory_low
end

#system_memory_threshold_bytes ⇒ Object

Returns the value of attribute system_memory_threshold_bytes.



26
27
28
 
# File 'lib/mparticle/models/device_current_state.rb', line 26

def system_memory_threshold_bytes
  @system_memory_threshold_bytes
end

#time_since_start_ms ⇒ Object

Returns the value of attribute time_since_start_ms.



6
7
8
 
# File 'lib/mparticle/models/device_current_state.rb', line 6

def time_since_start_ms
  @time_since_start_ms
end

#total_system_memory_usage_bytes ⇒ Object

Returns the value of attribute total_system_memory_usage_bytes.



16
17
18
 
# File 'lib/mparticle/models/device_current_state.rb', line 16

def total_system_memory_usage_bytes
  @total_system_memory_usage_bytes
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/mparticle/models/device_current_state.rb', line 61

def self.attribute_map
  {
    :'time_since_start_ms' => :'time_since_start_ms',
    :'battery_level' => :'battery_level',
    :'data_connection_type' => :'data_connection_type',
    :'data_connection_type_detail' => :'data_connection_type_detail',
    :'gps_state' => :'gps_state',
    :'total_system_memory_usage_bytes' => :'total_system_memory_usage_bytes',
    :'disk_space_free_bytes' => :'disk_space_free_bytes',
    :'cpu' => :'cpu',
    :'system_memory_available_bytes' => :'system_memory_available_bytes',
    :'system_memory_low' => :'system_memory_low',
    :'system_memory_threshold_bytes' => :'system_memory_threshold_bytes',
    :'application_memory_available_bytes' => :'application_memory_available_bytes',
    :'application_memory_max_bytes' => :'application_memory_max_bytes',
    :'application_memory_total_bytes' => :'application_memory_total_bytes',
    :'device_orientation' => :'device_orientation',
    :'status_bar_orientation' => :'status_bar_orientation'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/mparticle/models/device_current_state.rb', line 83

def self.swagger_types
  {
    :'time_since_start_ms' => :'Integer',
    :'battery_level' => :'Float',
    :'data_connection_type' => :'String',
    :'data_connection_type_detail' => :'String',
    :'gps_state' => :'BOOLEAN',
    :'total_system_memory_usage_bytes' => :'Integer',
    :'disk_space_free_bytes' => :'Integer',
    :'cpu' => :'String',
    :'system_memory_available_bytes' => :'Float',
    :'system_memory_low' => :'BOOLEAN',
    :'system_memory_threshold_bytes' => :'Float',
    :'application_memory_available_bytes' => :'Float',
    :'application_memory_max_bytes' => :'Float',
    :'application_memory_total_bytes' => :'Float',
    :'device_orientation' => :'String',
    :'status_bar_orientation' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/mparticle/models/device_current_state.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      time_since_start_ms == o.time_since_start_ms &&
      battery_level == o.battery_level &&
      data_connection_type == o.data_connection_type &&
      data_connection_type_detail == o.data_connection_type_detail &&
      gps_state == o.gps_state &&
      total_system_memory_usage_bytes == o.total_system_memory_usage_bytes &&
      disk_space_free_bytes == o.disk_space_free_bytes &&
      cpu == o.cpu &&
      system_memory_available_bytes == o.system_memory_available_bytes &&
      system_memory_low == o.system_memory_low &&
      system_memory_threshold_bytes == o.system_memory_threshold_bytes &&
      application_memory_available_bytes == o.application_memory_available_bytes &&
      application_memory_max_bytes == o.application_memory_max_bytes &&
      application_memory_total_bytes == o.application_memory_total_bytes &&
      device_orientation == o.device_orientation &&
      status_bar_orientation == o.status_bar_orientation
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/mparticle/models/device_current_state.rb', line 274

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = MParticle.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/mparticle/models/device_current_state.rb', line 340

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/mparticle/models/device_current_state.rb', line 253

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


240
241
242
 
# File 'lib/mparticle/models/device_current_state.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



246
247
248
 
# File 'lib/mparticle/models/device_current_state.rb', line 246

def hash
  [time_since_start_ms, battery_level, data_connection_type, data_connection_type_detail, gps_state, total_system_memory_usage_bytes, disk_space_free_bytes, cpu, system_memory_available_bytes, system_memory_low, system_memory_threshold_bytes, application_memory_available_bytes, application_memory_max_bytes, application_memory_total_bytes, device_orientation, status_bar_orientation].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



180
181
182
183
 
# File 'lib/mparticle/models/device_current_state.rb', line 180

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



320
321
322
 
# File 'lib/mparticle/models/device_current_state.rb', line 320

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



326
327
328
329
330
331
332
333
334
 
# File 'lib/mparticle/models/device_current_state.rb', line 326

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



314
315
316
 
# File 'lib/mparticle/models/device_current_state.rb', line 314

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



187
188
189
190
191
192
193
 
# File 'lib/mparticle/models/device_current_state.rb', line 187

def valid?
  device_orientation_validator = EnumAttributeValidator.new('String', ["unknown", "portrait", "portrait_upside_down", "landscape", "LandscapeLeft", "LandscapeRight", "FaceUp", "FaceDown", "Square"])
  return false unless device_orientation_validator.valid?(@device_orientation)
  status_bar_orientation_validator = EnumAttributeValidator.new('String', ["unknown", "portrait", "portrait_upside_down", "landscape", "LandscapeLeft", "LandscapeRight", "FaceUp", "FaceDown", "Square"])
  return false unless status_bar_orientation_validator.valid?(@status_bar_orientation)
  return true
end