Class: PulpcoreClient::Artifact

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

Overview

Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the ‘pulp_href` field. The class provides a default for the “ref_name“ attribute in the ModelSerializers’s “Meta“ class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Artifact

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
127
128
 
# File 'lib/pulpcore_client/models/artifact.rb', line 84

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

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

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

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

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

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

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

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

Instance Attribute Details

#file ⇒ Object

The stored file.



19
20
21
 
# File 'lib/pulpcore_client/models/artifact.rb', line 19

def file
  @file
end

#md5 ⇒ Object

The MD5 checksum of the file if available.



25
26
27
 
# File 'lib/pulpcore_client/models/artifact.rb', line 25

def md5
  @md5
end

#sha1 ⇒ Object

The SHA-1 checksum of the file if available.



28
29
30
 
# File 'lib/pulpcore_client/models/artifact.rb', line 28

def sha1
  @sha1
end

#sha224 ⇒ Object

The SHA-224 checksum of the file if available.



31
32
33
 
# File 'lib/pulpcore_client/models/artifact.rb', line 31

def sha224
  @sha224
end

#sha256 ⇒ Object

The SHA-256 checksum of the file if available.



34
35
36
 
# File 'lib/pulpcore_client/models/artifact.rb', line 34

def sha256
  @sha256
end

#sha384 ⇒ Object

The SHA-384 checksum of the file if available.



37
38
39
 
# File 'lib/pulpcore_client/models/artifact.rb', line 37

def sha384
  @sha384
end

#sha512 ⇒ Object

The SHA-512 checksum of the file if available.



40
41
42
 
# File 'lib/pulpcore_client/models/artifact.rb', line 40

def sha512
  @sha512
end

#size ⇒ Object

The size of the file in bytes.



22
23
24
 
# File 'lib/pulpcore_client/models/artifact.rb', line 22

def size
  @size
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/pulpcore_client/models/artifact.rb', line 43

def self.attribute_map
  {
    :'file' => :'file',
    :'size' => :'size',
    :'md5' => :'md5',
    :'sha1' => :'sha1',
    :'sha224' => :'sha224',
    :'sha256' => :'sha256',
    :'sha384' => :'sha384',
    :'sha512' => :'sha512'
  }
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



268
269
270
 
# File 'lib/pulpcore_client/models/artifact.rb', line 268

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/pulpcore_client/models/artifact.rb', line 71

def self.openapi_nullable
  Set.new([
    :'md5',
    :'sha1',
    :'sha224',
    :'sha256',
    :'sha384',
    :'sha512'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'file' => :'File',
    :'size' => :'Integer',
    :'md5' => :'String',
    :'sha1' => :'String',
    :'sha224' => :'String',
    :'sha256' => :'String',
    :'sha384' => :'String',
    :'sha512' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/pulpcore_client/models/artifact.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file == o.file &&
      size == o.size &&
      md5 == o.md5 &&
      sha1 == o.sha1 &&
      sha224 == o.sha224 &&
      sha256 == o.sha256 &&
      sha384 == o.sha384 &&
      sha512 == o.sha512
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



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
331
 
# File 'lib/pulpcore_client/models/artifact.rb', line 296

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



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

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



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

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


255
256
257
 
# File 'lib/pulpcore_client/models/artifact.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/pulpcore_client/models/artifact.rb', line 261

def hash
  [file, size, md5, sha1, sha224, sha256, sha384, sha512].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



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/pulpcore_client/models/artifact.rb', line 132

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

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

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

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

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

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

  if !@sha512.nil? && @sha512.to_s.length < 1
    invalid_properties.push('invalid value for "sha512", the character length must be great than or equal to 1.')
  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



341
342
343
 
# File 'lib/pulpcore_client/models/artifact.rb', line 341

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



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

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



335
336
337
 
# File 'lib/pulpcore_client/models/artifact.rb', line 335

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



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/pulpcore_client/models/artifact.rb', line 167

def valid?
  return false if @file.nil?
  return false if !@md5.nil? && @md5.to_s.length < 1
  return false if !@sha1.nil? && @sha1.to_s.length < 1
  return false if !@sha224.nil? && @sha224.to_s.length < 1
  return false if !@sha256.nil? && @sha256.to_s.length < 1
  return false if !@sha384.nil? && @sha384.to_s.length < 1
  return false if !@sha512.nil? && @sha512.to_s.length < 1
  true
end