Class: PulpPythonClient::PythonPythonPackageContent

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_python_client/models/python_python_package_content.rb

Overview

A Serializer for PythonPackageContent.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PythonPythonPackageContent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
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
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
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 178

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#artifactObject

Artifact file representing the physical content



22
23
24
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 22

def artifact
  @artifact
end

#authorObject

Text containing the author’s name. Contact information can also be added, separated with newlines.



58
59
60
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 58

def author
  @author
end

#author_emailObject

The author’s e-mail address.



61
62
63
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 61

def author_email
  @author_email
end

#classifiersObject

A JSON list containing classification values for a Python package.



100
101
102
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 100

def classifiers
  @classifiers
end

#descriptionObject

A longer description of the package that can run to several paragraphs.



43
44
45
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 43

def description
  @description
end

#description_content_typeObject

A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description.



46
47
48
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 46

def description_content_type
  @description_content_type
end

#download_urlObject

Legacy field denoting the URL from which this package can be downloaded.



55
56
57
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 55

def download_url
  @download_url
end

#fileObject

An uploaded file that may be turned into the content unit.



28
29
30
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 28

def file
  @file
end

#file_urlObject

A url that Pulp can download and turn into the content unit.



34
35
36
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 34

def file_url
  @file_url
end

#home_pageObject

The URL for the package’s home page.



52
53
54
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 52

def home_page
  @home_page
end

#keywordsObject

Additional keywords to be used to assist searching for the package in a larger catalog.



49
50
51
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 49

def keywords
  @keywords
end

#licenseObject

Text indicating the license covering the distribution



70
71
72
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 70

def license
  @license
end

#maintainerObject

The maintainer’s name at a minimum; additional contact information may be provided.



64
65
66
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 64

def maintainer
  @maintainer
end

#maintainer_emailObject

The maintainer’s e-mail address.



67
68
69
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 67

def maintainer_email
  @maintainer_email
end

#obsoletes_distObject

A JSON list containing names of a distutils project’s distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.



94
95
96
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 94

def obsoletes_dist
  @obsoletes_dist
end

#platformObject

A comma-separated list of platform specifications, summarizing the operating systems supported by the package.



82
83
84
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 82

def platform
  @platform
end

#project_urlObject

A browsable URL for the project and a label for it, separated by a comma.



76
77
78
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 76

def project_url
  @project_url
end

#project_urlsObject

A dictionary of labels and URLs for the project.



79
80
81
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 79

def project_urls
  @project_urls
end

#provides_distObject

A JSON list containing names of a Distutils project which is contained within this distribution.



91
92
93
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 91

def provides_dist
  @provides_dist
end

#relative_pathObject

Path where the artifact is located relative to distributions base_path



25
26
27
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 25

def relative_path
  @relative_path
end

#repositoryObject

A URI of a repository the new content unit should be associated with.



19
20
21
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 19

def repository
  @repository
end

#requires_distObject

A JSON list containing names of some other distutils project required by this distribution.



88
89
90
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 88

def requires_dist
  @requires_dist
end

#requires_externalObject

A JSON list containing some dependency in the system that the distribution is to be used.



97
98
99
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 97

def requires_external
  @requires_external
end

#requires_pythonObject

The Python version(s) that the distribution is guaranteed to be compatible with.



73
74
75
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 73

def requires_python
  @requires_python
end

#sha256Object

The SHA256 digest of this package.



37
38
39
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 37

def sha256
  @sha256
end

#summaryObject

A one-line summary of what the package does.



40
41
42
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 40

def summary
  @summary
end

#supported_platformObject

Field to specify the OS and CPU for which the binary package was compiled.



85
86
87
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 85

def supported_platform
  @supported_platform
end

#uploadObject

An uncommitted upload that may be turned into the content unit.



31
32
33
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 31

def upload
  @upload
end

Class Method Details

.attribute_mapObject

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



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
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 103

def self.attribute_map
  {
    :'repository' => :'repository',
    :'artifact' => :'artifact',
    :'relative_path' => :'relative_path',
    :'file' => :'file',
    :'upload' => :'upload',
    :'file_url' => :'file_url',
    :'sha256' => :'sha256',
    :'summary' => :'summary',
    :'description' => :'description',
    :'description_content_type' => :'description_content_type',
    :'keywords' => :'keywords',
    :'home_page' => :'home_page',
    :'download_url' => :'download_url',
    :'author' => :'author',
    :'author_email' => :'author_email',
    :'maintainer' => :'maintainer',
    :'maintainer_email' => :'maintainer_email',
    :'license' => :'license',
    :'requires_python' => :'requires_python',
    :'project_url' => :'project_url',
    :'project_urls' => :'project_urls',
    :'platform' => :'platform',
    :'supported_platform' => :'supported_platform',
    :'requires_dist' => :'requires_dist',
    :'provides_dist' => :'provides_dist',
    :'obsoletes_dist' => :'obsoletes_dist',
    :'requires_external' => :'requires_external',
    :'classifiers' => :'classifiers'
  }
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



423
424
425
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 423

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

.openapi_nullableObject

List of attributes with nullable: true



171
172
173
174
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 171

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

.openapi_typesObject

Attribute type mapping.



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
164
165
166
167
168
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 137

def self.openapi_types
  {
    :'repository' => :'String',
    :'artifact' => :'String',
    :'relative_path' => :'String',
    :'file' => :'File',
    :'upload' => :'String',
    :'file_url' => :'String',
    :'sha256' => :'String',
    :'summary' => :'String',
    :'description' => :'String',
    :'description_content_type' => :'String',
    :'keywords' => :'String',
    :'home_page' => :'String',
    :'download_url' => :'String',
    :'author' => :'String',
    :'author_email' => :'String',
    :'maintainer' => :'String',
    :'maintainer_email' => :'String',
    :'license' => :'String',
    :'requires_python' => :'String',
    :'project_url' => :'String',
    :'project_urls' => :'Object',
    :'platform' => :'String',
    :'supported_platform' => :'String',
    :'requires_dist' => :'Object',
    :'provides_dist' => :'Object',
    :'obsoletes_dist' => :'Object',
    :'requires_external' => :'Object',
    :'classifiers' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 375

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      repository == o.repository &&
      artifact == o.artifact &&
      relative_path == o.relative_path &&
      file == o.file &&
      upload == o.upload &&
      file_url == o.file_url &&
      sha256 == o.sha256 &&
      summary == o.summary &&
      description == o.description &&
      description_content_type == o.description_content_type &&
      keywords == o.keywords &&
      home_page == o.home_page &&
      download_url == o.download_url &&
      author == o.author &&
      author_email == o.author_email &&
      maintainer == o.maintainer &&
      maintainer_email == o.maintainer_email &&
      license == o.license &&
      requires_python == o.requires_python &&
      project_url == o.project_url &&
      project_urls == o.project_urls &&
      platform == o.platform &&
      supported_platform == o.supported_platform &&
      requires_dist == o.requires_dist &&
      provides_dist == o.provides_dist &&
      obsoletes_dist == o.obsoletes_dist &&
      requires_external == o.requires_external &&
      classifiers == o.classifiers
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



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 451

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



520
521
522
523
524
525
526
527
528
529
530
531
532
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 520

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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 430

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


410
411
412
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 410

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



416
417
418
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 416

def hash
  [repository, artifact, relative_path, file, upload, file_url, sha256, summary, description, description_content_type, keywords, home_page, download_url, author, author_email, maintainer, maintainer_email, license, requires_python, project_url, project_urls, platform, supported_platform, requires_dist, provides_dist, obsoletes_dist, requires_external, classifiers].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 308

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

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

  if !@file_url.nil? && @file_url.to_s.length < 1
    invalid_properties.push('invalid value for "file_url", 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

  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



496
497
498
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 496

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



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 502

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



490
491
492
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 490

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



331
332
333
334
335
336
337
# File 'lib/pulp_python_client/models/python_python_package_content.rb', line 331

def valid?
  return false if @relative_path.nil?
  return false if @relative_path.to_s.length < 1
  return false if !@file_url.nil? && @file_url.to_s.length < 1
  return false if !@sha256.nil? && @sha256.to_s.length < 1
  true
end