pulpcore_client 3.19.1 → 3.20.0

data/docs/DistributionsApi.md

@@ -4,17 +4,128 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**create**](DistributionsApi.md#create) | **POST** /pulp/api/v3/distributions/ | Create a distribution
+[**delete**](DistributionsApi.md#delete) | **DELETE** {distribution_href} | Delete a distribution
 [**list**](DistributionsApi.md#list) | **GET** /pulp/api/v3/distributions/ | List distributions
+[**partial_update**](DistributionsApi.md#partial_update) | **PATCH** {distribution_href} | Update a distribution
+[**read**](DistributionsApi.md#read) | **GET** {distribution_href} | Inspect a distribution
+[**update**](DistributionsApi.md#update) | **PUT** {distribution_href} | Update a distribution
 
 
 
+## create
+
+> AsyncOperationResponse create(distribution)
+
+Create a distribution
+
+Trigger an asynchronous create task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::DistributionsApi.new
+distribution = PulpcoreClient::Distribution.new # Distribution | 
+
+begin
+  #Create a distribution
+  result = api_instance.create(distribution)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DistributionsApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distribution** | [**Distribution**](Distribution.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
+
+
+## delete
+
+> AsyncOperationResponse delete(distribution_href)
+
+Delete a distribution
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::DistributionsApi.new
+distribution_href = 'distribution_href_example' # String | 
+
+begin
+  #Delete a distribution
+  result = api_instance.delete(distribution_href)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DistributionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distribution_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list
 
 > PaginatedDistributionResponseList list(opts)
 
 List distributions
 
-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.
+Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.
 
 ### Example
 
@@ -41,7 +152,7 @@ opts = {
   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', # String | Which field to use when ordering the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering
   pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
   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.
@@ -72,7 +183,7 @@ Name | Type | Description  | Notes
  **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** | **String**| Which field to use when ordering the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
  **pulp_label_select** | **String**| Filter labels by search string | [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] 
@@ -90,3 +201,172 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## partial_update
+
+> AsyncOperationResponse partial_update(distribution_href, patched_distribution)
+
+Update a distribution
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::DistributionsApi.new
+distribution_href = 'distribution_href_example' # String | 
+patched_distribution = PulpcoreClient::PatchedDistribution.new # PatchedDistribution | 
+
+begin
+  #Update a distribution
+  result = api_instance.partial_update(distribution_href, patched_distribution)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DistributionsApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distribution_href** | **String**|  | 
+ **patched_distribution** | [**PatchedDistribution**](PatchedDistribution.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
+
+
+## read
+
+> DistributionResponse read(distribution_href, opts)
+
+Inspect a distribution
+
+Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::DistributionsApi.new
+distribution_href = 'distribution_href_example' # String | 
+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 distribution
+  result = api_instance.read(distribution_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DistributionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distribution_href** | **String**|  | 
+ **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
+
+[**DistributionResponse**](DistributionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(distribution_href, distribution)
+
+Update a distribution
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::DistributionsApi.new
+distribution_href = 'distribution_href_example' # String | 
+distribution = PulpcoreClient::Distribution.new # Distribution | 
+
+begin
+  #Update a distribution
+  result = api_instance.update(distribution_href, distribution)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling DistributionsApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distribution_href** | **String**|  | 
+ **distribution** | [**Distribution**](Distribution.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/Export.md

@@ -0,0 +1,17 @@
+# PulpcoreClient::Export
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task** | **String** | A URI of the task that ran the Export. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::Export.new(task: null)
+```
+
+

data/docs/ExportResponse.md

@@ -0,0 +1,25 @@
+# PulpcoreClient::ExportResponse
+
+## 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 'PulpcoreClient'
+
+instance = PulpcoreClient::ExportResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 task: null,
+                                 exported_resources: null,
+                                 params: null)
+```
+
+

data/docs/Exporter.md

@@ -0,0 +1,17 @@
+# PulpcoreClient::Exporter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the file system exporter. | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::Exporter.new(name: null)
+```
+
+

data/docs/ExporterResponse.md

@@ -0,0 +1,21 @@
+# PulpcoreClient::ExporterResponse
+
+## 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. | 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::ExporterResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null)
+```
+
+