Class: PulpcoreClient::ArtifactResponse

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

Overview

Base serializer for use with :class:`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 = {}) ⇒ ArtifactResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

  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

#fileObject

The stored file.


24
25
26
# File 'lib/pulpcore_client/models/artifact_response.rb', line 24

def file
  @file
end

#md5Object

The MD5 checksum of the file if available.


30
31
32
# File 'lib/pulpcore_client/models/artifact_response.rb', line 30

def md5
  @md5
end

#pulp_createdObject

Timestamp of creation.


21
22
23
# File 'lib/pulpcore_client/models/artifact_response.rb', line 21

def pulp_created
  @pulp_created
end

#pulp_hrefObject

Returns the value of attribute pulp_href


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

def pulp_href
  @pulp_href
end

#sha1Object

The SHA-1 checksum of the file if available.


33
34
35
# File 'lib/pulpcore_client/models/artifact_response.rb', line 33

def sha1
  @sha1
end

#sha224Object

The SHA-224 checksum of the file if available.


36
37
38
# File 'lib/pulpcore_client/models/artifact_response.rb', line 36

def sha224
  @sha224
end

#sha256Object

The SHA-256 checksum of the file if available.


39
40
41
# File 'lib/pulpcore_client/models/artifact_response.rb', line 39

def sha256
  @sha256
end

#sha384Object

The SHA-384 checksum of the file if available.


42
43
44
# File 'lib/pulpcore_client/models/artifact_response.rb', line 42

def sha384
  @sha384
end

#sha512Object

The SHA-512 checksum of the file if available.


45
46
47
# File 'lib/pulpcore_client/models/artifact_response.rb', line 45

def sha512
  @sha512
end

#sizeObject

The size of the file in bytes.


27
28
29
# File 'lib/pulpcore_client/models/artifact_response.rb', line 27

def size
  @size
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
# File 'lib/pulpcore_client/models/artifact_response.rb', line 48

def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'pulp_created' => :'pulp_created',
    :'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


197
198
199
# File 'lib/pulpcore_client/models/artifact_response.rb', line 197

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

.openapi_nullableObject

List of attributes with nullable: true


80
81
82
83
84
85
86
87
88
89
# File 'lib/pulpcore_client/models/artifact_response.rb', line 80

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

.openapi_typesObject

Attribute type mapping.


64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/pulpcore_client/models/artifact_response.rb', line 64

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'pulp_created' => :'DateTime',
    :'file' => :'String',
    :'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


167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/pulpcore_client/models/artifact_response.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      pulp_created == o.pulp_created &&
      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


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/pulpcore_client/models/artifact_response.rb', line 225

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


294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/pulpcore_client/models/artifact_response.rb', line 294

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


204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/pulpcore_client/models/artifact_response.rb', line 204

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

184
185
186
# File 'lib/pulpcore_client/models/artifact_response.rb', line 184

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


190
191
192
# File 'lib/pulpcore_client/models/artifact_response.rb', line 190

def hash
  [pulp_href, pulp_created, file, size, md5, sha1, sha224, sha256, sha384, sha512].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


149
150
151
152
153
154
155
156
# File 'lib/pulpcore_client/models/artifact_response.rb', line 149

def list_invalid_properties
  invalid_properties = Array.new
  if @file.nil?
    invalid_properties.push('invalid value for "file", file cannot be nil.')
  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


270
271
272
# File 'lib/pulpcore_client/models/artifact_response.rb', line 270

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


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

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


264
265
266
# File 'lib/pulpcore_client/models/artifact_response.rb', line 264

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


160
161
162
163
# File 'lib/pulpcore_client/models/artifact_response.rb', line 160

def valid?
  return false if @file.nil?
  true
end