pulp_container_client 2.14.13 → 2.14.14

data/docs/MultipleArtifactContentResponse.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::MultipleArtifactContentResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**artifacts** | [**Object**](.md) | A dict mapping relative paths inside the Content to the correspondingArtifact URLs. E.g.: {'relative/path': '/artifacts/1/' | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::MultipleArtifactContentResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 artifacts: null)
+```
+
+

data/docs/OrphansApi.md

@@ -0,0 +1,58 @@
+# PulpContainerClient::OrphansApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete**](OrphansApi.md#delete) | **DELETE** /pulp/api/v3/orphans/ | Delete orphans
+
+
+
+## delete
+
+> AsyncOperationResponse delete
+
+Delete orphans
+
+DEPRECATED! Trigger an asynchronous task that deletes all orphaned content and artifacts. Use the `POST /pulp/api/v3/orphans/cleanup/` call instead.
+
+### 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::OrphansApi.new
+
+begin
+  #Delete orphans
+  result = api_instance.delete
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling OrphansApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/OrphansCleanup.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::OrphansCleanup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content_hrefs** | [**Array<AnyType>**](AnyType.md) | Will delete specified content and associated Artifacts if they are orphans. | [optional] 
+**orphan_protection_time** | **Integer** | The time in minutes for how long Pulp will hold orphan Content and Artifacts before they become candidates for deletion by this orphan cleanup task. This should ideally be longer than your longest running task otherwise any content created during that task could be cleaned up before the task finishes. If not specified, a default value is taken from the setting ORPHAN_PROTECTION_TIME. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::OrphansCleanup.new(content_hrefs: null,
+                                 orphan_protection_time: null)
+```
+
+

data/docs/OrphansCleanupApi.md

@@ -0,0 +1,61 @@
+# PulpContainerClient::OrphansCleanupApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cleanup**](OrphansCleanupApi.md#cleanup) | **POST** /pulp/api/v3/orphans/cleanup/ | 
+
+
+
+## cleanup
+
+> AsyncOperationResponse cleanup(orphans_cleanup)
+
+
+
+Trigger an asynchronous orphan cleanup operation.
+
+### 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::OrphansCleanupApi.new
+orphans_cleanup = PulpContainerClient::OrphansCleanup.new # OrphansCleanup | 
+
+begin
+  result = api_instance.cleanup(orphans_cleanup)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling OrphansCleanupApi->cleanup: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **orphans_cleanup** | [**OrphansCleanup**](OrphansCleanup.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/PaginatedAccessPolicyResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedAccessPolicyResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<AccessPolicyResponse>**](AccessPolicyResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedAccessPolicyResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedArtifactDistributionResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedArtifactDistributionResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ArtifactDistributionResponse>**](ArtifactDistributionResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedArtifactDistributionResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedArtifactResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedArtifactResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ArtifactResponse>**](ArtifactResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedArtifactResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedContentGuardResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedContentGuardResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ContentGuardResponse>**](ContentGuardResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedContentGuardResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedContentRedirectContentGuardResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedContentRedirectContentGuardResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ContentRedirectContentGuardResponse>**](ContentRedirectContentGuardResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedContentRedirectContentGuardResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedDistributionResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedDistributionResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<DistributionResponse>**](DistributionResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedDistributionResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedDomainResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedDomainResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<DomainResponse>**](DomainResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedDomainResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedFilesystemExportResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedFilesystemExportResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<FilesystemExportResponse>**](FilesystemExportResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedFilesystemExportResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedFilesystemExporterResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedFilesystemExporterResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<FilesystemExporterResponse>**](FilesystemExporterResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedFilesystemExporterResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedGroupResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedGroupResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<GroupResponse>**](GroupResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedGroupResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedGroupRoleResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedGroupRoleResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<GroupRoleResponse>**](GroupRoleResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedGroupRoleResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedGroupUserResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedGroupUserResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<GroupUserResponse>**](GroupUserResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedGroupUserResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedImportResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedImportResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ImportResponse>**](ImportResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedImportResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedMultipleArtifactContentResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedMultipleArtifactContentResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<MultipleArtifactContentResponse>**](MultipleArtifactContentResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedMultipleArtifactContentResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedPublicationResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedPublicationResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<PublicationResponse>**](PublicationResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedPublicationResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedPulpExportResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedPulpExportResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<PulpExportResponse>**](PulpExportResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedPulpExportResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedPulpExporterResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedPulpExporterResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<PulpExporterResponse>**](PulpExporterResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedPulpExporterResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedPulpImporterResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedPulpImporterResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<PulpImporterResponse>**](PulpImporterResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedPulpImporterResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedRBACContentGuardResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedRBACContentGuardResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<RBACContentGuardResponse>**](RBACContentGuardResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedRBACContentGuardResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedRemoteResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedRemoteResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<RemoteResponse>**](RemoteResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedRemoteResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedRepositoryResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedRepositoryResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<RepositoryResponse>**](RepositoryResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedRepositoryResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+