pulp_rpm_client 3.27.2 → 3.28.1

data/docs/RpmRepositorySyncURL.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**remote** | **String** | A remote to sync from. This will override a remote set on repository. | [optional] 
-**mirror** | **Boolean** | DEPRECATED: If ``True``, ``sync_policy`` will default to 'mirror_complete' instead of 'additive'. | [optional] 
-**sync_policy** | [**SyncPolicyEnum**](SyncPolicyEnum.md) | Options: 'additive', 'mirror_complete', 'mirror_content_only'. Default: 'additive'. Modifies how the sync is performed. 'mirror_complete' will clone the original metadata and create an automatic publication from it, but comes with some limitations and does not work for certain repositories. 'mirror_content_only' will change the repository contents to match the remote but the metadata will be regenerated and will not be bit-for-bit identical. 'additive' will retain the existing contents of the repository and add the contents of the repository being synced.  * `additive` - additive * `mirror_complete` - mirror_complete * `mirror_content_only` - mirror_content_only | [optional] 
-**skip_types** | [**Array<SkipTypesEnum>**](SkipTypesEnum.md) | List of content types to skip during sync. | [optional] 
-**optimize** | **Boolean** | Whether or not to optimize sync. | [optional] [default to true]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote** | **String** | A remote to sync from. This will override a remote set on repository. | [optional] |
+| **mirror** | **Boolean** | DEPRECATED: If ``True``, ``sync_policy`` will default to 'mirror_complete' instead of 'additive'. | [optional] |
+| **sync_policy** | [**SyncPolicyEnum**](SyncPolicyEnum.md) | Options: 'additive', 'mirror_complete', 'mirror_content_only'. Default: 'additive'. Modifies how the sync is performed. 'mirror_complete' will clone the original metadata and create an automatic publication from it, but comes with some limitations and does not work for certain repositories. 'mirror_content_only' will change the repository contents to match the remote but the metadata will be regenerated and will not be bit-for-bit identical. 'additive' will retain the existing contents of the repository and add the contents of the repository being synced.  * `additive` - additive * `mirror_complete` - mirror_complete * `mirror_content_only` - mirror_content_only | [optional] |
+| **skip_types** | [**Array<SkipTypesEnum>**](SkipTypesEnum.md) | List of content types to skip during sync. | [optional] |
+| **optimize** | **Boolean** | Whether or not to optimize sync. | [optional][default to true] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::RpmRepositorySyncURL.new(remote: null,
-                                 mirror: null,
-                                 sync_policy: null,
-                                 skip_types: null,
-                                 optimize: null)
+instance = PulpRpmClient::RpmRepositorySyncURL.new(
+  remote: null,
+  mirror: null,
+  sync_policy: null,
+  skip_types: null,
+  optimize: null
+)
 ```
 
-

data/docs/RpmRpmAlternateContentSource.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of Alternate Content Source. | 
-**last_refreshed** | **DateTime** | Date of last refresh of AlternateContentSource. | [optional] 
-**paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional] 
-**remote** | **String** | The remote to provide alternate content source. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of Alternate Content Source. |  |
+| **last_refreshed** | **Time** | Date of last refresh of AlternateContentSource. | [optional] |
+| **paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional] |
+| **remote** | **String** | The remote to provide alternate content source. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::RpmRpmAlternateContentSource.new(name: null,
-                                 last_refreshed: null,
-                                 paths: null,
-                                 remote: null)
+instance = PulpRpmClient::RpmRpmAlternateContentSource.new(
+  name: null,
+  last_refreshed: null,
+  paths: null,
+  remote: null
+)
 ```
 
-

data/docs/RpmRpmAlternateContentSourceResponse.md

@@ -2,30 +2,31 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**prn** | **String** | The Pulp Resource Name (PRN). | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] 
-**name** | **String** | Name of Alternate Content Source. | 
-**last_refreshed** | **DateTime** | Date of last refresh of AlternateContentSource. | [optional] 
-**paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional] 
-**remote** | **String** | The remote to provide alternate content source. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
+| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
+| **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
+| **name** | **String** | Name of Alternate Content Source. |  |
+| **last_refreshed** | **Time** | Date of last refresh of AlternateContentSource. | [optional] |
+| **paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional] |
+| **remote** | **String** | The remote to provide alternate content source. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::RpmRpmAlternateContentSourceResponse.new(pulp_href: null,
-                                 prn: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 name: null,
-                                 last_refreshed: null,
-                                 paths: null,
-                                 remote: null)
+instance = PulpRpmClient::RpmRpmAlternateContentSourceResponse.new(
+  pulp_href: null,
+  prn: null,
+  pulp_created: null,
+  pulp_last_updated: null,
+  name: null,
+  last_refreshed: null,
+  paths: null,
+  remote: null
+)
 ```
 
-

data/docs/RpmRpmDistribution.md

@@ -2,30 +2,31 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | 
-**content_guard** | **String** | An optional content-guard. | [optional] 
-**hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional] [default to false]
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
-**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
-**publication** | **String** | Publication to be served | [optional] 
-**generate_repo_config** | **Boolean** | An option specifying whether Pulp should generate *.repo files. | [optional] [default to false]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |  |
+| **content_guard** | **String** | An optional content-guard. | [optional] |
+| **hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional][default to false] |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **name** | **String** | A unique name. Ex, `rawhide` and `stable`. |  |
+| **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] |
+| **publication** | **String** | Publication to be served | [optional] |
+| **generate_repo_config** | **Boolean** | An option specifying whether Pulp should generate *.repo files. | [optional][default to false] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::RpmRpmDistribution.new(base_path: null,
-                                 content_guard: null,
-                                 hidden: null,
-                                 pulp_labels: null,
-                                 name: null,
-                                 repository: null,
-                                 publication: null,
-                                 generate_repo_config: null)
+instance = PulpRpmClient::RpmRpmDistribution.new(
+  base_path: null,
+  content_guard: null,
+  hidden: null,
+  pulp_labels: null,
+  name: null,
+  repository: null,
+  publication: null,
+  generate_repo_config: null
+)
 ```
 
-

data/docs/RpmRpmDistributionResponse.md

@@ -2,42 +2,43 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**prn** | **String** | The Pulp Resource Name (PRN). | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] 
-**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | 
-**base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly] 
-**content_guard** | **String** | An optional content-guard. | [optional] 
-**no_content_change_since** | **String** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [optional] [readonly] 
-**hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional] [default to false]
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
-**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
-**publication** | **String** | Publication to be served | [optional] 
-**generate_repo_config** | **Boolean** | An option specifying whether Pulp should generate *.repo files. | [optional] [default to false]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
+| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
+| **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
+| **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |  |
+| **base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional][readonly] |
+| **content_guard** | **String** | An optional content-guard. | [optional] |
+| **no_content_change_since** | **String** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [optional][readonly] |
+| **hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional][default to false] |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **name** | **String** | A unique name. Ex, `rawhide` and `stable`. |  |
+| **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] |
+| **publication** | **String** | Publication to be served | [optional] |
+| **generate_repo_config** | **Boolean** | An option specifying whether Pulp should generate *.repo files. | [optional][default to false] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::RpmRpmDistributionResponse.new(pulp_href: null,
-                                 prn: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 base_path: null,
-                                 base_url: null,
-                                 content_guard: null,
-                                 no_content_change_since: null,
-                                 hidden: null,
-                                 pulp_labels: null,
-                                 name: null,
-                                 repository: null,
-                                 publication: null,
-                                 generate_repo_config: null)
+instance = PulpRpmClient::RpmRpmDistributionResponse.new(
+  pulp_href: null,
+  prn: null,
+  pulp_created: null,
+  pulp_last_updated: null,
+  base_path: null,
+  base_url: null,
+  content_guard: null,
+  no_content_change_since: null,
+  hidden: null,
+  pulp_labels: null,
+  name: null,
+  repository: null,
+  publication: null,
+  generate_repo_config: null
+)
 ```
 
-

data/docs/RpmRpmPublication.md

@@ -2,32 +2,33 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**repository_version** | **String** |  | [optional] 
-**repository** | **String** | A URI of the repository to be published. | [optional] 
-**checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | The preferred checksum type used during repo publishes.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] 
-**metadata_checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | DEPRECATED: The checksum type for metadata.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] 
-**package_checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | DEPRECATED: The checksum type for packages.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] 
-**gpgcheck** | **Integer** | DEPRECATED: An option specifying whether a client should perform a GPG signature check on packages. | [optional] 
-**repo_gpgcheck** | **Integer** | DEPRECATED: An option specifying whether a client should perform a GPG signature check on the repodata. | [optional] 
-**repo_config** | [**Object**](.md) | A JSON document describing config.repo file | [optional] 
-**compression_type** | [**CompressionTypeEnum**](CompressionTypeEnum.md) | The compression type to use for metadata files.  * `zstd` - zstd * `gz` - gz | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **repository_version** | **String** |  | [optional] |
+| **repository** | **String** | A URI of the repository to be published. | [optional] |
+| **checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | The preferred checksum type used during repo publishes.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] |
+| **metadata_checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | DEPRECATED: The checksum type for metadata.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] |
+| **package_checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | DEPRECATED: The checksum type for packages.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] |
+| **gpgcheck** | **Integer** | DEPRECATED: An option specifying whether a client should perform a GPG signature check on packages. | [optional] |
+| **repo_gpgcheck** | **Integer** | DEPRECATED: An option specifying whether a client should perform a GPG signature check on the repodata. | [optional] |
+| **repo_config** | **Object** | A JSON document describing config.repo file | [optional] |
+| **compression_type** | [**CompressionTypeEnum**](CompressionTypeEnum.md) | The compression type to use for metadata files.  * `zstd` - zstd * `gz` - gz | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::RpmRpmPublication.new(repository_version: null,
-                                 repository: null,
-                                 checksum_type: null,
-                                 metadata_checksum_type: null,
-                                 package_checksum_type: null,
-                                 gpgcheck: null,
-                                 repo_gpgcheck: null,
-                                 repo_config: null,
-                                 compression_type: null)
+instance = PulpRpmClient::RpmRpmPublication.new(
+  repository_version: null,
+  repository: null,
+  checksum_type: null,
+  metadata_checksum_type: null,
+  package_checksum_type: null,
+  gpgcheck: null,
+  repo_gpgcheck: null,
+  repo_config: null,
+  compression_type: null
+)
 ```
 
-

data/docs/RpmRpmPublicationResponse.md

@@ -2,42 +2,43 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**prn** | **String** | The Pulp Resource Name (PRN). | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] 
-**repository_version** | **String** |  | [optional] 
-**repository** | **String** | A URI of the repository to be published. | [optional] 
-**checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | The preferred checksum type used during repo publishes.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] 
-**metadata_checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | DEPRECATED: The checksum type for metadata.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] 
-**package_checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | DEPRECATED: The checksum type for packages.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] 
-**gpgcheck** | **Integer** | DEPRECATED: An option specifying whether a client should perform a GPG signature check on packages. | [optional] 
-**repo_gpgcheck** | **Integer** | DEPRECATED: An option specifying whether a client should perform a GPG signature check on the repodata. | [optional] 
-**sqlite_metadata** | **Boolean** | REMOVED: An option specifying whether Pulp should generate SQLite metadata. Not operation since pulp_rpm 3.25.0 release | [optional] [readonly] [default to false]
-**repo_config** | [**Object**](.md) | A JSON document describing config.repo file | [optional] 
-**compression_type** | [**CompressionTypeEnum**](CompressionTypeEnum.md) | The compression type to use for metadata files.  * `zstd` - zstd * `gz` - gz | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
+| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
+| **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
+| **repository_version** | **String** |  | [optional] |
+| **repository** | **String** | A URI of the repository to be published. | [optional] |
+| **checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | The preferred checksum type used during repo publishes.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] |
+| **metadata_checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | DEPRECATED: The checksum type for metadata.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] |
+| **package_checksum_type** | [**PackageChecksumTypeEnum**](PackageChecksumTypeEnum.md) | DEPRECATED: The checksum type for packages.  * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512 | [optional] |
+| **gpgcheck** | **Integer** | DEPRECATED: An option specifying whether a client should perform a GPG signature check on packages. | [optional] |
+| **repo_gpgcheck** | **Integer** | DEPRECATED: An option specifying whether a client should perform a GPG signature check on the repodata. | [optional] |
+| **sqlite_metadata** | **Boolean** | REMOVED: An option specifying whether Pulp should generate SQLite metadata. Not operation since pulp_rpm 3.25.0 release | [optional][readonly][default to false] |
+| **repo_config** | **Object** | A JSON document describing config.repo file | [optional] |
+| **compression_type** | [**CompressionTypeEnum**](CompressionTypeEnum.md) | The compression type to use for metadata files.  * `zstd` - zstd * `gz` - gz | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::RpmRpmPublicationResponse.new(pulp_href: null,
-                                 prn: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 repository_version: null,
-                                 repository: null,
-                                 checksum_type: null,
-                                 metadata_checksum_type: null,
-                                 package_checksum_type: null,
-                                 gpgcheck: null,
-                                 repo_gpgcheck: null,
-                                 sqlite_metadata: null,
-                                 repo_config: null,
-                                 compression_type: null)
+instance = PulpRpmClient::RpmRpmPublicationResponse.new(
+  pulp_href: null,
+  prn: null,
+  pulp_created: null,
+  pulp_last_updated: null,
+  repository_version: null,
+  repository: null,
+  checksum_type: null,
+  metadata_checksum_type: null,
+  package_checksum_type: null,
+  gpgcheck: null,
+  repo_gpgcheck: null,
+  sqlite_metadata: null,
+  repo_config: null,
+  compression_type: null
+)
 ```
 
-

data/docs/RpmRpmRemote.md

@@ -2,58 +2,59 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A unique name for this remote. | 
-**url** | **String** | The URL of an external content source. | 
-**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'. '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] 
-**sles_auth_token** | **String** | Authentication token for SLES repositories. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A unique name for this remote. |  |
+| **url** | **String** | The URL of an external content source. |  |
+| **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'. '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] |
+| **sles_auth_token** | **String** | Authentication token for SLES repositories. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::RpmRpmRemote.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,
-                                 sles_auth_token: null)
+instance = PulpRpmClient::RpmRpmRemote.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,
+  sles_auth_token: null
+)
 ```
 
-