class PulpPythonClient::PythonPythonRemote

A Serializer for PythonRemote.

Attributes

ca_cert[RW]

A PEM encoded CA certificate used to validate the server certificate presented by the remote server.

client_cert[RW]

A PEM encoded client certificate used for authentication.

client_key[RW]

A PEM encoded private key used for authentication.

connect_timeout[RW]

aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.

download_concurrency[RW]

Total number of simultaneous connections. If not set then the default value will be used.

exclude_platforms[RW]

List of platforms to exclude syncing Python packages for. Possible valuesinclude: windows, macos, freebsd, and linux.

excludes[RW]

A JSON list containing project specifiers for Python packages to exclude.

headers[RW]

Headers for aiohttp.Clientsession

includes[RW]

A JSON list containing project specifiers for Python packages to include.

keep_latest_packages[RW]

The amount of latest versions of a package to keep on sync, includespre-releases if synced. Default 0 keeps all versions.

max_retries[RW]

Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.

name[RW]

A unique name for this remote.

package_types[RW]

The package types to sync for Python content. Leave blank to get everypackage type.

password[RW]

The password to be used for authentication when syncing.

policy[RW]

The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default.

prereleases[RW]

Whether or not to include pre-release packages in the sync.

proxy_password[RW]

The password to authenticte to the proxy.

proxy_url[RW]

The proxy URL. Format: scheme://host:port

proxy_username[RW]

The username to authenticte to the proxy.

pulp_labels[RW]
rate_limit[RW]

Limits total download rate in requests per second

sock_connect_timeout[RW]

aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.

sock_read_timeout[RW]

aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.

tls_validation[RW]

If True, TLS peer validation must be performed.

total_timeout[RW]

aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.

url[RW]

The URL of an external content source.

username[RW]

The username to be used for authentication when syncing.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/pulp_python_client/models/python_python_remote.rb, line 99
def self.attribute_map
  {
    :'name' => :'name',
    :'url' => :'url',
    :'ca_cert' => :'ca_cert',
    :'client_cert' => :'client_cert',
    :'client_key' => :'client_key',
    :'tls_validation' => :'tls_validation',
    :'proxy_url' => :'proxy_url',
    :'proxy_username' => :'proxy_username',
    :'proxy_password' => :'proxy_password',
    :'username' => :'username',
    :'password' => :'password',
    :'pulp_labels' => :'pulp_labels',
    :'download_concurrency' => :'download_concurrency',
    :'max_retries' => :'max_retries',
    :'policy' => :'policy',
    :'total_timeout' => :'total_timeout',
    :'connect_timeout' => :'connect_timeout',
    :'sock_connect_timeout' => :'sock_connect_timeout',
    :'sock_read_timeout' => :'sock_read_timeout',
    :'headers' => :'headers',
    :'rate_limit' => :'rate_limit',
    :'includes' => :'includes',
    :'excludes' => :'excludes',
    :'prereleases' => :'prereleases',
    :'package_types' => :'package_types',
    :'keep_latest_packages' => :'keep_latest_packages',
    :'exclude_platforms' => :'exclude_platforms'
  }
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_python_client/models/python_python_remote.rb, line 464
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_python_client/models/python_python_remote.rb, line 187
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PulpPythonClient::PythonPythonRemote` 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 `PulpPythonClient::PythonPythonRemote`. 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?(:'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?(:'proxy_username')
    self.proxy_username = attributes[:'proxy_username']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'keep_latest_packages')
    self.keep_latest_packages = attributes[:'keep_latest_packages']
  else
    self.keep_latest_packages = 0
  end

  if attributes.key?(:'exclude_platforms')
    if (value = attributes[:'exclude_platforms']).is_a?(Array)
      self.exclude_platforms = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/pulp_python_client/models/python_python_remote.rb, line 165
def self.openapi_nullable
  Set.new([
    :'ca_cert',
    :'client_cert',
    :'client_key',
    :'proxy_url',
    :'proxy_username',
    :'proxy_password',
    :'username',
    :'password',
    :'download_concurrency',
    :'max_retries',
    :'total_timeout',
    :'connect_timeout',
    :'sock_connect_timeout',
    :'sock_read_timeout',
    :'rate_limit',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/pulp_python_client/models/python_python_remote.rb, line 132
def self.openapi_types
  {
    :'name' => :'String',
    :'url' => :'String',
    :'ca_cert' => :'String',
    :'client_cert' => :'String',
    :'client_key' => :'String',
    :'tls_validation' => :'Boolean',
    :'proxy_url' => :'String',
    :'proxy_username' => :'String',
    :'proxy_password' => :'String',
    :'username' => :'String',
    :'password' => :'String',
    :'pulp_labels' => :'Object',
    :'download_concurrency' => :'Integer',
    :'max_retries' => :'Integer',
    :'policy' => :'PolicyEnum',
    :'total_timeout' => :'Float',
    :'connect_timeout' => :'Float',
    :'sock_connect_timeout' => :'Float',
    :'sock_read_timeout' => :'Float',
    :'headers' => :'Array<Object>',
    :'rate_limit' => :'Integer',
    :'includes' => :'Object',
    :'excludes' => :'Object',
    :'prereleases' => :'Boolean',
    :'package_types' => :'Array<PackageTypesEnum>',
    :'keep_latest_packages' => :'Integer',
    :'exclude_platforms' => :'Array<ExcludePlatformsEnum>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/pulp_python_client/models/python_python_remote.rb, line 417
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      proxy_username == o.proxy_username &&
      proxy_password == o.proxy_password &&
      username == o.username &&
      password == o.password &&
      pulp_labels == o.pulp_labels &&
      download_concurrency == o.download_concurrency &&
      max_retries == o.max_retries &&
      policy == o.policy &&
      total_timeout == o.total_timeout &&
      connect_timeout == o.connect_timeout &&
      sock_connect_timeout == o.sock_connect_timeout &&
      sock_read_timeout == o.sock_read_timeout &&
      headers == o.headers &&
      rate_limit == o.rate_limit &&
      includes == o.includes &&
      excludes == o.excludes &&
      prereleases == o.prereleases &&
      package_types == o.package_types &&
      keep_latest_packages == o.keep_latest_packages &&
      exclude_platforms == o.exclude_platforms
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_python_client/models/python_python_remote.rb, line 492
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
    PulpPythonClient.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_python_client/models/python_python_remote.rb, line 561
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_python_client/models/python_python_remote.rb, line 471
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
connect_timeout=(connect_timeout) click to toggle source

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

# File lib/pulp_python_client/models/python_python_remote.rb, line 387
def connect_timeout=(connect_timeout)
  if !connect_timeout.nil? && connect_timeout < 0.0
    fail ArgumentError, 'invalid value for "connect_timeout", must be greater than or equal to 0.0.'
  end

  @connect_timeout = connect_timeout
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_python_client/models/python_python_remote.rb, line 367
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_python_client/models/python_python_remote.rb, line 451
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_python_client/models/python_python_remote.rb, line 457
def hash
  [name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, proxy_username, proxy_password, username, password, pulp_labels, download_concurrency, max_retries, policy, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, headers, rate_limit, includes, excludes, prereleases, package_types, keep_latest_packages, exclude_platforms].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_python_client/models/python_python_remote.rb, line 319
def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @url.nil?
    invalid_properties.push('invalid value for "url", url cannot be nil.')
  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 !@total_timeout.nil? && @total_timeout < 0.0
    invalid_properties.push('invalid value for "total_timeout", must be greater than or equal to 0.0.')
  end

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

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

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

  invalid_properties
end
sock_connect_timeout=(sock_connect_timeout) click to toggle source

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

# File lib/pulp_python_client/models/python_python_remote.rb, line 397
def sock_connect_timeout=(sock_connect_timeout)
  if !sock_connect_timeout.nil? && sock_connect_timeout < 0.0
    fail ArgumentError, 'invalid value for "sock_connect_timeout", must be greater than or equal to 0.0.'
  end

  @sock_connect_timeout = sock_connect_timeout
end
sock_read_timeout=(sock_read_timeout) click to toggle source

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

# File lib/pulp_python_client/models/python_python_remote.rb, line 407
def sock_read_timeout=(sock_read_timeout)
  if !sock_read_timeout.nil? && sock_read_timeout < 0.0
    fail ArgumentError, 'invalid value for "sock_read_timeout", must be greater than or equal to 0.0.'
  end

  @sock_read_timeout = sock_read_timeout
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_python_client/models/python_python_remote.rb, line 537
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_python_client/models/python_python_remote.rb, line 543
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_python_client/models/python_python_remote.rb, line 531
def to_s
  to_hash.to_s
end
total_timeout=(total_timeout) click to toggle source

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

# File lib/pulp_python_client/models/python_python_remote.rb, line 377
def total_timeout=(total_timeout)
  if !total_timeout.nil? && total_timeout < 0.0
    fail ArgumentError, 'invalid value for "total_timeout", must be greater than or equal to 0.0.'
  end

  @total_timeout = total_timeout
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_python_client/models/python_python_remote.rb, line 354
def valid?
  return false if @name.nil?
  return false if @url.nil?
  return false if !@download_concurrency.nil? && @download_concurrency < 1
  return false if !@total_timeout.nil? && @total_timeout < 0.0
  return false if !@connect_timeout.nil? && @connect_timeout < 0.0
  return false if !@sock_connect_timeout.nil? && @sock_connect_timeout < 0.0
  return false if !@sock_read_timeout.nil? && @sock_read_timeout < 0.0
  true
end