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



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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 129

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

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

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

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



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

def documentation
  @documentation
end

#files ⇒ Object

A JSON field holding FILES.json data.



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

def files
  @files
end

#homepage ⇒ Object

The URL to the homepage of the collection/project.



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

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.



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

def issues
  @issues
end

#license ⇒ Object

A list of licenses for content inside of a collection.



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

def license
  @license
end

#manifest ⇒ Object

A JSON field holding MANIFEST.json data.



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

def manifest
  @manifest
end

#name ⇒ Object

The name of the collection.



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

def name
  @name
end

#namespace ⇒ Object

The namespace of the collection.



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

def namespace
  @namespace
end

#repository ⇒ Object

The URL of the originating SCM repository.



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

def repository
  @repository
end

#requires_ansible ⇒ Object

The version of Ansible required to use the collection. Multiple versions can be separated with a comma.



70
71
72
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 70

def requires_ansible
  @requires_ansible
end

#version ⇒ Object

The version of the collection.



67
68
69
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 67

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 73

def self.attribute_map
  {
    :'artifact' => :'artifact',
    :'id' => :'id',
    :'authors' => :'authors',
    :'contents' => :'contents',
    :'dependencies' => :'dependencies',
    :'description' => :'description',
    :'docs_blob' => :'docs_blob',
    :'manifest' => :'manifest',
    :'files' => :'files',
    :'documentation' => :'documentation',
    :'homepage' => :'homepage',
    :'issues' => :'issues',
    :'license' => :'license',
    :'name' => :'name',
    :'namespace' => :'namespace',
    :'repository' => :'repository',
    :'version' => :'version',
    :'requires_ansible' => :'requires_ansible'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



507
508
509
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 507

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
125
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 121

def self.openapi_nullable
  Set.new([
    :'requires_ansible'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 97

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

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 &&
      manifest == o.manifest &&
      files == o.files &&
      documentation == o.documentation &&
      homepage == o.homepage &&
      issues == o.issues &&
      license == o.license &&
      name == o.name &&
      namespace == o.namespace &&
      repository == o.repository &&
      version == o.version &&
      requires_ansible == o.requires_ansible
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 535

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



604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 604

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



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 514

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

See Also:

  • `==` method


494
495
496
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 494

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



500
501
502
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 500

def hash
  [artifact, id, authors, contents, dependencies, description, docs_blob, manifest, files, documentation, homepage, issues, license, name, namespace, repository, version, requires_ansible].hash
end

#list_invalid_properties ⇒ Object

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



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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 223

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 @manifest.nil?
    invalid_properties.push('invalid value for "manifest", manifest cannot be nil.')
  end

  if @files.nil?
    invalid_properties.push('invalid value for "files", files 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 @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 > 64
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 64.')
  end

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

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

  if !@requires_ansible.nil? && @requires_ansible.to_s.length > 255
    invalid_properties.push('invalid value for "requires_ansible", the character length must be smaller than or equal to 255.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



580
581
582
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 580

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 586

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



574
575
576
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 574

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 330

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 @manifest.nil?
  return false if @files.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 @license.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 64
  return false if @namespace.nil?
  return false if @namespace.to_s.length > 64
  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 > 128
  return false if !@requires_ansible.nil? && @requires_ansible.to_s.length > 255
  true
end