pulp_rpm_client 3.27.2 → 3.28.0

data/docs/PatchedrpmUlnRemote.md

@@ -2,58 +2,59 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A unique name for this remote. | [optional] 
-**url** | **String** | The ULN repo URL of the remote content source.\"This is \"uln://\" followed by the channel name. E.g.: \"uln://ol7_x86_64_oracle\" | [optional] 
-**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
-**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] 
-**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
-**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
-**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
-**proxy_username** | **String** | The username to authenticte to the proxy. | [optional] 
-**proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
-**username** | **String** | Your ULN account username. | [optional] 
-**password** | **String** | Your ULN account password. | [optional] 
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
-**max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] 
-**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default.  * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] 
-**total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**sock_connect_timeout** | **Float** | 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. | [optional] 
-**sock_read_timeout** | **Float** | 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. | [optional] 
-**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] 
-**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] 
-**uln_server_base_url** | **String** | Base URL of the ULN server. If the uln_server_base_url is not provided pulp_rpm willuse the contents of the DEFAULT_ULN_SERVER_BASE_URL setting instead. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A unique name for this remote. | [optional] |
+| **url** | **String** | The ULN repo URL of the remote content source.\"This is \"uln://\" followed by the channel name. E.g.: \"uln://ol7_x86_64_oracle\" | [optional] |
+| **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
+| **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
+| **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] |
+| **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
+| **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
+| **proxy_username** | **String** | The username to authenticte to the proxy. | [optional] |
+| **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
+| **username** | **String** | Your ULN account username. | [optional] |
+| **password** | **String** | Your ULN account password. | [optional] |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
+| **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] |
+| **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default.  * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] |
+| **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **sock_connect_timeout** | **Float** | 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. | [optional] |
+| **sock_read_timeout** | **Float** | 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. | [optional] |
+| **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] |
+| **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
+| **uln_server_base_url** | **String** | Base URL of the ULN server. If the uln_server_base_url is not provided pulp_rpm willuse the contents of the DEFAULT_ULN_SERVER_BASE_URL setting instead. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::PatchedrpmUlnRemote.new(name: null,
-                                 url: null,
-                                 ca_cert: null,
-                                 client_cert: null,
-                                 client_key: null,
-                                 tls_validation: null,
-                                 proxy_url: null,
-                                 proxy_username: null,
-                                 proxy_password: null,
-                                 username: null,
-                                 password: null,
-                                 pulp_labels: null,
-                                 download_concurrency: null,
-                                 max_retries: null,
-                                 policy: null,
-                                 total_timeout: null,
-                                 connect_timeout: null,
-                                 sock_connect_timeout: null,
-                                 sock_read_timeout: null,
-                                 headers: null,
-                                 rate_limit: null,
-                                 uln_server_base_url: null)
+instance = PulpRpmClient::PatchedrpmUlnRemote.new(
+  name: null,
+  url: null,
+  ca_cert: null,
+  client_cert: null,
+  client_key: null,
+  tls_validation: null,
+  proxy_url: null,
+  proxy_username: null,
+  proxy_password: null,
+  username: null,
+  password: null,
+  pulp_labels: null,
+  download_concurrency: null,
+  max_retries: null,
+  policy: null,
+  total_timeout: null,
+  connect_timeout: null,
+  sock_connect_timeout: null,
+  sock_read_timeout: null,
+  headers: null,
+  rate_limit: null,
+  uln_server_base_url: null
+)
 ```
 
-

data/docs/PolicyEnum.md

@@ -2,15 +2,14 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
 instance = PulpRpmClient::PolicyEnum.new()
 ```
 
-

data/docs/PrunePackages.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**repo_hrefs** | **Array<String>** | Will prune old packages from the specified list of repos. Use ['*'] to specify all repos. Will prune based on the specified repositories' latest_versions. | 
-**keep_days** | **Integer** | Prune packages introduced *prior-to* this many days ago. Default is 14. A value of 0 implies 'keep latest package only.' | [optional] [default to 14]
-**dry_run** | **Boolean** | Determine what would-be-pruned and log the list of packages. Intended as a debugging aid. | [optional] [default to false]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **repo_hrefs** | **Array<String>** | Will prune old packages from the specified list of repos. Use ['*'] to specify all repos. Will prune based on the specified repositories' latest_versions. |  |
+| **keep_days** | **Integer** | Prune packages introduced *prior-to* this many days ago. Default is 14. A value of 0 implies 'keep latest package only.' | [optional][default to 14] |
+| **dry_run** | **Boolean** | Determine what would-be-pruned and log the list of packages. Intended as a debugging aid. | [optional][default to false] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::PrunePackages.new(repo_hrefs: null,
-                                 keep_days: null,
-                                 dry_run: null)
+instance = PulpRpmClient::PrunePackages.new(
+  repo_hrefs: null,
+  keep_days: null,
+  dry_run: null
+)
 ```
 
-