pulpcore_client 3.2.1 → 3.3.0

data/docs/ImportersPulpApi.md

@@ -0,0 +1,355 @@
+# PulpcoreClient::ImportersPulpApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ImportersPulpApi.md#create) | **POST** /pulp/api/v3/importers/core/pulp/ | Create a pulp importer
+[**delete**](ImportersPulpApi.md#delete) | **DELETE** {pulp_importer_href} | Delete a pulp importer
+[**list**](ImportersPulpApi.md#list) | **GET** /pulp/api/v3/importers/core/pulp/ | List pulp importers
+[**partial_update**](ImportersPulpApi.md#partial_update) | **PATCH** {pulp_importer_href} | Partially update a pulp importer
+[**read**](ImportersPulpApi.md#read) | **GET** {pulp_importer_href} | Inspect a pulp importer
+[**update**](ImportersPulpApi.md#update) | **PUT** {pulp_importer_href} | Update a pulp importer
+
+
+
+## create
+
+> PulpImporter create(data)
+
+Create a pulp importer
+
+ViewSet for PulpImporters.
+
+### 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::ImportersPulpApi.new
+data = PulpcoreClient::PulpImporter.new # PulpImporter | 
+
+begin
+  #Create a pulp importer
+  result = api_instance.create(data)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**PulpImporter**](PulpImporter.md)|  | 
+
+### Return type
+
+[**PulpImporter**](PulpImporter.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> delete(pulp_importer_href)
+
+Delete a pulp importer
+
+ViewSet for PulpImporters.
+
+### 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::ImportersPulpApi.new
+pulp_importer_href = 'pulp_importer_href_example' # String | URI of Pulp Importer. e.g.: /pulp/api/v3/importers/core/pulp/1/
+
+begin
+  #Delete a pulp importer
+  api_instance.delete(pulp_importer_href)
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer_href** | **String**| URI of Pulp Importer. e.g.: /pulp/api/v3/importers/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
+
+> InlineResponse2003 list(opts)
+
+List pulp importers
+
+ViewSet for PulpImporters.
+
+### 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::ImportersPulpApi.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 importers
+  result = api_instance.list(opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->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
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> PulpImporter partial_update(pulp_importer_href, data)
+
+Partially update a pulp importer
+
+ViewSet for PulpImporters.
+
+### 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::ImportersPulpApi.new
+pulp_importer_href = 'pulp_importer_href_example' # String | URI of Pulp Importer. e.g.: /pulp/api/v3/importers/core/pulp/1/
+data = PulpcoreClient::PulpImporter.new # PulpImporter | 
+
+begin
+  #Partially update a pulp importer
+  result = api_instance.partial_update(pulp_importer_href, data)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer_href** | **String**| URI of Pulp Importer. e.g.: /pulp/api/v3/importers/core/pulp/1/ | 
+ **data** | [**PulpImporter**](PulpImporter.md)|  | 
+
+### Return type
+
+[**PulpImporter**](PulpImporter.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> PulpImporter read(pulp_importer_href, opts)
+
+Inspect a pulp importer
+
+ViewSet for PulpImporters.
+
+### 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::ImportersPulpApi.new
+pulp_importer_href = 'pulp_importer_href_example' # String | URI of Pulp Importer. e.g.: /pulp/api/v3/importers/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 importer
+  result = api_instance.read(pulp_importer_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer_href** | **String**| URI of Pulp Importer. e.g.: /pulp/api/v3/importers/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
+
+[**PulpImporter**](PulpImporter.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> PulpImporter update(pulp_importer_href, data)
+
+Update a pulp importer
+
+ViewSet for PulpImporters.
+
+### 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::ImportersPulpApi.new
+pulp_importer_href = 'pulp_importer_href_example' # String | URI of Pulp Importer. e.g.: /pulp/api/v3/importers/core/pulp/1/
+data = PulpcoreClient::PulpImporter.new # PulpImporter | 
+
+begin
+  #Update a pulp importer
+  result = api_instance.update(pulp_importer_href, data)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer_href** | **String**| URI of Pulp Importer. e.g.: /pulp/api/v3/importers/core/pulp/1/ | 
+ **data** | [**PulpImporter**](PulpImporter.md)|  | 
+
+### Return type
+
+[**PulpImporter**](PulpImporter.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/InlineResponse2001.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<SigningService>**](SigningService.md) |  | 
+**results** | [**Array<PulpExporter>**](PulpExporter.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2002.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<Task>**](Task.md) |  | 
+**results** | [**Array<PulpExport>**](PulpExport.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2003.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<Upload>**](Upload.md) |  | 
+**results** | [**Array<PulpImporter>**](PulpImporter.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2004.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<Worker>**](Worker.md) |  | 
+**results** | [**Array<Import>**](Import.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2005.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::InlineResponse2005
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<SigningService>**](SigningService.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::InlineResponse2005.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2006.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::InlineResponse2006
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<TaskGroup>**](TaskGroup.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::InlineResponse2006.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2007.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::InlineResponse2007
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Task>**](Task.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::InlineResponse2007.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2008.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::InlineResponse2008
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Upload>**](Upload.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::InlineResponse2008.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2009.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::InlineResponse2009
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Worker>**](Worker.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::InlineResponse2009.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+

data/docs/PulpExport.md

@@ -0,0 +1,29 @@
+# PulpcoreClient::PulpExport
+
+## 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. | 
+**exported_resources** | **Array<Object>** | Resources that were exported. | [optional] [readonly] 
+**params** | [**Object**](.md) | Any additional parameters that were used to create the export. | 
+**sha256** | **String** | The SHA-256 checksum of the exported .tar.gz. | [optional] 
+**filename** | **String** | The full-path filename of the exported .tar.gz. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PulpExport.new(pulp_href: null,
+                                 pulp_created: null,
+                                 task: null,
+                                 exported_resources: null,
+                                 params: null,
+                                 sha256: null,
+                                 filename: null)
+```
+
+

data/docs/PulpExporter.md

@@ -0,0 +1,27 @@
+# PulpcoreClient::PulpExporter
+
+## 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 'PulpcoreClient'
+
+instance = PulpcoreClient::PulpExporter.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 path: null,
+                                 repositories: null,
+                                 last_export: null)
+```
+
+

data/docs/PulpImport.md

@@ -0,0 +1,17 @@
+# PulpcoreClient::PulpImport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | Path to export that will be imported. | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PulpImport.new(path: null)
+```
+
+

data/docs/PulpImporter.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::PulpImporter
+
+## 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 'PulpcoreClient'
+
+instance = PulpcoreClient::PulpImporter.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 repo_mapping: null)
+```
+
+

data/docs/SigningServicesApi.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 
 ## list
 
-> InlineResponse2001 list(opts)
+> InlineResponse2005 list(opts)
 
 List signing services
 
@@ -31,6 +31,8 @@ end
 
 api_instance = PulpcoreClient::SigningServicesApi.new
 opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  name: 'name_example', # String | 
   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.
@@ -51,6 +53,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **name** | **String**|  | [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] 
@@ -58,7 +62,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2001**](InlineResponse2001.md)
+[**InlineResponse2005**](InlineResponse2005.md)
 
 ### Authorization
 

data/docs/Task.md

@@ -12,6 +12,9 @@ Name | Type | Description | Notes
 **finished_at** | **DateTime** | Timestamp of the when this task stopped execution. | [optional] [readonly] 
 **error** | **Hash<String, Object>** | A JSON Object of a fatal error encountered during the execution of this task. | [optional] [readonly] 
 **worker** | **String** | The worker associated with this task. This field is empty if a worker is not yet assigned. | [optional] [readonly] 
+**parent_task** | **String** | The parent task that spawned this task. | [optional] [readonly] 
+**child_tasks** | **Array<String>** | Any tasks spawned by this task. | [optional] [readonly] 
+**task_group** | **String** | The task group that this task is a member of. | [optional] [readonly] 
 **progress_reports** | [**Array<ProgressReport>**](ProgressReport.md) |  | [optional] [readonly] 
 **created_resources** | **Array<String>** | Resources created by this task. | [optional] [readonly] 
 **reserved_resources_record** | **Array<Object>** |  | [optional] [readonly] 
@@ -29,6 +32,9 @@ instance = PulpcoreClient::Task.new(pulp_href: null,
                                  finished_at: null,
                                  error: null,
                                  worker: null,
+                                 parent_task: null,
+                                 child_tasks: null,
+                                 task_group: null,
                                  progress_reports: null,
                                  created_resources: null,
                                  reserved_resources_record: null)