pulp_file_client 3.102.0 → 3.103.0

data/lib/pulp_file_client/models/remote_network_config_response.rb

@@ -0,0 +1,398 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PulpFileClient
+  # Shared network configuration fields and validation logic used by both RemoteSerializer and UploadSerializerFieldsMixin.
+  class RemoteNetworkConfigResponse
+    # A PEM encoded CA certificate used to validate the server certificate presented by the remote server.
+    attr_accessor :ca_cert
+
+    # A PEM encoded client certificate used for authentication.
+    attr_accessor :client_cert
+
+    # If True, TLS peer validation must be performed.
+    attr_accessor :tls_validation
+
+    # The proxy URL. Format: scheme://host:port
+    attr_accessor :proxy_url
+
+    # Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.
+    attr_accessor :max_retries
+
+    # aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.
+    attr_accessor :total_timeout
+
+    # aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.
+    attr_accessor :connect_timeout
+
+    # 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.
+    attr_accessor :sock_connect_timeout
+
+    # 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.
+    attr_accessor :sock_read_timeout
+
+    # Headers for aiohttp.Clientsession
+    attr_accessor :headers
+
+    # Total number of simultaneous connections. If not set then the default value will be used.
+    attr_accessor :download_concurrency
+
+    # Limits requests per second for each concurrent downloader
+    attr_accessor :rate_limit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ca_cert' => :'ca_cert',
+        :'client_cert' => :'client_cert',
+        :'tls_validation' => :'tls_validation',
+        :'proxy_url' => :'proxy_url',
+        :'max_retries' => :'max_retries',
+        :'total_timeout' => :'total_timeout',
+        :'connect_timeout' => :'connect_timeout',
+        :'sock_connect_timeout' => :'sock_connect_timeout',
+        :'sock_read_timeout' => :'sock_read_timeout',
+        :'headers' => :'headers',
+        :'download_concurrency' => :'download_concurrency',
+        :'rate_limit' => :'rate_limit'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ca_cert' => :'String',
+        :'client_cert' => :'String',
+        :'tls_validation' => :'Boolean',
+        :'proxy_url' => :'String',
+        :'max_retries' => :'Integer',
+        :'total_timeout' => :'Float',
+        :'connect_timeout' => :'Float',
+        :'sock_connect_timeout' => :'Float',
+        :'sock_read_timeout' => :'Float',
+        :'headers' => :'Array<Object>',
+        :'download_concurrency' => :'Integer',
+        :'rate_limit' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'ca_cert',
+        :'client_cert',
+        :'proxy_url',
+        :'max_retries',
+        :'total_timeout',
+        :'connect_timeout',
+        :'sock_connect_timeout',
+        :'sock_read_timeout',
+        :'download_concurrency',
+        :'rate_limit'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PulpFileClient::RemoteNetworkConfigResponse` 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 `PulpFileClient::RemoteNetworkConfigResponse`. 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?(:'ca_cert')
+        self.ca_cert = attributes[:'ca_cert']
+      end
+
+      if attributes.key?(:'client_cert')
+        self.client_cert = attributes[:'client_cert']
+      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?(:'max_retries')
+        self.max_retries = attributes[:'max_retries']
+      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?(:'download_concurrency')
+        self.download_concurrency = attributes[:'download_concurrency']
+      end
+
+      if attributes.key?(:'rate_limit')
+        self.rate_limit = attributes[:'rate_limit']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      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
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_timeout Value to be assigned
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] connect_timeout Value to be assigned
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] sock_connect_timeout Value to be assigned
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] sock_read_timeout Value to be assigned
+    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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          ca_cert == o.ca_cert &&
+          client_cert == o.client_cert &&
+          tls_validation == o.tls_validation &&
+          proxy_url == o.proxy_url &&
+          max_retries == o.max_retries &&
+          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 &&
+          download_concurrency == o.download_concurrency &&
+          rate_limit == o.rate_limit
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [ca_cert, client_cert, tls_validation, proxy_url, max_retries, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, headers, download_concurrency, rate_limit].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = PulpFileClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end

data/lib/pulp_file_client/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.10.0
 =end
 
 module PulpFileClient
-  VERSION = '3.102.0'
+  VERSION = '3.103.0'
 end

data/lib/pulp_file_client.rb

@@ -48,6 +48,8 @@ require 'pulp_file_client/models/patchedfile_file_distribution'
 require 'pulp_file_client/models/patchedfile_file_remote'
 require 'pulp_file_client/models/patchedfile_file_repository'
 require 'pulp_file_client/models/policy_enum'
+require 'pulp_file_client/models/remote_network_config'
+require 'pulp_file_client/models/remote_network_config_response'
 require 'pulp_file_client/models/repair'
 require 'pulp_file_client/models/repository_add_remove_content'
 require 'pulp_file_client/models/repository_sync_url'

data/spec/api/content_files_api_spec.rb

@@ -44,6 +44,7 @@ describe 'ContentFilesApi' do
   # @option opts [File] :file An uploaded file that may be turned into the content unit.
   # @option opts [String] :upload An uncommitted upload that may be turned into the content unit.
   # @option opts [String] :file_url A url that Pulp can download and turn into the content unit.
+  # @option opts [RemoteNetworkConfig] :downloader_config Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.
   # @return [AsyncOperationResponse]
   describe 'create test' do
     it 'should work' do
@@ -133,6 +134,7 @@ describe 'ContentFilesApi' do
   # @option opts [File] :file An uploaded file that may be turned into the content unit.
   # @option opts [String] :upload An uncommitted upload that may be turned into the content unit.
   # @option opts [String] :file_url A url that Pulp can download and turn into the content unit.
+  # @option opts [RemoteNetworkConfig] :downloader_config Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.
   # @return [FileContentUploadResponse]
   describe 'upload test' do
     it 'should work' do

data/spec/models/file_file_remote_response_spec.rb

@@ -63,49 +63,49 @@ describe PulpFileClient::FileFileRemoteResponse do
     end
   end
 
-  describe 'test attribute "ca_cert"' do
+  describe 'test attribute "pulp_labels"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "client_cert"' do
+  describe 'test attribute "policy"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "tls_validation"' do
+  describe 'test attribute "hidden_fields"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "proxy_url"' do
+  describe 'test attribute "ca_cert"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "pulp_labels"' do
+  describe 'test attribute "client_cert"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "download_concurrency"' do
+  describe 'test attribute "tls_validation"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "max_retries"' do
+  describe 'test attribute "proxy_url"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "policy"' do
+  describe 'test attribute "max_retries"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
@@ -141,13 +141,13 @@ describe PulpFileClient::FileFileRemoteResponse do
     end
   end
 
-  describe 'test attribute "rate_limit"' do
+  describe 'test attribute "download_concurrency"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "hidden_fields"' do
+  describe 'test attribute "rate_limit"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/models/file_file_remote_spec.rb

@@ -39,67 +39,67 @@ describe PulpFileClient::FileFileRemote do
     end
   end
 
-  describe 'test attribute "ca_cert"' do
+  describe 'test attribute "pulp_labels"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "client_cert"' do
+  describe 'test attribute "policy"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "client_key"' do
+  describe 'test attribute "ca_cert"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "tls_validation"' do
+  describe 'test attribute "client_cert"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "proxy_url"' do
+  describe 'test attribute "client_key"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "proxy_username"' do
+  describe 'test attribute "tls_validation"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "proxy_password"' do
+  describe 'test attribute "proxy_url"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "username"' do
+  describe 'test attribute "proxy_username"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "password"' do
+  describe 'test attribute "proxy_password"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "pulp_labels"' do
+  describe 'test attribute "username"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "download_concurrency"' do
+  describe 'test attribute "password"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
@@ -111,12 +111,6 @@ describe PulpFileClient::FileFileRemote do
     end
   end
 
-  describe 'test attribute "policy"' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   describe 'test attribute "total_timeout"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -147,6 +141,12 @@ describe PulpFileClient::FileFileRemote do
     end
   end
 
+  describe 'test attribute "download_concurrency"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "rate_limit"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/