Class: PulpAnsibleClient::AnsibleCollectionVersion

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_ansible_client/models/ansible_collection_version.rb

Overview

A serializer for CollectionVersion Content.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnsibleCollectionVersion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 118

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

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

  if attributes.key?(:'authors')
    if (value = attributes[:'authors']).is_a?(Array)
      self.authors = value
    end
  end

  if attributes.key?(:'contents')
    if (value = attributes[:'contents']).is_a?(Array)
      self.contents = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#artifact ⇒ Object

Artifact file representing the physical content



19
20
21
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 19

def artifact
  @artifact
end

#authors ⇒ Object

A list of the CollectionVersion content’s authors.



25
26
27
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 25

def authors
  @authors
end

#certification ⇒ Object

Indicates that the version is certified



49
50
51
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 49

def certification
  @certification
end

#contents ⇒ Object

A JSON field with data about the contents.



28
29
30
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 28

def contents
  @contents
end

#dependencies ⇒ Object

A dict declaring Collections that this collection requires to be installed for it to be usable.



31
32
33
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 31

def dependencies
  @dependencies
end

#description ⇒ Object

A short summary description of the collection.



34
35
36
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 34

def description
  @description
end

#docs_blob ⇒ Object

A JSON field holding the various documentation blobs in the collection.



37
38
39
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 37

def docs_blob
  @docs_blob
end

#documentation ⇒ Object

The URL to any online docs.



40
41
42
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 40

def documentation
  @documentation
end

#homepage ⇒ Object

The URL to the homepage of the collection/project.



43
44
45
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 43

def homepage
  @homepage
end

#id ⇒ Object

A collection identifier.



22
23
24
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 22

def id
  @id
end

#issues ⇒ Object

The URL to the collection issue tracker.



46
47
48
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 46

def issues
  @issues
end

#license ⇒ Object

A list of licenses for content inside of a collection.



52
53
54
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 52

def license
  @license
end

#name ⇒ Object

The name of the collection.



55
56
57
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 55

def name
  @name
end

#namespace ⇒ Object

The namespace of the collection.



58
59
60
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 58

def namespace
  @namespace
end

#repository ⇒ Object

The URL of the originating SCM repository.



61
62
63
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 61

def repository
  @repository
end

#version ⇒ Object

The version of the collection.



64
65
66
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 64

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 67

def self.attribute_map
  {
    :'artifact' => :'artifact',
    :'id' => :'id',
    :'authors' => :'authors',
    :'contents' => :'contents',
    :'dependencies' => :'dependencies',
    :'description' => :'description',
    :'docs_blob' => :'docs_blob',
    :'documentation' => :'documentation',
    :'homepage' => :'homepage',
    :'issues' => :'issues',
    :'certification' => :'certification',
    :'license' => :'license',
    :'name' => :'name',
    :'namespace' => :'namespace',
    :'repository' => :'repository',
    :'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



466
467
468
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 466

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 89

def self.openapi_types
  {
    :'artifact' => :'String',
    :'id' => :'String',
    :'authors' => :'Array<String>',
    :'contents' => :'Array<Object>',
    :'dependencies' => :'Object',
    :'description' => :'String',
    :'docs_blob' => :'Object',
    :'documentation' => :'String',
    :'homepage' => :'String',
    :'issues' => :'String',
    :'certification' => :'String',
    :'license' => :'Array<String>',
    :'name' => :'String',
    :'namespace' => :'String',
    :'repository' => :'String',
    :'version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 430

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      artifact == o.artifact &&
      id == o.id &&
      authors == o.authors &&
      contents == o.contents &&
      dependencies == o.dependencies &&
      description == o.description &&
      docs_blob == o.docs_blob &&
      documentation == o.documentation &&
      homepage == o.homepage &&
      issues == o.issues &&
      certification == o.certification &&
      license == o.license &&
      name == o.name &&
      namespace == o.namespace &&
      repository == o.repository &&
      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



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 494

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



563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 563

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



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 473

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


453
454
455
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 453

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



459
460
461
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 459

def hash
  [artifact, id, authors, contents, dependencies, description, docs_blob, documentation, homepage, issues, certification, license, name, namespace, repository, version].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



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
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 204

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

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @authors.nil?
    invalid_properties.push('invalid value for "authors", authors cannot be nil.')
  end

  if @contents.nil?
    invalid_properties.push('invalid value for "contents", contents cannot be nil.')
  end

  if @dependencies.nil?
    invalid_properties.push('invalid value for "dependencies", dependencies cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @docs_blob.nil?
    invalid_properties.push('invalid value for "docs_blob", docs_blob cannot be nil.')
  end

  if @documentation.nil?
    invalid_properties.push('invalid value for "documentation", documentation cannot be nil.')
  end

  if @documentation.to_s.length > 2000
    invalid_properties.push('invalid value for "documentation", the character length must be smaller than or equal to 2000.')
  end

  if @homepage.nil?
    invalid_properties.push('invalid value for "homepage", homepage cannot be nil.')
  end

  if @homepage.to_s.length > 2000
    invalid_properties.push('invalid value for "homepage", the character length must be smaller than or equal to 2000.')
  end

  if @issues.nil?
    invalid_properties.push('invalid value for "issues", issues cannot be nil.')
  end

  if @issues.to_s.length > 2000
    invalid_properties.push('invalid value for "issues", the character length must be smaller than or equal to 2000.')
  end

  if @certification.nil?
    invalid_properties.push('invalid value for "certification", certification cannot be nil.')
  end

  if @license.nil?
    invalid_properties.push('invalid value for "license", license cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 32
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 32.')
  end

  if @namespace.nil?
    invalid_properties.push('invalid value for "namespace", namespace cannot be nil.')
  end

  if @namespace.to_s.length > 32
    invalid_properties.push('invalid value for "namespace", the character length must be smaller than or equal to 32.')
  end

  if @repository.nil?
    invalid_properties.push('invalid value for "repository", repository cannot be nil.')
  end

  if @repository.to_s.length > 2000
    invalid_properties.push('invalid value for "repository", the character length must be smaller than or equal to 2000.')
  end

  if @version.nil?
    invalid_properties.push('invalid value for "version", version cannot be nil.')
  end

  if @version.to_s.length > 32
    invalid_properties.push('invalid value for "version", the character length must be smaller than or equal to 32.')
  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



539
540
541
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 539

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



545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 545

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



533
534
535
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 533

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



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
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 303

def valid?
  return false if @artifact.nil?
  return false if @id.nil?
  return false if @authors.nil?
  return false if @contents.nil?
  return false if @dependencies.nil?
  return false if @description.nil?
  return false if @docs_blob.nil?
  return false if @documentation.nil?
  return false if @documentation.to_s.length > 2000
  return false if @homepage.nil?
  return false if @homepage.to_s.length > 2000
  return false if @issues.nil?
  return false if @issues.to_s.length > 2000
  return false if @certification.nil?
  return false if @license.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 32
  return false if @namespace.nil?
  return false if @namespace.to_s.length > 32
  return false if @repository.nil?
  return false if @repository.to_s.length > 2000
  return false if @version.nil?
  return false if @version.to_s.length > 32
  true
end