class PulpAnsibleClient::AnsibleCollectionRemote

Attributes

ca_cert[RW]

A string containing the PEM encoded CA certificate used to validate the server certificate presented by the remote server. All new line characters must be escaped. Returns SHA256 checksum of the certificate file on GET.

client_cert[RW]

A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. Returns SHA256 checksum of the certificate file on GET.

client_key[RW]

A PEM encoded private key used for authentication. Returns SHA256 checksum of the certificate file on GET.

download_concurrency[RW]

Total number of simultaneous connections.

name[RW]

A unique name for this remote.

policy[RW]

The policy to use when downloading content.

proxy_url[RW]

The proxy URL. Format: scheme://user:password@host:port

pulp_created[RW]

Timestamp of creation.

pulp_href[RW]
pulp_last_updated[RW]

Timestamp of the most recent update of the remote.

requirements_file[RW]

The string version of Collection requirements yaml.

tls_validation[RW]

If True, TLS peer validation must be performed.

url[RW]

The URL of an external content source.

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_remote.rb, line 78
def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'pulp_created' => :'pulp_created',
    :'name' => :'name',
    :'url' => :'url',
    :'ca_cert' => :'ca_cert',
    :'client_cert' => :'client_cert',
    :'client_key' => :'client_key',
    :'tls_validation' => :'tls_validation',
    :'proxy_url' => :'proxy_url',
    :'pulp_last_updated' => :'pulp_last_updated',
    :'download_concurrency' => :'download_concurrency',
    :'policy' => :'policy',
    :'requirements_file' => :'requirements_file'
  }
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_remote.rb, line 394
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_remote.rb, line 128
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PulpAnsibleClient::AnsibleCollectionRemote` 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::AnsibleCollectionRemote`. 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?(:'pulp_href')
    self.pulp_href = attributes[:'pulp_href']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'requirements_file')
    self.requirements_file = attributes[:'requirements_file']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 116
def self.openapi_nullable
  Set.new([
    :'ca_cert',
    :'client_cert',
    :'client_key',
    :'proxy_url',
    :'requirements_file'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 97
def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'pulp_created' => :'DateTime',
    :'name' => :'String',
    :'url' => :'String',
    :'ca_cert' => :'String',
    :'client_cert' => :'String',
    :'client_key' => :'String',
    :'tls_validation' => :'Boolean',
    :'proxy_url' => :'String',
    :'pulp_last_updated' => :'DateTime',
    :'download_concurrency' => :'Integer',
    :'policy' => :'String',
    :'requirements_file' => :'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_remote.rb, line 361
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      pulp_created == o.pulp_created &&
      name == o.name &&
      url == o.url &&
      ca_cert == o.ca_cert &&
      client_cert == o.client_cert &&
      client_key == o.client_key &&
      tls_validation == o.tls_validation &&
      proxy_url == o.proxy_url &&
      pulp_last_updated == o.pulp_last_updated &&
      download_concurrency == o.download_concurrency &&
      policy == o.policy &&
      requirements_file == o.requirements_file
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_remote.rb, line 422
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_remote.rb, line 491
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_remote.rb, line 401
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
ca_cert=(ca_cert) click to toggle source

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

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 291
def ca_cert=(ca_cert)
  if !ca_cert.nil? && ca_cert.to_s.length < 1
    fail ArgumentError, 'invalid value for "ca_cert", the character length must be great than or equal to 1.'
  end

  @ca_cert = ca_cert
end
client_cert=(client_cert) click to toggle source

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

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 301
def client_cert=(client_cert)
  if !client_cert.nil? && client_cert.to_s.length < 1
    fail ArgumentError, 'invalid value for "client_cert", the character length must be great than or equal to 1.'
  end

  @client_cert = client_cert
end
client_key=(client_key) click to toggle source

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

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 311
def client_key=(client_key)
  if !client_key.nil? && client_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "client_key", the character length must be great than or equal to 1.'
  end

  @client_key = client_key
end
download_concurrency=(download_concurrency) click to toggle source

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

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 331
def download_concurrency=(download_concurrency)
  if !download_concurrency.nil? && download_concurrency < 1
    fail ArgumentError, 'invalid value for "download_concurrency", must be greater than or equal to 1.'
  end

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

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

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 381
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_remote.rb, line 387
def hash
  [pulp_href, pulp_created, name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, pulp_last_updated, download_concurrency, policy, requirements_file].hash
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_remote.rb, line 198
def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

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

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

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

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

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

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

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

  if !@download_concurrency.nil? && @download_concurrency < 1
    invalid_properties.push('invalid value for "download_concurrency", must be greater than or equal to 1.')
  end

  if !@requirements_file.nil? && @requirements_file.to_s.length < 1
    invalid_properties.push('invalid value for "requirements_file", the character length must be great than or equal to 1.')
  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_remote.rb, line 263
def name=(name)
  if name.nil?
    fail ArgumentError, 'name cannot be nil'
  end

  if name.to_s.length < 1
    fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
  end

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

Custom attribute writer method checking allowed values (enum). @param [Object] policy Object to be assigned

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 341
def policy=(policy)
  validator = EnumAttributeValidator.new('String', ["immediate", "When syncing, download all metadata and content now."])
  unless validator.valid?(policy)
    fail ArgumentError, "invalid value for \"policy\", must be one of #{validator.allowable_values}."
  end
  @policy = policy
end
proxy_url=(proxy_url) click to toggle source

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

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 321
def proxy_url=(proxy_url)
  if !proxy_url.nil? && proxy_url.to_s.length < 1
    fail ArgumentError, 'invalid value for "proxy_url", the character length must be great than or equal to 1.'
  end

  @proxy_url = proxy_url
end
requirements_file=(requirements_file) click to toggle source

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

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 351
def requirements_file=(requirements_file)
  if !requirements_file.nil? && requirements_file.to_s.length < 1
    fail ArgumentError, 'invalid value for "requirements_file", the character length must be great than or equal to 1.'
  end

  @requirements_file = requirements_file
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_remote.rb, line 467
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_remote.rb, line 473
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_remote.rb, line 461
def to_s
  to_hash.to_s
end
url=(url) click to toggle source

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

# File lib/pulp_ansible_client/models/ansible_collection_remote.rb, line 277
def url=(url)
  if url.nil?
    fail ArgumentError, 'url cannot be nil'
  end

  if url.to_s.length < 1
    fail ArgumentError, 'invalid value for "url", the character length must be great than or equal to 1.'
  end

  @url = url
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_remote.rb, line 245
def valid?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @url.nil?
  return false if @url.to_s.length < 1
  return false if !@ca_cert.nil? && @ca_cert.to_s.length < 1
  return false if !@client_cert.nil? && @client_cert.to_s.length < 1
  return false if !@client_key.nil? && @client_key.to_s.length < 1
  return false if !@proxy_url.nil? && @proxy_url.to_s.length < 1
  return false if !@download_concurrency.nil? && @download_concurrency < 1
  policy_validator = EnumAttributeValidator.new('String', ["immediate", "When syncing, download all metadata and content now."])
  return false unless policy_validator.valid?(@policy)
  return false if !@requirements_file.nil? && @requirements_file.to_s.length < 1
  true
end