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



73
74
75
76
77
78
79
80
81
82
83
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
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 73

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

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

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

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

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

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

Instance Attribute Details

#artifactObject

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

#expected_nameObject

The name of the collection.



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

def expected_name
  @expected_name
end

#expected_namespaceObject

The namespace of the collection.



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

def expected_namespace
  @expected_namespace
end

#expected_versionObject

The version of the collection.



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

def expected_version
  @expected_version
end

#fileObject

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



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

def file
  @file
end

#repositoryObject

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



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

def repository
  @repository
end

#uploadObject

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



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

def upload
  @upload
end

Class Method Details

.attribute_mapObject

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



40
41
42
43
44
45
46
47
48
49
50
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 40

def self.attribute_map
  {
    :'artifact' => :'artifact',
    :'upload' => :'upload',
    :'file' => :'file',
    :'repository' => :'repository',
    :'expected_name' => :'expected_name',
    :'expected_namespace' => :'expected_namespace',
    :'expected_version' => :'expected_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



229
230
231
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 229

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

.openapi_nullableObject

List of attributes with nullable: true



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

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

.openapi_typesObject

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 53

def self.openapi_types
  {
    :'artifact' => :'String',
    :'upload' => :'String',
    :'file' => :'File',
    :'repository' => :'String',
    :'expected_name' => :'String',
    :'expected_namespace' => :'String',
    :'expected_version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



202
203
204
205
206
207
208
209
210
211
212
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      artifact == o.artifact &&
      upload == o.upload &&
      file == o.file &&
      repository == o.repository &&
      expected_name == o.expected_name &&
      expected_namespace == o.expected_namespace &&
      expected_version == o.expected_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



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

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



326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 326

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 236

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


216
217
218
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 216

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



222
223
224
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 222

def hash
  [artifact, upload, file, repository, expected_name, expected_namespace, expected_version].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@expected_name.nil? && @expected_name.to_s.length > 64
    invalid_properties.push('invalid value for "expected_name", the character length must be smaller than or equal to 64.')
  end

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

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

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

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

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



302
303
304
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 302

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



308
309
310
311
312
313
314
315
316
317
318
319
320
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 308

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



296
297
298
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 296

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



148
149
150
151
152
153
154
155
156
# File 'lib/pulp_ansible_client/models/ansible_collection_version.rb', line 148

def valid?
  return false if !@expected_name.nil? && @expected_name.to_s.length > 64
  return false if !@expected_name.nil? && @expected_name.to_s.length < 1
  return false if !@expected_namespace.nil? && @expected_namespace.to_s.length > 64
  return false if !@expected_namespace.nil? && @expected_namespace.to_s.length < 1
  return false if !@expected_version.nil? && @expected_version.to_s.length > 128
  return false if !@expected_version.nil? && @expected_version.to_s.length < 1
  true
end