Class: SourcesApiClient::Source

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Source

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
144
145
146
147
# File 'lib/sources-api-client/models/source.rb', line 87

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

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

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

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

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

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

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

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

Instance Attribute Details

#availability_statusObject

Returns the value of attribute availability_status


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

def availability_status
  @availability_status
end

#created_atObject

Returns the value of attribute created_at


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

def created_at
  @created_at
end

#idObject

ID of the resource


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

def id
  @id
end

#importedObject

Returns the value of attribute imported


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

def imported
  @imported
end

#last_available_atObject

Returns the value of attribute last_available_at


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

def last_available_at
  @last_available_at
end

#last_checked_atObject

Returns the value of attribute last_checked_at


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

def last_checked_at
  @last_checked_at
end

#nameObject

Returns the value of attribute name


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

def name
  @name
end

#source_refObject

Returns the value of attribute source_ref


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

def source_ref
  @source_ref
end

#source_type_idObject

ID of the resource


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

def source_type_id
  @source_type_id
end

#uidObject

Returns the value of attribute uid


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

def uid
  @uid
end

#updated_atObject

Returns the value of attribute updated_at


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

def updated_at
  @updated_at
end

#versionObject

Returns the value of attribute version


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

def version
  @version
end

Class Method Details

.attribute_mapObject

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


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/sources-api-client/models/source.rb', line 44

def self.attribute_map
  {
    :'availability_status' => :'availability_status',
    :'created_at' => :'created_at',
    :'id' => :'id',
    :'imported' => :'imported',
    :'last_available_at' => :'last_available_at',
    :'last_checked_at' => :'last_checked_at',
    :'name' => :'name',
    :'source_ref' => :'source_ref',
    :'source_type_id' => :'source_type_id',
    :'uid' => :'uid',
    :'updated_at' => :'updated_at',
    :'version' => :'version'
  }
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


230
231
232
# File 'lib/sources-api-client/models/source.rb', line 230

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

.openapi_nullableObject

List of attributes with nullable: true


80
81
82
83
# File 'lib/sources-api-client/models/source.rb', line 80

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

.openapi_typesObject

Attribute type mapping.


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/sources-api-client/models/source.rb', line 62

def self.openapi_types
  {
    :'availability_status' => :'String',
    :'created_at' => :'DateTime',
    :'id' => :'String',
    :'imported' => :'String',
    :'last_available_at' => :'DateTime',
    :'last_checked_at' => :'DateTime',
    :'name' => :'String',
    :'source_ref' => :'String',
    :'source_type_id' => :'String',
    :'uid' => :'String',
    :'updated_at' => :'DateTime',
    :'version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/sources-api-client/models/source.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      availability_status == o.availability_status &&
      created_at == o.created_at &&
      id == o.id &&
      imported == o.imported &&
      last_available_at == o.last_available_at &&
      last_checked_at == o.last_checked_at &&
      name == o.name &&
      source_ref == o.source_ref &&
      source_type_id == o.source_type_id &&
      uid == o.uid &&
      updated_at == o.updated_at &&
      version == o.version
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


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/sources-api-client/models/source.rb', line 258

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


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

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


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/sources-api-client/models/source.rb', line 237

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

217
218
219
# File 'lib/sources-api-client/models/source.rb', line 217

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


223
224
225
# File 'lib/sources-api-client/models/source.rb', line 223

def hash
  [availability_status, created_at, id, imported, last_available_at, last_checked_at, name, source_ref, source_type_id, uid, updated_at, version].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/sources-api-client/models/source.rb', line 151

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 !@source_type_id.nil? && @source_type_id !~ pattern
    invalid_properties.push("invalid value for \"source_type_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


303
304
305
# File 'lib/sources-api-client/models/source.rb', line 303

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


309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/sources-api-client/models/source.rb', line 309

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


297
298
299
# File 'lib/sources-api-client/models/source.rb', line 297

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


168
169
170
171
172
# File 'lib/sources-api-client/models/source.rb', line 168

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