pulp_python_client 3.12.5 → 3.13.0

data/docs/PatchedpythonPythonRemote.md

@@ -2,68 +2,69 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A unique name for this remote. | [optional] 
-**url** | **String** | The URL of an external content source. | [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** | The username to be used for authentication when syncing. | [optional] 
-**password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [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'. 'on_demand' 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] 
-**includes** | **Array<String>** | A list containing project specifiers for Python packages to include. | [optional] 
-**excludes** | **Array<String>** | A list containing project specifiers for Python packages to exclude. | [optional] 
-**prereleases** | **Boolean** | Whether or not to include pre-release packages in the sync. | [optional] 
-**package_types** | [**Array<PackageTypesEnum>**](PackageTypesEnum.md) | The package types to sync for Python content. Leave blank to get everypackage type. | [optional] 
-**keep_latest_packages** | **Integer** | The amount of latest versions of a package to keep on sync, includespre-releases if synced. Default 0 keeps all versions. | [optional] [default to 0]
-**exclude_platforms** | [**Array<ExcludePlatformsEnum>**](ExcludePlatformsEnum.md) | List of platforms to exclude syncing Python packages for. Possible valuesinclude: windows, macos, freebsd, and linux. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A unique name for this remote. | [optional] |
+| **url** | **String** | The URL of an external content source. | [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** | The username to be used for authentication when syncing. | [optional] |
+| **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [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'. 'on_demand' 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] |
+| **includes** | **Array<String>** | A list containing project specifiers for Python packages to include. | [optional] |
+| **excludes** | **Array<String>** | A list containing project specifiers for Python packages to exclude. | [optional] |
+| **prereleases** | **Boolean** | Whether or not to include pre-release packages in the sync. | [optional] |
+| **package_types** | [**Array<PackageTypesEnum>**](PackageTypesEnum.md) | The package types to sync for Python content. Leave blank to get everypackage type. | [optional] |
+| **keep_latest_packages** | **Integer** | The amount of latest versions of a package to keep on sync, includespre-releases if synced. Default 0 keeps all versions. | [optional][default to 0] |
+| **exclude_platforms** | [**Array<ExcludePlatformsEnum>**](ExcludePlatformsEnum.md) | List of platforms to exclude syncing Python packages for. Possible valuesinclude: windows, macos, freebsd, and linux. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PatchedpythonPythonRemote.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,
-                                 includes: null,
-                                 excludes: null,
-                                 prereleases: null,
-                                 package_types: null,
-                                 keep_latest_packages: null,
-                                 exclude_platforms: null)
+instance = PulpPythonClient::PatchedpythonPythonRemote.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,
+  includes: null,
+  excludes: null,
+  prereleases: null,
+  package_types: null,
+  keep_latest_packages: null,
+  exclude_platforms: null
+)
 ```
 
-

data/docs/PatchedpythonPythonRepository.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**name** | **String** | A unique name for this repository. | [optional] 
-**description** | **String** | An optional description. | [optional] 
-**retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] 
-**remote** | **String** | An optional remote to use by default when syncing. | [optional] 
-**autopublish** | **Boolean** | Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository. | [optional] [default to false]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **name** | **String** | A unique name for this repository. | [optional] |
+| **description** | **String** | An optional description. | [optional] |
+| **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] |
+| **remote** | **String** | An optional remote to use by default when syncing. | [optional] |
+| **autopublish** | **Boolean** | Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository. | [optional][default to false] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PatchedpythonPythonRepository.new(pulp_labels: null,
-                                 name: null,
-                                 description: null,
-                                 retain_repo_versions: null,
-                                 remote: null,
-                                 autopublish: null)
+instance = PulpPythonClient::PatchedpythonPythonRepository.new(
+  pulp_labels: null,
+  name: null,
+  description: null,
+  retain_repo_versions: null,
+  remote: null,
+  autopublish: null
+)
 ```
 
-

data/docs/PolicyEnum.md

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