Class: SourcesApiClient::Authentication

Inherits:
Object
  • Object
show all
Defined in:
lib/sources-api-client/models/authentication.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Authentication

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/sources-api-client/models/authentication.rb', line 95

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#authtypeObject

Returns the value of attribute authtype


17
18
19
# File 'lib/sources-api-client/models/authentication.rb', line 17

def authtype
  @authtype
end

#availability_statusObject

Returns the value of attribute availability_status


19
20
21
# File 'lib/sources-api-client/models/authentication.rb', line 19

def availability_status
  @availability_status
end

#availability_status_errorObject

Returns the value of attribute availability_status_error


21
22
23
# File 'lib/sources-api-client/models/authentication.rb', line 21

def availability_status_error
  @availability_status_error
end

#extraObject

Returns the value of attribute extra


23
24
25
# File 'lib/sources-api-client/models/authentication.rb', line 23

def extra
  @extra
end

#idObject

ID of the resource


26
27
28
# File 'lib/sources-api-client/models/authentication.rb', line 26

def id
  @id
end

#last_available_atObject

Returns the value of attribute last_available_at


28
29
30
# File 'lib/sources-api-client/models/authentication.rb', line 28

def last_available_at
  @last_available_at
end

#last_checked_atObject

Returns the value of attribute last_checked_at


30
31
32
# File 'lib/sources-api-client/models/authentication.rb', line 30

def last_checked_at
  @last_checked_at
end

#nameObject

Returns the value of attribute name


32
33
34
# File 'lib/sources-api-client/models/authentication.rb', line 32

def name
  @name
end

#passwordObject

Returns the value of attribute password


34
35
36
# File 'lib/sources-api-client/models/authentication.rb', line 34

def password
  @password
end

#resource_idObject

ID of the resource


37
38
39
# File 'lib/sources-api-client/models/authentication.rb', line 37

def resource_id
  @resource_id
end

#resource_typeObject

Returns the value of attribute resource_type


39
40
41
# File 'lib/sources-api-client/models/authentication.rb', line 39

def resource_type
  @resource_type
end

#statusObject

Returns the value of attribute status


41
42
43
# File 'lib/sources-api-client/models/authentication.rb', line 41

def status
  @status
end

#status_detailsObject

Returns the value of attribute status_details


43
44
45
# File 'lib/sources-api-client/models/authentication.rb', line 43

def status_details
  @status_details
end

#usernameObject

Returns the value of attribute username


45
46
47
# File 'lib/sources-api-client/models/authentication.rb', line 45

def username
  @username
end

Class Method Details

.attribute_mapObject

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


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/sources-api-client/models/authentication.rb', line 48

def self.attribute_map
  {
    :'authtype' => :'authtype',
    :'availability_status' => :'availability_status',
    :'availability_status_error' => :'availability_status_error',
    :'extra' => :'extra',
    :'id' => :'id',
    :'last_available_at' => :'last_available_at',
    :'last_checked_at' => :'last_checked_at',
    :'name' => :'name',
    :'password' => :'password',
    :'resource_id' => :'resource_id',
    :'resource_type' => :'resource_type',
    :'status' => :'status',
    :'status_details' => :'status_details',
    :'username' => :'username'
  }
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


248
249
250
# File 'lib/sources-api-client/models/authentication.rb', line 248

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

.openapi_nullableObject

List of attributes with nullable: true


88
89
90
91
# File 'lib/sources-api-client/models/authentication.rb', line 88

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

.openapi_typesObject

Attribute type mapping.


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/sources-api-client/models/authentication.rb', line 68

def self.openapi_types
  {
    :'authtype' => :'String',
    :'availability_status' => :'String',
    :'availability_status_error' => :'String',
    :'extra' => :'AuthenticationExtra',
    :'id' => :'String',
    :'last_available_at' => :'DateTime',
    :'last_checked_at' => :'DateTime',
    :'name' => :'String',
    :'password' => :'String',
    :'resource_id' => :'String',
    :'resource_type' => :'String',
    :'status' => :'String',
    :'status_details' => :'String',
    :'username' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/sources-api-client/models/authentication.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authtype == o.authtype &&
      availability_status == o.availability_status &&
      availability_status_error == o.availability_status_error &&
      extra == o.extra &&
      id == o.id &&
      last_available_at == o.last_available_at &&
      last_checked_at == o.last_checked_at &&
      name == o.name &&
      password == o.password &&
      resource_id == o.resource_id &&
      resource_type == o.resource_type &&
      status == o.status &&
      status_details == o.status_details &&
      username == o.username
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


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
311
# File 'lib/sources-api-client/models/authentication.rb', line 276

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


345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'lib/sources-api-client/models/authentication.rb', line 345

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


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/sources-api-client/models/authentication.rb', line 255

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

235
236
237
# File 'lib/sources-api-client/models/authentication.rb', line 235

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


241
242
243
# File 'lib/sources-api-client/models/authentication.rb', line 241

def hash
  [authtype, availability_status, availability_status_error, extra, id, last_available_at, last_checked_at, name, password, resource_id, resource_type, status, status_details, username].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/sources-api-client/models/authentication.rb', line 167

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d+$/)
  if !@id.nil? && @id !~ pattern
    invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+$/)
  if !@resource_id.nil? && @resource_id !~ pattern
    invalid_properties.push("invalid value for \"resource_id\", must conform to the pattern #{pattern}.")
  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


321
322
323
# File 'lib/sources-api-client/models/authentication.rb', line 321

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


327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'lib/sources-api-client/models/authentication.rb', line 327

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


315
316
317
# File 'lib/sources-api-client/models/authentication.rb', line 315

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


184
185
186
187
188
# File 'lib/sources-api-client/models/authentication.rb', line 184

def valid?
  return false if !@id.nil? && @id !~ Regexp.new(/^\d+$/)
  return false if !@resource_id.nil? && @resource_id !~ Regexp.new(/^\d+$/)
  true
end