Class: Falcon::DeviceapiGroupResponseV1

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/models/deviceapi_group_response_v1.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeviceapiGroupResponseV1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



104
105
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
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 104

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::DeviceapiGroupResponseV1` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Falcon::DeviceapiGroupResponseV1`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'assignment_rule')
    self.assignment_rule = attributes[:'assignment_rule']
  end

  if attributes.key?(:'cid')
    self.cid = attributes[:'cid']
  end

  if attributes.key?(:'created_by')
    self.created_by = attributes[:'created_by']
  end

  if attributes.key?(:'created_timestamp')
    self.created_timestamp = attributes[:'created_timestamp']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'group_type')
    self.group_type = attributes[:'group_type']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'meta')
    self.meta = attributes[:'meta']
  end

  if attributes.key?(:'modified_by')
    self.modified_by = attributes[:'modified_by']
  end

  if attributes.key?(:'modified_timestamp')
    self.modified_timestamp = attributes[:'modified_timestamp']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end
end

Instance Attribute Details

#assignment_ruleObject

Returns the value of attribute assignment_rule.



35
36
37
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 35

def assignment_rule
  @assignment_rule
end

#cidObject

Returns the value of attribute cid.



37
38
39
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 37

def cid
  @cid
end

#created_byObject

Returns the value of attribute created_by.



39
40
41
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 39

def created_by
  @created_by
end

#created_timestampObject

Returns the value of attribute created_timestamp.



41
42
43
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 41

def created_timestamp
  @created_timestamp
end

#descriptionObject

Returns the value of attribute description.



43
44
45
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 43

def description
  @description
end

#group_typeObject

Returns the value of attribute group_type.



45
46
47
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 45

def group_type
  @group_type
end

#idObject

Returns the value of attribute id.



47
48
49
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 47

def id
  @id
end

#metaObject

Returns the value of attribute meta.



49
50
51
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 49

def meta
  @meta
end

#modified_byObject

Returns the value of attribute modified_by.



51
52
53
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 51

def modified_by
  @modified_by
end

#modified_timestampObject

Returns the value of attribute modified_timestamp.



53
54
55
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 53

def modified_timestamp
  @modified_timestamp
end

#nameObject

Returns the value of attribute name.



55
56
57
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 55

def name
  @name
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



75
76
77
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 58

def self.attribute_map
  {
    :'assignment_rule' => :'assignment_rule',
    :'cid' => :'cid',
    :'created_by' => :'created_by',
    :'created_timestamp' => :'created_timestamp',
    :'description' => :'description',
    :'group_type' => :'group_type',
    :'id' => :'id',
    :'meta' => :'meta',
    :'modified_by' => :'modified_by',
    :'modified_timestamp' => :'modified_timestamp',
    :'name' => :'name'
  }
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
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 253

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



97
98
99
100
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 97

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 80

def self.openapi_types
  {
    :'assignment_rule' => :'String',
    :'cid' => :'String',
    :'created_by' => :'String',
    :'created_timestamp' => :'Time',
    :'description' => :'String',
    :'group_type' => :'String',
    :'id' => :'String',
    :'meta' => :'DeviceapiGroupMeta',
    :'modified_by' => :'String',
    :'modified_timestamp' => :'Time',
    :'name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assignment_rule == o.assignment_rule &&
      cid == o.cid &&
      created_by == o.created_by &&
      created_timestamp == o.created_timestamp &&
      description == o.description &&
      group_type == o.group_type &&
      id == o.id &&
      meta == o.meta &&
      modified_by == o.modified_by &&
      modified_timestamp == o.modified_timestamp &&
      name == o.name
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



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
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 284

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Falcon.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 355

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 260

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


240
241
242
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 240

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



246
247
248
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 246

def hash
  [assignment_rule, cid, created_by, created_timestamp, description, group_type, id, meta, modified_by, modified_timestamp, name].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 164

def list_invalid_properties
  invalid_properties = Array.new
  if @cid.nil?
    invalid_properties.push('invalid value for "cid", cid cannot be nil.')
  end

  if @created_by.nil?
    invalid_properties.push('invalid value for "created_by", created_by cannot be nil.')
  end

  if @created_timestamp.nil?
    invalid_properties.push('invalid value for "created_timestamp", created_timestamp cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @group_type.nil?
    invalid_properties.push('invalid value for "group_type", group_type cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @modified_by.nil?
    invalid_properties.push('invalid value for "modified_by", modified_by cannot be nil.')
  end

  if @modified_timestamp.nil?
    invalid_properties.push('invalid value for "modified_timestamp", modified_timestamp cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



331
332
333
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 331

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 337

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



325
326
327
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 325

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



207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/crimson-falcon/models/deviceapi_group_response_v1.rb', line 207

def valid?
  return false if @cid.nil?
  return false if @created_by.nil?
  return false if @created_timestamp.nil?
  return false if @description.nil?
  return false if @group_type.nil?
  return false if @id.nil?
  return false if @modified_by.nil?
  return false if @modified_timestamp.nil?
  return false if @name.nil?
  true
end