pulpcore_client 3.19.1 → 3.20.0

data/docs/ExportersApi.md

@@ -0,0 +1,362 @@
+# PulpcoreClient::ExportersApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ExportersApi.md#create) | **POST** /pulp/api/v3/exporters/ | Create an exporter
+[**delete**](ExportersApi.md#delete) | **DELETE** {exporter_href} | Delete an exporter
+[**list**](ExportersApi.md#list) | **GET** /pulp/api/v3/exporters/ | List exporters
+[**partial_update**](ExportersApi.md#partial_update) | **PATCH** {exporter_href} | Update an exporter
+[**read**](ExportersApi.md#read) | **GET** {exporter_href} | Inspect an exporter
+[**update**](ExportersApi.md#update) | **PUT** {exporter_href} | Update an exporter
+
+
+
+## create
+
+> ExporterResponse create(exporter)
+
+Create an exporter
+
+ViewSet for viewing exporters.
+
+### 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::ExportersApi.new
+exporter = PulpcoreClient::Exporter.new # Exporter | 
+
+begin
+  #Create an exporter
+  result = api_instance.create(exporter)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exporter** | [**Exporter**](Exporter.md)|  | 
+
+### Return type
+
+[**ExporterResponse**](ExporterResponse.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(exporter_href)
+
+Delete an exporter
+
+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::ExportersApi.new
+exporter_href = 'exporter_href_example' # String | 
+
+begin
+  #Delete an exporter
+  result = api_instance.delete(exporter_href)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exporter_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedExporterResponseList list(opts)
+
+List exporters
+
+ViewSet for viewing exporters.
+
+### 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::ExportersApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | 
+  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', # 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 exporters
+  result = api_instance.list(opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**|  | [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** | **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
+
+[**PaginatedExporterResponseList**](PaginatedExporterResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(exporter_href, patched_exporter)
+
+Update an exporter
+
+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::ExportersApi.new
+exporter_href = 'exporter_href_example' # String | 
+patched_exporter = PulpcoreClient::PatchedExporter.new # PatchedExporter | 
+
+begin
+  #Update an exporter
+  result = api_instance.partial_update(exporter_href, patched_exporter)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exporter_href** | **String**|  | 
+ **patched_exporter** | [**PatchedExporter**](PatchedExporter.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
+
+> ExporterResponse read(exporter_href, opts)
+
+Inspect an exporter
+
+ViewSet for viewing exporters.
+
+### 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::ExportersApi.new
+exporter_href = 'exporter_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 an exporter
+  result = api_instance.read(exporter_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exporter_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
+
+[**ExporterResponse**](ExporterResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(exporter_href, exporter)
+
+Update an exporter
+
+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::ExportersApi.new
+exporter_href = 'exporter_href_example' # String | 
+exporter = PulpcoreClient::Exporter.new # Exporter | 
+
+begin
+  #Update an exporter
+  result = api_instance.update(exporter_href, exporter)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling ExportersApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exporter_href** | **String**|  | 
+ **exporter** | [**Exporter**](Exporter.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/{GroupsModelPermissionsApi.md → ExportersExportsApi.md}

@@ -1,23 +1,23 @@
-# PulpcoreClient::GroupsModelPermissionsApi
+# PulpcoreClient::ExportersExportsApi
 
 All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](GroupsModelPermissionsApi.md#create) | **POST** {group_href}model_permissions/ | Create a permission
-[**delete**](GroupsModelPermissionsApi.md#delete) | **DELETE** {groups_model_permission_href} | Delete a permission
-[**list**](GroupsModelPermissionsApi.md#list) | **GET** {group_href}model_permissions/ | List permissions
-[**read**](GroupsModelPermissionsApi.md#read) | **GET** {groups_model_permission_href} | Inspect a permission
+[**create**](ExportersExportsApi.md#create) | **POST** {exporter_href}exports/ | Create an export
+[**delete**](ExportersExportsApi.md#delete) | **DELETE** {exporters_export_href} | Delete an export
+[**list**](ExportersExportsApi.md#list) | **GET** {exporter_href}exports/ | List exports
+[**read**](ExportersExportsApi.md#read) | **GET** {exporters_export_href} | Inspect an export
 
 
 
 ## create
 
-> PermissionResponse create(group_href, body)
+> ExportResponse create(exporter_href, export)
 
-Create a permission
+Create an export
 
-Add a model permission to a group.
+ViewSet for viewing exports from an Exporter.
 
 ### Example
 
@@ -31,16 +31,16 @@ PulpcoreClient.configure do |config|
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = PulpcoreClient::GroupsModelPermissionsApi.new
-group_href = 'group_href_example' # String | 
-body = nil # Object | 
+api_instance = PulpcoreClient::ExportersExportsApi.new
+exporter_href = 'exporter_href_example' # String | 
+export = PulpcoreClient::Export.new # Export | 
 
 begin
-  #Create a permission
-  result = api_instance.create(group_href, body)
+  #Create an export
+  result = api_instance.create(exporter_href, export)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling GroupsModelPermissionsApi->create: #{e}"
+  puts "Exception when calling ExportersExportsApi->create: #{e}"
 end
 ```
 
@@ -49,12 +49,12 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **body** | **Object**|  | 
+ **exporter_href** | **String**|  | 
+ **export** | [**Export**](Export.md)|  | 
 
 ### Return type
 
-[**PermissionResponse**](PermissionResponse.md)
+[**ExportResponse**](ExportResponse.md)
 
 ### Authorization
 
@@ -68,11 +68,11 @@ Name | Type | Description  | Notes
 
 ## delete
 
-> delete(groups_model_permission_href)
+> delete(exporters_export_href)
 
-Delete a permission
+Delete an export
 
-Remove a model permission from a group.
+ViewSet for viewing exports from an Exporter.
 
 ### Example
 
@@ -86,14 +86,14 @@ PulpcoreClient.configure do |config|
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = PulpcoreClient::GroupsModelPermissionsApi.new
-groups_model_permission_href = 'groups_model_permission_href_example' # String | 
+api_instance = PulpcoreClient::ExportersExportsApi.new
+exporters_export_href = 'exporters_export_href_example' # String | 
 
 begin
-  #Delete a permission
-  api_instance.delete(groups_model_permission_href)
+  #Delete an export
+  api_instance.delete(exporters_export_href)
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling GroupsModelPermissionsApi->delete: #{e}"
+  puts "Exception when calling ExportersExportsApi->delete: #{e}"
 end
 ```
 
@@ -102,7 +102,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **groups_model_permission_href** | **String**|  | 
+ **exporters_export_href** | **String**|  | 
 
 ### Return type
 
@@ -120,11 +120,11 @@ nil (empty response body)
 
 ## list
 
-> PaginatedPermissionResponseList list(group_href, opts)
+> PaginatedExportResponseList list(exporter_href, opts)
 
-List permissions
+List exports
 
-List group permissions.
+ViewSet for viewing exports from an Exporter.
 
 ### Example
 
@@ -138,22 +138,21 @@ PulpcoreClient.configure do |config|
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = PulpcoreClient::GroupsModelPermissionsApi.new
-group_href = 'group_href_example' # String | 
+api_instance = PulpcoreClient::ExportersExportsApi.new
+exporter_href = '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.
-  ordering: 'ordering_example', # String | Which field to use when ordering 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 permissions
-  result = api_instance.list(group_href, opts)
+  #List exports
+  result = api_instance.list(exporter_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling GroupsModelPermissionsApi->list: #{e}"
+  puts "Exception when calling ExportersExportsApi->list: #{e}"
 end
 ```
 
@@ -162,16 +161,15 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
+ **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] 
- **ordering** | **String**| Which field to use when ordering 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
 
-[**PaginatedPermissionResponseList**](PaginatedPermissionResponseList.md)
+[**PaginatedExportResponseList**](PaginatedExportResponseList.md)
 
 ### Authorization
 
@@ -185,11 +183,11 @@ Name | Type | Description  | Notes
 
 ## read
 
-> PermissionResponse read(groups_model_permission_href, opts)
+> ExportResponse read(exporters_export_href, opts)
 
-Inspect a permission
+Inspect an export
 
-Retrieve a model permission from a group.
+ViewSet for viewing exports from an Exporter.
 
 ### Example
 
@@ -203,19 +201,19 @@ PulpcoreClient.configure do |config|
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = PulpcoreClient::GroupsModelPermissionsApi.new
-groups_model_permission_href = 'groups_model_permission_href_example' # String | 
+api_instance = PulpcoreClient::ExportersExportsApi.new
+exporters_export_href = 'exporters_export_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 permission
-  result = api_instance.read(groups_model_permission_href, opts)
+  #Inspect an export
+  result = api_instance.read(exporters_export_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling GroupsModelPermissionsApi->read: #{e}"
+  puts "Exception when calling ExportersExportsApi->read: #{e}"
 end
 ```
 
@@ -224,13 +222,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **groups_model_permission_href** | **String**|  | 
+ **exporters_export_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
 
-[**PermissionResponse**](PermissionResponse.md)
+[**ExportResponse**](ExportResponse.md)
 
 ### Authorization
 

data/docs/ExportersFilesystemApi.md

@@ -148,7 +148,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
   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.
 }
@@ -174,7 +174,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] 
  **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] 
 

data/docs/ExportersFilesystemExportsApi.md

@@ -143,7 +143,6 @@ filesystem_exporter_href = 'filesystem_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.
-  ordering: 'ordering_example', # String | Which field to use when ordering 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.
 }
@@ -165,7 +164,6 @@ Name | Type | Description  | Notes
  **filesystem_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] 
- **ordering** | **String**| Which field to use when ordering 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] 
 

data/docs/ExportersPulpApi.md

@@ -148,7 +148,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
   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.
 }
@@ -174,7 +174,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] 
  **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] 
 

data/docs/ExportersPulpExportsApi.md

@@ -143,7 +143,6 @@ 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.
-  ordering: 'ordering_example', # String | Which field to use when ordering 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.
 }
@@ -165,7 +164,6 @@ 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] 
- **ordering** | **String**| Which field to use when ordering 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] 
 

data/docs/GroupRole.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **role** | **String** |  | 
-**content_object** | **String** | Optional pulp_href of the object the permissions are to be asserted on. | 
+**content_object** | **String** | pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on the model-level. | 
 
 ## Code Sample