Class: PulpcoreClient::UserResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/models/user_response.rb

Overview

Serializer for User.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
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
 
# File 'lib/pulpcore_client/models/user_response.rb', line 85

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PulpcoreClient::UserResponse` 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 `PulpcoreClient::UserResponse`. 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?(:'pulp_href')
    self.pulp_href = attributes[:'pulp_href']
  end

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

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

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

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

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

  if attributes.key?(:'is_staff')
    self.is_staff = attributes[:'is_staff']
  else
    self.is_staff = false
  end

  if attributes.key?(:'is_active')
    self.is_active = attributes[:'is_active']
  else
    self.is_active = true
  end

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

  if attributes.key?(:'groups')
    if (value = attributes[:'groups']).is_a?(Array)
      self.groups = value
    end
  end
end

Instance Attribute Details

#date_joined ⇒ Object

Date joined



41
42
43
 
# File 'lib/pulpcore_client/models/user_response.rb', line 41

def date_joined
  @date_joined
end

#email ⇒ Object

Email address



32
33
34
 
# File 'lib/pulpcore_client/models/user_response.rb', line 32

def email
  @email
end

#first_name ⇒ Object

First name



26
27
28
 
# File 'lib/pulpcore_client/models/user_response.rb', line 26

def first_name
  @first_name
end

#groups ⇒ Object

Returns the value of attribute groups.



43
44
45
 
# File 'lib/pulpcore_client/models/user_response.rb', line 43

def groups
  @groups
end

#id ⇒ Object

Returns the value of attribute id.



20
21
22
 
# File 'lib/pulpcore_client/models/user_response.rb', line 20

def id
  @id
end

#is_active ⇒ Object

Designates whether this user should be treated as active.



38
39
40
 
# File 'lib/pulpcore_client/models/user_response.rb', line 38

def is_active
  @is_active
end

#is_staff ⇒ Object

Designates whether the user can log into this admin site.



35
36
37
 
# File 'lib/pulpcore_client/models/user_response.rb', line 35

def is_staff
  @is_staff
end

#last_name ⇒ Object

Last name



29
30
31
 
# File 'lib/pulpcore_client/models/user_response.rb', line 29

def last_name
  @last_name
end

#pulp_href ⇒ Object

Returns the value of attribute pulp_href.



18
19
20
 
# File 'lib/pulpcore_client/models/user_response.rb', line 18

def pulp_href
  @pulp_href
end

#username ⇒ Object

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.



23
24
25
 
# File 'lib/pulpcore_client/models/user_response.rb', line 23

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/pulpcore_client/models/user_response.rb', line 46

def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'id' => :'id',
    :'username' => :'username',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'email' => :'email',
    :'is_staff' => :'is_staff',
    :'is_active' => :'is_active',
    :'date_joined' => :'date_joined',
    :'groups' => :'groups'
  }
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



267
268
269
 
# File 'lib/pulpcore_client/models/user_response.rb', line 267

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
 
# File 'lib/pulpcore_client/models/user_response.rb', line 78

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/pulpcore_client/models/user_response.rb', line 62

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'id' => :'Integer',
    :'username' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'is_staff' => :'Boolean',
    :'is_active' => :'Boolean',
    :'date_joined' => :'DateTime',
    :'groups' => :'Array<UserGroupResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/pulpcore_client/models/user_response.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      id == o.id &&
      username == o.username &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      email == o.email &&
      is_staff == o.is_staff &&
      is_active == o.is_active &&
      date_joined == o.date_joined &&
      groups == o.groups
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



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
322
323
324
325
326
327
328
329
330
 
# File 'lib/pulpcore_client/models/user_response.rb', line 295

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
    PulpcoreClient.const_get(type).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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/pulpcore_client/models/user_response.rb', line 364

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/pulpcore_client/models/user_response.rb', line 274

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # 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


254
255
256
 
# File 'lib/pulpcore_client/models/user_response.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/pulpcore_client/models/user_response.rb', line 260

def hash
  [pulp_href, id, username, first_name, last_name, email, is_staff, is_active, date_joined, groups].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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
177
178
 
# File 'lib/pulpcore_client/models/user_response.rb', line 147

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

  if @username.to_s.length > 150
    invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 150.')
  end

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

  if @first_name.to_s.length > 150
    invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 150.')
  end

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

  if @last_name.to_s.length > 150
    invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 150.')
  end

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

  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



340
341
342
 
# File 'lib/pulpcore_client/models/user_response.rb', line 340

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/pulpcore_client/models/user_response.rb', line 346

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



334
335
336
 
# File 'lib/pulpcore_client/models/user_response.rb', line 334

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



182
183
184
185
186
187
188
189
190
191
 
# File 'lib/pulpcore_client/models/user_response.rb', line 182

def valid?
  return false if @username.nil?
  return false if @username.to_s.length > 150
  return false if @first_name.nil?
  return false if @first_name.to_s.length > 150
  return false if @last_name.nil?
  return false if @last_name.to_s.length > 150
  return false if @email.nil?
  true
end