class PulpAnsibleClient::AnsibleCollectionVersion

A serializer for CollectionVersion Content.

Attributes

artifact[RW]

Artifact file representing the physical content

authors[RW]

A list of the CollectionVersion content's authors.

contents[RW]

A JSON field with data about the contents.

dependencies[RW]

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

description[RW]

A short summary description of the collection.

docs_blob[RW]

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

documentation[RW]

The URL to any online docs.

homepage[RW]

The URL to the homepage of the collection/project.

id[RW]

A collection identifier.

issues[RW]

The URL to the collection issue tracker.

license[RW]

A list of licenses for content inside of a collection.

name[RW]

The name of the collection.

namespace[RW]

The namespace of the collection.

repository[RW]

The URL of the originating SCM repository.

version[RW]

The version of the collection.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 64
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',
    :'license' => :'license',
    :'name' => :'name',
    :'namespace' => :'namespace',
    :'repository' => :'repository',
    :'version' => :'version'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 451
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 113
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?(:'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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 106
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 85
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',
    :'license' => :'Array<String>',
    :'name' => :'String',
    :'namespace' => :'String',
    :'repository' => :'String',
    :'version' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 416
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 &&
      license == o.license &&
      name == o.name &&
      namespace == o.namespace &&
      repository == o.repository &&
      version == o.version
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 479
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 548
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 458
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
documentation=(documentation) click to toggle source

Custom attribute writer method with validation @param [Object] documentation Value to be assigned

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 318
def documentation=(documentation)
  if documentation.nil?
    fail ArgumentError, 'documentation cannot be nil'
  end

  if documentation.to_s.length > 2000
    fail ArgumentError, 'invalid value for "documentation", the character length must be smaller than or equal to 2000.'
  end

  @documentation = documentation
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 438
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 444
def hash
  [artifact, id, authors, contents, dependencies, description, docs_blob, documentation, homepage, issues, license, name, namespace, repository, version].hash
end
homepage=(homepage) click to toggle source

Custom attribute writer method with validation @param [Object] homepage Value to be assigned

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 332
def homepage=(homepage)
  if homepage.nil?
    fail ArgumentError, 'homepage cannot be nil'
  end

  if homepage.to_s.length > 2000
    fail ArgumentError, 'invalid value for "homepage", the character length must be smaller than or equal to 2000.'
  end

  @homepage = homepage
end
issues=(issues) click to toggle source

Custom attribute writer method with validation @param [Object] issues Value to be assigned

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 346
def issues=(issues)
  if issues.nil?
    fail ArgumentError, 'issues cannot be nil'
  end

  if issues.to_s.length > 2000
    fail ArgumentError, 'invalid value for "issues", the character length must be smaller than or equal to 2000.'
  end

  @issues = issues
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 195
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 @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
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 360
def name=(name)
  if name.nil?
    fail ArgumentError, 'name cannot be nil'
  end

  if name.to_s.length > 32
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 32.'
  end

  @name = name
end
namespace=(namespace) click to toggle source

Custom attribute writer method with validation @param [Object] namespace Value to be assigned

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 374
def namespace=(namespace)
  if namespace.nil?
    fail ArgumentError, 'namespace cannot be nil'
  end

  if namespace.to_s.length > 32
    fail ArgumentError, 'invalid value for "namespace", the character length must be smaller than or equal to 32.'
  end

  @namespace = namespace
end
repository=(repository) click to toggle source

Custom attribute writer method with validation @param [Object] repository Value to be assigned

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 388
def repository=(repository)
  if repository.nil?
    fail ArgumentError, 'repository cannot be nil'
  end

  if repository.to_s.length > 2000
    fail ArgumentError, 'invalid value for "repository", the character length must be smaller than or equal to 2000.'
  end

  @repository = repository
end
to_body() click to toggle source

#to_body is an alias to #to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 524
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 530
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 518
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 290
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 @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
version=(version) click to toggle source

Custom attribute writer method with validation @param [Object] version Value to be assigned

# File lib/pulp_ansible_client/models/ansible_collection_version.rb, line 402
def version=(version)
  if version.nil?
    fail ArgumentError, 'version cannot be nil'
  end

  if version.to_s.length > 32
    fail ArgumentError, 'invalid value for "version", the character length must be smaller than or equal to 32.'
  end

  @version = version
end