pulpcore_client 3.2.1 → 3.3.0

data/docs/ExportersPulpApi.md

@@ -0,0 +1,355 @@
+# PulpcoreClient::ExportersPulpApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ExportersPulpApi.md#create) | **POST** /pulp/api/v3/exporters/core/pulp/ | Create a pulp exporter
+[**delete**](ExportersPulpApi.md#delete) | **DELETE** {pulp_exporter_href} | Delete a pulp exporter
+[**list**](ExportersPulpApi.md#list) | **GET** /pulp/api/v3/exporters/core/pulp/ | List pulp exporters
+[**partial_update**](ExportersPulpApi.md#partial_update) | **PATCH** {pulp_exporter_href} | Partially update a pulp exporter
+[**read**](ExportersPulpApi.md#read) | **GET** {pulp_exporter_href} | Inspect a pulp exporter
+[**update**](ExportersPulpApi.md#update) | **PUT** {pulp_exporter_href} | Update a pulp exporter
+
+
+
+## create
+
+> PulpExporter create(data)
+
+Create a pulp exporter
+
+ViewSet for viewing PulpExporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ExportersPulpApi.new
+data = PulpcoreClient::PulpExporter.new # PulpExporter | 
+
+begin
+  #Create a pulp exporter
+  result = api_instance.create(data)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**PulpExporter**](PulpExporter.md)|  | 
+
+### Return type
+
+[**PulpExporter**](PulpExporter.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> delete(pulp_exporter_href)
+
+Delete a pulp exporter
+
+ViewSet for viewing PulpExporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ExportersPulpApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | URI of Pulp Exporter. e.g.: /pulp/api/v3/exporters/core/pulp/1/
+
+begin
+  #Delete a pulp exporter
+  api_instance.delete(pulp_exporter_href)
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**| URI of Pulp Exporter. e.g.: /pulp/api/v3/exporters/core/pulp/1/ | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse2001 list(opts)
+
+List pulp exporters
+
+ViewSet for viewing PulpExporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ExportersPulpApi.new
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  name: 'name_example', # String | 
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  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', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List pulp exporters
+  result = api_instance.list(opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **name** | **String**|  | [optional] 
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> PulpExporter partial_update(pulp_exporter_href, data)
+
+Partially update a pulp exporter
+
+ViewSet for viewing PulpExporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ExportersPulpApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | URI of Pulp Exporter. e.g.: /pulp/api/v3/exporters/core/pulp/1/
+data = PulpcoreClient::PulpExporter.new # PulpExporter | 
+
+begin
+  #Partially update a pulp exporter
+  result = api_instance.partial_update(pulp_exporter_href, data)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**| URI of Pulp Exporter. e.g.: /pulp/api/v3/exporters/core/pulp/1/ | 
+ **data** | [**PulpExporter**](PulpExporter.md)|  | 
+
+### Return type
+
+[**PulpExporter**](PulpExporter.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> PulpExporter read(pulp_exporter_href, opts)
+
+Inspect a pulp exporter
+
+ViewSet for viewing PulpExporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ExportersPulpApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | URI of Pulp Exporter. e.g.: /pulp/api/v3/exporters/core/pulp/1/
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a pulp exporter
+  result = api_instance.read(pulp_exporter_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**| URI of Pulp Exporter. e.g.: /pulp/api/v3/exporters/core/pulp/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PulpExporter**](PulpExporter.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> PulpExporter update(pulp_exporter_href, data)
+
+Update a pulp exporter
+
+ViewSet for viewing PulpExporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ExportersPulpApi.new
+pulp_exporter_href = 'pulp_exporter_href_example' # String | URI of Pulp Exporter. e.g.: /pulp/api/v3/exporters/core/pulp/1/
+data = PulpcoreClient::PulpExporter.new # PulpExporter | 
+
+begin
+  #Update a pulp exporter
+  result = api_instance.update(pulp_exporter_href, data)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersPulpApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_exporter_href** | **String**| URI of Pulp Exporter. e.g.: /pulp/api/v3/exporters/core/pulp/1/ | 
+ **data** | [**PulpExporter**](PulpExporter.md)|  | 
+
+### Return type
+
+[**PulpExporter**](PulpExporter.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Import.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::Import
+
+## 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 Import. | 
+**params** | [**Object**](.md) | Any parameters that were used to create the import. | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::Import.new(pulp_href: null,
+                                 pulp_created: null,
+                                 task: null,
+                                 params: null)
+```
+
+

data/docs/ImportersCoreImportsApi.md

@@ -0,0 +1,243 @@
+# PulpcoreClient::ImportersCoreImportsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ImportersCoreImportsApi.md#create) | **POST** /pulp/api/v3/importers/core/pulp/{importer_pk}/imports/ | Create a pulp import
+[**delete**](ImportersCoreImportsApi.md#delete) | **DELETE** {pulp_import_href} | Delete a pulp import
+[**list**](ImportersCoreImportsApi.md#list) | **GET** /pulp/api/v3/importers/core/pulp/{importer_pk}/imports/ | List pulp imports
+[**read**](ImportersCoreImportsApi.md#read) | **GET** {pulp_import_href} | Inspect a pulp import
+
+
+
+## create
+
+> AsyncOperationResponse create(importer_pk, data)
+
+Create a pulp import
+
+Trigger an asynchronous task to import a Pulp export.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ImportersCoreImportsApi.new
+importer_pk = 'importer_pk_example' # String | 
+data = PulpcoreClient::PulpImport.new # PulpImport | 
+
+begin
+  #Create a pulp import
+  result = api_instance.create(importer_pk, data)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersCoreImportsApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **importer_pk** | **String**|  | 
+ **data** | [**PulpImport**](PulpImport.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> delete(pulp_import_href)
+
+Delete a pulp import
+
+ViewSet for PulpImports.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ImportersCoreImportsApi.new
+pulp_import_href = 'pulp_import_href_example' # String | URI of Pulp Import. e.g.: /pulp/api/v3/importers/core/pulp/1/imports/1/
+
+begin
+  #Delete a pulp import
+  api_instance.delete(pulp_import_href)
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersCoreImportsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_import_href** | **String**| URI of Pulp Import. e.g.: /pulp/api/v3/importers/core/pulp/1/imports/1/ | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse2004 list(importer_pk, opts)
+
+List pulp imports
+
+ViewSet for PulpImports.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ImportersCoreImportsApi.new
+importer_pk = 'importer_pk_example' # String | 
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  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', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List pulp imports
+  result = api_instance.list(importer_pk, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersCoreImportsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **importer_pk** | **String**|  | 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> Import read(pulp_import_href, opts)
+
+Inspect a pulp import
+
+ViewSet for PulpImports.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::ImportersCoreImportsApi.new
+pulp_import_href = 'pulp_import_href_example' # String | URI of Pulp Import. e.g.: /pulp/api/v3/importers/core/pulp/1/imports/1/
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a pulp import
+  result = api_instance.read(pulp_import_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersCoreImportsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_import_href** | **String**| URI of Pulp Import. e.g.: /pulp/api/v3/importers/core/pulp/1/imports/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**Import**](Import.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+