pulp_container_client 2.14.12 → 2.14.14

data/docs/PublicationResponse.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PublicationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**repository_version** | **String** |  | [optional] 
+**repository** | **String** | A URI of the repository to be published. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PublicationResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 repository_version: null,
+                                 repository: null)
+```
+
+

data/docs/PublicationsApi.md

@@ -0,0 +1,98 @@
+# PulpContainerClient::PublicationsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](PublicationsApi.md#list) | **GET** /pulp/api/v3/publications/ | List publications
+
+
+
+## list
+
+> PaginatedPublicationResponseList list(opts)
+
+List publications
+
+A base class for any publication viewset.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::PublicationsApi.new
+opts = {
+  content: 'content_example', # String | Content Unit referenced by HREF
+  content__in: 'content__in_example', # String | Content Unit referenced by HREF
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created matches value
+  pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
+  pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
+  pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
+  pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
+  pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
+  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_type__in: ['pulp_type__in_example'], # Array<String> | Pulp type is in
+  repository: 'repository_example', # String | Repository referenced by HREF
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List publications
+  result = api_instance.list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling PublicationsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content** | **String**| Content Unit referenced by HREF | [optional] 
+ **content__in** | **String**| Content Unit referenced by HREF | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;pass_through&#x60; - Pass through * &#x60;-pass_through&#x60; - Pass through (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
+ **pulp_created** | **DateTime**| Filter results where pulp_created matches value | [optional] 
+ **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional] 
+ **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional] 
+ **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional] 
+ **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional] 
+ **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional] 
+ **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **pulp_type__in** | [**Array&lt;String&gt;**](String.md)| Pulp type is in | [optional] 
+ **repository** | **String**| Repository referenced by HREF | [optional] 
+ **repository_version** | [**String**](.md)| Repository Version referenced by HREF | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedPublicationResponseList**](PaginatedPublicationResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PulpExport.md

@@ -0,0 +1,27 @@
+# PulpContainerClient::PulpExport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task** | **String** | A URI of the task that ran the Export. | [optional] 
+**full** | **Boolean** | Do a Full (true) or Incremental (false) export. | [optional] [default to true]
+**dry_run** | **Boolean** | Generate report on what would be exported and disk-space required. | [optional] [default to false]
+**versions** | **Array<String>** | List of explicit repo-version hrefs to export (replaces current_version). | [optional] 
+**chunk_size** | **String** | Chunk export-tarfile into pieces of chunk_size bytes. Recognizes units of B/KB/MB/GB/TB. A chunk has a maximum size of 1TB. | [optional] 
+**start_versions** | **Array<String>** | List of explicit last-exported-repo-version hrefs (replaces last_export). | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PulpExport.new(task: null,
+                                 full: null,
+                                 dry_run: null,
+                                 versions: null,
+                                 chunk_size: null,
+                                 start_versions: null)
+```
+
+

data/docs/PulpExportResponse.md

@@ -0,0 +1,29 @@
+# PulpContainerClient::PulpExportResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**task** | **String** | A URI of the task that ran the Export. | [optional] 
+**exported_resources** | **Array<String>** | Resources that were exported. | [optional] [readonly] 
+**params** | [**Object**](.md) | Any additional parameters that were used to create the export. | [optional] [readonly] 
+**output_file_info** | [**Object**](.md) | Dictionary of filename: sha256hash entries for export-output-file(s) | [optional] [readonly] 
+**toc_info** | [**Object**](.md) | Filename and sha256-checksum of table-of-contents for this export | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PulpExportResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 task: null,
+                                 exported_resources: null,
+                                 params: null,
+                                 output_file_info: null,
+                                 toc_info: null)
+```
+
+

data/docs/PulpExporter.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PulpExporter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the file system exporter. | 
+**path** | **String** | File system directory to store exported tar.gzs. | 
+**repositories** | **Array<String>** |  | 
+**last_export** | **String** | Last attempted export for this PulpExporter | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PulpExporter.new(name: null,
+                                 path: null,
+                                 repositories: null,
+                                 last_export: null)
+```
+
+

data/docs/PulpExporterResponse.md

@@ -0,0 +1,27 @@
+# PulpContainerClient::PulpExporterResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | Unique name of the file system exporter. | 
+**path** | **String** | File system directory to store exported tar.gzs. | 
+**repositories** | **Array<String>** |  | 
+**last_export** | **String** | Last attempted export for this PulpExporter | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PulpExporterResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 path: null,
+                                 repositories: null,
+                                 last_export: null)
+```
+
+

data/docs/PulpImport.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::PulpImport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | Path to export that will be imported. | [optional] 
+**toc** | **String** | Path to a table-of-contents file describing chunks to be validated, reassembled, and imported. | [optional] 
+**create_repositories** | **Boolean** | If True, missing repositories will be automatically created during the import. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PulpImport.new(path: null,
+                                 toc: null,
+                                 create_repositories: null)
+```
+
+

data/docs/PulpImportCheck.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::PulpImportCheck
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | Path to export-tar-gz that will be imported. | [optional] 
+**toc** | **String** | Path to a table-of-contents file describing chunks to be validated, reassembled, and imported. | [optional] 
+**repo_mapping** | **String** | Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be \"{'foo': 'bar'}\". | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PulpImportCheck.new(path: null,
+                                 toc: null,
+                                 repo_mapping: null)
+```
+
+

data/docs/PulpImportCheckResponse.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::PulpImportCheckResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**toc** | [**EvaluationResponse**](EvaluationResponse.md) | Evaluation of proposed 'toc' file for PulpImport | [optional] 
+**path** | [**EvaluationResponse**](EvaluationResponse.md) | Evaluation of proposed 'path' file for PulpImport | [optional] 
+**repo_mapping** | [**EvaluationResponse**](EvaluationResponse.md) | Evaluation of proposed 'repo_mapping' file for PulpImport | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PulpImportCheckResponse.new(toc: null,
+                                 path: null,
+                                 repo_mapping: null)
+```
+
+

data/docs/PulpImporter.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::PulpImporter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the Importer. | 
+**repo_mapping** | **Hash<String, String>** | Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be \"{'foo': 'bar'}\". | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PulpImporter.new(name: null,
+                                 repo_mapping: null)
+```
+
+

data/docs/PulpImporterResponse.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PulpImporterResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | Unique name of the Importer. | 
+**repo_mapping** | **Hash<String, String>** | Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be \"{'foo': 'bar'}\". | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PulpImporterResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 repo_mapping: null)
+```
+
+

data/docs/Purge.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::Purge
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**finished_before** | **DateTime** | Purge tasks completed earlier than this timestamp. Format '%Y-%m-%d[T%H:%M:%S]' | [optional] 
+**states** | [**Array<StatesEnum>**](StatesEnum.md) | List of task-states to be purged. Only 'final' states are allowed. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::Purge.new(finished_before: null,
+                                 states: null)
+```
+
+

data/docs/RBACContentGuard.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::RBACContentGuard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The unique name. | 
+**description** | **String** | An optional description. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::RBACContentGuard.new(name: null,
+                                 description: null)
+```
+
+

data/docs/RBACContentGuardResponse.md

@@ -0,0 +1,27 @@
+# PulpContainerClient::RBACContentGuardResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | The unique name. | 
+**description** | **String** | An optional description. | [optional] 
+**users** | [**Array<GroupUserResponse>**](GroupUserResponse.md) |  | [optional] [readonly] 
+**groups** | [**Array<GroupResponse>**](GroupResponse.md) |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::RBACContentGuardResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 description: null,
+                                 users: null,
+                                 groups: null)
+```
+
+

data/docs/ReclaimSpace.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::ReclaimSpace
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**repo_hrefs** | [**Array<AnyType>**](AnyType.md) | Will reclaim space for the specified list of repos. Use ['*'] to specify all repos. | 
+**repo_versions_keeplist** | **Array<String>** | Will exclude repo versions from space reclaim. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::ReclaimSpace.new(repo_hrefs: null,
+                                 repo_versions_keeplist: null)
+```
+
+

data/docs/RedisConnectionResponse.md

@@ -0,0 +1,17 @@
+# PulpContainerClient::RedisConnectionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connected** | **Boolean** | Info about whether the app can connect to Redis | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::RedisConnectionResponse.new(connected: null)
+```
+
+

data/docs/RemoteResponse.md

@@ -0,0 +1,55 @@
+# PulpContainerClient::RemoteResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**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] 
+**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
+**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
+**pulp_labels** | **Hash<String, String>** |  | [optional] 
+**pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly] 
+**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** | [**RemoteResponsePolicyEnum**](RemoteResponsePolicyEnum.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] 
+**hidden_fields** | [**Array<RemoteResponseHiddenFields>**](RemoteResponseHiddenFields.md) | List of hidden (write only) fields | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::RemoteResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 url: null,
+                                 ca_cert: null,
+                                 client_cert: null,
+                                 tls_validation: null,
+                                 proxy_url: null,
+                                 pulp_labels: null,
+                                 pulp_last_updated: 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,
+                                 hidden_fields: null)
+```
+
+

data/docs/{ContainerContainerRemoteResponseHiddenFields.md → RemoteResponseHiddenFields.md}

@@ -1,4 +1,4 @@
-# PulpContainerClient::ContainerContainerRemoteResponseHiddenFields
+# PulpContainerClient::RemoteResponseHiddenFields
 
 ## Properties
 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpContainerClient'
 
-instance = PulpContainerClient::ContainerContainerRemoteResponseHiddenFields.new(name: null,
+instance = PulpContainerClient::RemoteResponseHiddenFields.new(name: null,
                                  is_set: null)
 ```
 

data/docs/RemoteResponsePolicyEnum.md

@@ -0,0 +1,16 @@
+# PulpContainerClient::RemoteResponsePolicyEnum
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::RemoteResponsePolicyEnum.new()
+```
+
+

data/docs/RemotesApi.md

@@ -0,0 +1,102 @@
+# PulpContainerClient::RemotesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](RemotesApi.md#list) | **GET** /pulp/api/v3/remotes/ | List remotes
+
+
+
+## list
+
+> PaginatedRemoteResponseList list(opts)
+
+List remotes
+
+A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'     endpoint_name (str): The name of the final path segment that should identify the ViewSet's         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object's         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::RemotesApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | Filter results where name matches value
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
+  pulp_last_updated: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated matches value
+  pulp_last_updated__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than value
+  pulp_last_updated__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than or equal to value
+  pulp_last_updated__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than value
+  pulp_last_updated__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than or equal to value
+  pulp_last_updated__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_last_updated is between two comma separated values
+  pulp_type__in: ['pulp_type__in_example'], # Array<String> | Pulp type is in  * `container.container` - container.container
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List remotes
+  result = api_instance.list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling RemotesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__startswith** | **String**| Filter results where name starts with value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
+ **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **pulp_label_select** | **String**| Filter labels by search string | [optional] 
+ **pulp_last_updated** | **DateTime**| Filter results where pulp_last_updated matches value | [optional] 
+ **pulp_last_updated__gt** | **DateTime**| Filter results where pulp_last_updated is greater than value | [optional] 
+ **pulp_last_updated__gte** | **DateTime**| Filter results where pulp_last_updated is greater than or equal to value | [optional] 
+ **pulp_last_updated__lt** | **DateTime**| Filter results where pulp_last_updated is less than value | [optional] 
+ **pulp_last_updated__lte** | **DateTime**| Filter results where pulp_last_updated is less than or equal to value | [optional] 
+ **pulp_last_updated__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional] 
+ **pulp_type__in** | [**Array&lt;String&gt;**](String.md)| Pulp type is in  * &#x60;container.container&#x60; - container.container | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedRemoteResponseList**](PaginatedRemoteResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+