pulp_container_client 2.14.15 → 2.14.16

data/docs/ExportersPulpApi.md

@@ -0,0 +1,362 @@
+# PulpContainerClient::ExportersPulpApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**exporters_core_pulp_create**](ExportersPulpApi.md#exporters_core_pulp_create) | **POST** /pulp/api/v3/exporters/core/pulp/ | Create a pulp exporter
+[**exporters_core_pulp_delete**](ExportersPulpApi.md#exporters_core_pulp_delete) | **DELETE** {pulp_exporter_href} | Delete a pulp exporter
+[**exporters_core_pulp_list**](ExportersPulpApi.md#exporters_core_pulp_list) | **GET** /pulp/api/v3/exporters/core/pulp/ | List pulp exporters
+[**exporters_core_pulp_partial_update**](ExportersPulpApi.md#exporters_core_pulp_partial_update) | **PATCH** {pulp_exporter_href} | Update a pulp exporter
+[**exporters_core_pulp_read**](ExportersPulpApi.md#exporters_core_pulp_read) | **GET** {pulp_exporter_href} | Inspect a pulp exporter
+[**exporters_core_pulp_update**](ExportersPulpApi.md#exporters_core_pulp_update) | **PUT** {pulp_exporter_href} | Update a pulp exporter
+
+
+
+## exporters_core_pulp_create
+
+> PulpExporterResponse exporters_core_pulp_create(pulp_exporter)
+
+Create a pulp exporter
+
+ViewSet for viewing PulpExporters.
+
+### 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::ExportersPulpApi.new
+pulp_exporter = PulpContainerClient::PulpExporter.new # PulpExporter | 
+
+begin
+  #Create a pulp exporter
+  result = api_instance.exporters_core_pulp_create(pulp_exporter)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->exporters_core_pulp_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter** | [**PulpExporter**](PulpExporter.md)|  | 
+
+### Return type
+
+[**PulpExporterResponse**](PulpExporterResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## exporters_core_pulp_delete
+
+> AsyncOperationResponse exporters_core_pulp_delete(pulp_exporter_href)
+
+Delete a pulp exporter
+
+Trigger an asynchronous delete task
+
+### 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::ExportersPulpApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | 
+
+begin
+  #Delete a pulp exporter
+  result = api_instance.exporters_core_pulp_delete(pulp_exporter_href)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->exporters_core_pulp_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## exporters_core_pulp_list
+
+> PaginatedPulpExporterResponseList exporters_core_pulp_list(opts)
+
+List pulp exporters
+
+ViewSet for viewing PulpExporters.
+
+### 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::ExportersPulpApi.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
+  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 pulp exporters
+  result = api_instance.exporters_core_pulp_list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->exporters_core_pulp_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 | [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
+
+[**PaginatedPulpExporterResponseList**](PaginatedPulpExporterResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## exporters_core_pulp_partial_update
+
+> AsyncOperationResponse exporters_core_pulp_partial_update(pulp_exporter_href, patched_pulp_exporter)
+
+Update a pulp exporter
+
+Trigger an asynchronous partial update task
+
+### 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::ExportersPulpApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | 
+patched_pulp_exporter = PulpContainerClient::PatchedPulpExporter.new # PatchedPulpExporter | 
+
+begin
+  #Update a pulp exporter
+  result = api_instance.exporters_core_pulp_partial_update(pulp_exporter_href, patched_pulp_exporter)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->exporters_core_pulp_partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**|  | 
+ **patched_pulp_exporter** | [**PatchedPulpExporter**](PatchedPulpExporter.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## exporters_core_pulp_read
+
+> PulpExporterResponse exporters_core_pulp_read(pulp_exporter_href, opts)
+
+Inspect a pulp exporter
+
+ViewSet for viewing PulpExporters.
+
+### 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::ExportersPulpApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | 
+opts = {
+  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
+  #Inspect a pulp exporter
+  result = api_instance.exporters_core_pulp_read(pulp_exporter_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->exporters_core_pulp_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**|  | 
+ **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
+
+[**PulpExporterResponse**](PulpExporterResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## exporters_core_pulp_update
+
+> AsyncOperationResponse exporters_core_pulp_update(pulp_exporter_href, pulp_exporter)
+
+Update a pulp exporter
+
+Trigger an asynchronous update task
+
+### 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::ExportersPulpApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | 
+pulp_exporter = PulpContainerClient::PulpExporter.new # PulpExporter | 
+
+begin
+  #Update a pulp exporter
+  result = api_instance.exporters_core_pulp_update(pulp_exporter_href, pulp_exporter)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->exporters_core_pulp_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**|  | 
+ **pulp_exporter** | [**PulpExporter**](PulpExporter.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/ExportersPulpExportsApi.md

@@ -0,0 +1,241 @@
+# PulpContainerClient::ExportersPulpExportsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**exporters_core_pulp_exports_create**](ExportersPulpExportsApi.md#exporters_core_pulp_exports_create) | **POST** {pulp_exporter_href}exports/ | Create a pulp export
+[**exporters_core_pulp_exports_delete**](ExportersPulpExportsApi.md#exporters_core_pulp_exports_delete) | **DELETE** {pulp_pulp_export_href} | Delete a pulp export
+[**exporters_core_pulp_exports_list**](ExportersPulpExportsApi.md#exporters_core_pulp_exports_list) | **GET** {pulp_exporter_href}exports/ | List pulp exports
+[**exporters_core_pulp_exports_read**](ExportersPulpExportsApi.md#exporters_core_pulp_exports_read) | **GET** {pulp_pulp_export_href} | Inspect a pulp export
+
+
+
+## exporters_core_pulp_exports_create
+
+> AsyncOperationResponse exporters_core_pulp_exports_create(pulp_exporter_href, pulp_export)
+
+Create a pulp export
+
+Trigger an asynchronous task to export a set of repositories
+
+### 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::ExportersPulpExportsApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | 
+pulp_export = PulpContainerClient::PulpExport.new # PulpExport | 
+
+begin
+  #Create a pulp export
+  result = api_instance.exporters_core_pulp_exports_create(pulp_exporter_href, pulp_export)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpExportsApi->exporters_core_pulp_exports_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**|  | 
+ **pulp_export** | [**PulpExport**](PulpExport.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## exporters_core_pulp_exports_delete
+
+> exporters_core_pulp_exports_delete(pulp_pulp_export_href)
+
+Delete a pulp export
+
+ViewSet for viewing exports from a PulpExporter.
+
+### 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::ExportersPulpExportsApi.new
+pulp_pulp_export_href = 'pulp_pulp_export_href_example' # String | 
+
+begin
+  #Delete a pulp export
+  api_instance.exporters_core_pulp_exports_delete(pulp_pulp_export_href)
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpExportsApi->exporters_core_pulp_exports_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_pulp_export_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## exporters_core_pulp_exports_list
+
+> PaginatedPulpExportResponseList exporters_core_pulp_exports_list(pulp_exporter_href, opts)
+
+List pulp exports
+
+ViewSet for viewing exports from a PulpExporter.
+
+### 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::ExportersPulpExportsApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | 
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  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 pulp exports
+  result = api_instance.exporters_core_pulp_exports_list(pulp_exporter_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpExportsApi->exporters_core_pulp_exports_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**|  | 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [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
+
+[**PaginatedPulpExportResponseList**](PaginatedPulpExportResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## exporters_core_pulp_exports_read
+
+> PulpExportResponse exporters_core_pulp_exports_read(pulp_pulp_export_href, opts)
+
+Inspect a pulp export
+
+ViewSet for viewing exports from a PulpExporter.
+
+### 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::ExportersPulpExportsApi.new
+pulp_pulp_export_href = 'pulp_pulp_export_href_example' # String | 
+opts = {
+  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
+  #Inspect a pulp export
+  result = api_instance.exporters_core_pulp_exports_read(pulp_pulp_export_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ExportersPulpExportsApi->exporters_core_pulp_exports_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_pulp_export_href** | **String**|  | 
+ **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
+
+[**PulpExportResponse**](PulpExportResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/FilesystemExport.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::FilesystemExport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task** | **String** | A URI of the task that ran the Export. | [optional] 
+**publication** | **String** | A URI of the publication to be exported. | [optional] 
+**repository_version** | **String** | A URI of the repository version export. | [optional] 
+**start_repository_version** | **String** | The URI of the last-exported-repo-version. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::FilesystemExport.new(task: null,
+                                 publication: null,
+                                 repository_version: null,
+                                 start_repository_version: null)
+```
+
+

data/docs/FilesystemExportResponse.md

@@ -0,0 +1,25 @@
+# PulpContainerClient::FilesystemExportResponse
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::FilesystemExportResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 task: null,
+                                 exported_resources: null,
+                                 params: null)
+```
+
+

data/docs/FilesystemExporter.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::FilesystemExporter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the file system exporter. | 
+**path** | **String** | File system location to export to. | 
+**method** | [**MethodEnum**](MethodEnum.md) | Method of exporting | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::FilesystemExporter.new(name: null,
+                                 path: null,
+                                 method: null)
+```
+
+

data/docs/FilesystemExporterResponse.md

@@ -0,0 +1,25 @@
+# PulpContainerClient::FilesystemExporterResponse
+
+## 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 location to export to. | 
+**method** | [**MethodEnum**](MethodEnum.md) | Method of exporting | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::FilesystemExporterResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 path: null,
+                                 method: null)
+```
+
+