pulp_ansible_client 0.23.1 → 0.24.0

data/docs/PaginatedansibleAnsibleNamespaceMetadataResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleAnsibleNamespaceMetadataResponse>**](AnsibleAnsibleNamespaceMetadataResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleAnsibleNamespaceMetadataResponse>**](AnsibleAnsibleNamespaceMetadataResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleAnsibleNamespaceMetadataResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleAnsibleNamespaceMetadataResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedansibleAnsibleRepositoryResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleAnsibleRepositoryResponse>**](AnsibleAnsibleRepositoryResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleAnsibleRepositoryResponse>**](AnsibleAnsibleRepositoryResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleAnsibleRepositoryResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleAnsibleRepositoryResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedansibleCollectionRemoteResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleCollectionRemoteResponse>**](AnsibleCollectionRemoteResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleCollectionRemoteResponse>**](AnsibleCollectionRemoteResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleCollectionRemoteResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleCollectionRemoteResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedansibleCollectionResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleCollectionResponse>**](AnsibleCollectionResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleCollectionResponse>**](AnsibleCollectionResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleCollectionResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleCollectionResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedansibleCollectionVersionMarkResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleCollectionVersionMarkResponse>**](AnsibleCollectionVersionMarkResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleCollectionVersionMarkResponse>**](AnsibleCollectionVersionMarkResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleCollectionVersionMarkResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleCollectionVersionMarkResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedansibleCollectionVersionResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleCollectionVersionResponse>**](AnsibleCollectionVersionResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleCollectionVersionResponse>**](AnsibleCollectionVersionResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleCollectionVersionResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleCollectionVersionResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedansibleCollectionVersionSignatureResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleCollectionVersionSignatureResponse>**](AnsibleCollectionVersionSignatureResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleCollectionVersionSignatureResponse>**](AnsibleCollectionVersionSignatureResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleCollectionVersionSignatureResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleCollectionVersionSignatureResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedansibleGitRemoteResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleGitRemoteResponse>**](AnsibleGitRemoteResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleGitRemoteResponse>**](AnsibleGitRemoteResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleGitRemoteResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleGitRemoteResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedansibleRoleRemoteResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleRoleRemoteResponse>**](AnsibleRoleRemoteResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleRoleRemoteResponse>**](AnsibleRoleRemoteResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleRoleRemoteResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleRoleRemoteResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedansibleRoleResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AnsibleRoleResponse>**](AnsibleRoleResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AnsibleRoleResponse>**](AnsibleRoleResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PaginatedansibleRoleResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpAnsibleClient::PaginatedansibleRoleResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PatchedCollection.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**deprecated** | **Boolean** |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deprecated** | **Boolean** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PatchedCollection.new(deprecated: null)
+instance = PulpAnsibleClient::PatchedCollection.new(
+  deprecated: null
+)
 ```
 
-

data/docs/PatchedansibleAnsibleDistribution.md

@@ -2,26 +2,27 @@
 
 ## 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\") | [optional] 
-**content_guard** | **String** | An optional content-guard. | [optional] 
-**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] 
-**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
-**repository_version** | **String** | RepositoryVersion to be served | [optional] 
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
+| 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\") | [optional] |
+| **content_guard** | **String** | An optional content-guard. | [optional] |
+| **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] |
+| **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] |
+| **repository_version** | **String** | RepositoryVersion to be served | [optional] |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PatchedansibleAnsibleDistribution.new(base_path: null,
-                                 content_guard: null,
-                                 name: null,
-                                 repository: null,
-                                 repository_version: null,
-                                 pulp_labels: null)
+instance = PulpAnsibleClient::PatchedansibleAnsibleDistribution.new(
+  base_path: null,
+  content_guard: null,
+  name: null,
+  repository: null,
+  repository_version: null,
+  pulp_labels: null
+)
 ```
 
-

data/docs/PatchedansibleAnsibleRepository.md

@@ -2,30 +2,31 @@
 
 ## 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] 
-**last_synced_metadata_time** | **DateTime** | Last synced metadata time. | [optional] 
-**gpgkey** | **String** | Gpg public key to verify collection signatures against | [optional] 
-**private** | **Boolean** |  | [optional] 
+| 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] |
+| **last_synced_metadata_time** | **Time** | Last synced metadata time. | [optional] |
+| **gpgkey** | **String** | Gpg public key to verify collection signatures against | [optional] |
+| **private** | **Boolean** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PatchedansibleAnsibleRepository.new(pulp_labels: null,
-                                 name: null,
-                                 description: null,
-                                 retain_repo_versions: null,
-                                 remote: null,
-                                 last_synced_metadata_time: null,
-                                 gpgkey: null,
-                                 private: null)
+instance = PulpAnsibleClient::PatchedansibleAnsibleRepository.new(
+  pulp_labels: null,
+  name: null,
+  description: null,
+  retain_repo_versions: null,
+  remote: null,
+  last_synced_metadata_time: null,
+  gpgkey: null,
+  private: null
+)
 ```
 
-

data/docs/PatchedansibleCollectionRemote.md

@@ -2,66 +2,67 @@
 
 ## 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.  * `immediate` - immediate * `When syncing, download all metadata and content now.` - When syncing, download all metadata and content now. | [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] 
-**requirements_file** | **String** | The string version of Collection requirements yaml. | [optional] 
-**auth_url** | **String** | The URL to receive a session token from, e.g. used with Automation Hub. | [optional] 
-**token** | **String** | The token key to use for authentication. See https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#configuring-the-ansible-galaxy-clientfor more details | [optional] 
-**sync_dependencies** | **Boolean** | Sync dependencies for collections specified via requirements file | [optional] [default to true]
-**signed_only** | **Boolean** | Sync only collections that have a signature | [optional] [default to false]
+| 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.  * `immediate` - When syncing, download all metadata and content now. | [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] |
+| **requirements_file** | **String** | The string version of Collection requirements yaml. | [optional] |
+| **auth_url** | **String** | The URL to receive a session token from, e.g. used with Automation Hub. | [optional] |
+| **token** | **String** | The token key to use for authentication. See https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#configuring-the-ansible-galaxy-clientfor more details | [optional] |
+| **sync_dependencies** | **Boolean** | Sync dependencies for collections specified via requirements file | [optional] |
+| **signed_only** | **Boolean** | Sync only collections that have a signature | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PatchedansibleCollectionRemote.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,
-                                 requirements_file: null,
-                                 auth_url: null,
-                                 token: null,
-                                 sync_dependencies: null,
-                                 signed_only: null)
+instance = PulpAnsibleClient::PatchedansibleCollectionRemote.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,
+  requirements_file: null,
+  auth_url: null,
+  token: null,
+  sync_dependencies: null,
+  signed_only: null
+)
 ```
 
-