Class: PulpcoreClient::User

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

Overview

Serializer for User.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash


80
81
82
83
84
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
 
# File 'lib/pulpcore_client/models/user.rb', line 80

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

  if attributes.key?(:'password')
    self.password = attributes[:'password']
  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
end

Instance Attribute Details

#email ⇒ Object

Email address


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

def email
  @email
end

#first_name ⇒ Object

First name


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

def first_name
  @first_name
end

#is_active ⇒ Object

Designates whether this user should be treated as active.


38
39
40
 
# File 'lib/pulpcore_client/models/user.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.rb', line 35

def is_staff
  @is_staff
end

#last_name ⇒ Object

Last name


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

def last_name
  @last_name
end

#password ⇒ Object

Users password. Set to “null“ to disable password authentication.


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

def password
  @password
end

#username ⇒ Object

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


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

def username
  @username
end

Class Method Details

._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


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
311
312
313
314
315
316
317
318
319
 
# File 'lib/pulpcore_client/models/user.rb', line 282

def self._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 = PulpcoreClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about


54
55
56
 
# File 'lib/pulpcore_client/models/user.rb', line 54

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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


41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/pulpcore_client/models/user.rb', line 41

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


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/pulpcore_client/models/user.rb', line 258

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true


72
73
74
75
76
 
# File 'lib/pulpcore_client/models/user.rb', line 72

def self.openapi_nullable
  Set.new([
    :'password',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.


59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/pulpcore_client/models/user.rb', line 59

def self.openapi_types
  {
    :'username' => :'String',
    :'password' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'is_staff' => :'Boolean',
    :'is_active' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared


231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/pulpcore_client/models/user.rb', line 231

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


353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/pulpcore_client/models/user.rb', line 353

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

245
246
247
 
# File 'lib/pulpcore_client/models/user.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code


251
252
253
 
# File 'lib/pulpcore_client/models/user.rb', line 251

def hash
  [username, password, first_name, last_name, email, is_staff, is_active].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


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
 
# File 'lib/pulpcore_client/models/user.rb', line 130

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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 @username.to_s.length < 1
    invalid_properties.push('invalid value for "username", the character length must be great than or equal to 1.')
  end

  if !@password.nil? && @password.to_s.length < 1
    invalid_properties.push('invalid value for "password", the character length must be great than or equal to 1.')
  end

  if !@first_name.nil? && @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? && @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

  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


329
330
331
 
# File 'lib/pulpcore_client/models/user.rb', line 329

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


335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/pulpcore_client/models/user.rb', line 335

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


323
324
325
 
# File 'lib/pulpcore_client/models/user.rb', line 323

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


162
163
164
165
166
167
168
169
170
171
 
# File 'lib/pulpcore_client/models/user.rb', line 162

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @username.nil?
  return false if @username.to_s.length > 150
  return false if @username.to_s.length < 1
  return false if !@password.nil? && @password.to_s.length < 1
  return false if !@first_name.nil? && @first_name.to_s.length > 150
  return false if !@last_name.nil? && @last_name.to_s.length > 150
  true
end