pulp_container_client 2.20.2 → 2.21.0

data/docs/LivezApi.md

@@ -0,0 +1,51 @@
+# PulpContainerClient::LivezApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**livez_read**](LivezApi.md#livez_read) | **GET** /pulp/api/v3/livez/ | Inspect liveness of Pulp's REST API.
+
+
+
+## livez_read
+
+> livez_read
+
+Inspect liveness of Pulp's REST API.
+
+Returns 200 OK when API is alive.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+
+api_instance = PulpContainerClient::LivezApi.new
+
+begin
+  #Inspect liveness of Pulp's REST API.
+  api_instance.livez_read
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling LivezApi->livez_read: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/{Policy762Enum.md → MethodEnum.md}

@@ -1,4 +1,4 @@
-# PulpContainerClient::Policy762Enum
+# PulpContainerClient::MethodEnum
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpContainerClient'
 
-instance = PulpContainerClient::Policy762Enum.new()
+instance = PulpContainerClient::MethodEnum.new()
 ```
 
 

data/docs/MinimalTaskResponse.md

@@ -0,0 +1,33 @@
+# PulpContainerClient::MinimalTaskResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] 
+**name** | **String** | The name of task. | 
+**state** | **String** | The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. | [optional] [readonly] 
+**unblocked_at** | **DateTime** | Timestamp of when this task was identified ready for pickup. | [optional] [readonly] 
+**started_at** | **DateTime** | Timestamp of when this task started execution. | [optional] [readonly] 
+**finished_at** | **DateTime** | Timestamp of when this task stopped execution. | [optional] [readonly] 
+**worker** | **String** | The worker associated with this task. This field is empty if a worker is not yet assigned. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::MinimalTaskResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 pulp_last_updated: null,
+                                 name: null,
+                                 state: null,
+                                 unblocked_at: null,
+                                 started_at: null,
+                                 finished_at: null,
+                                 worker: null)
+```
+
+

data/docs/MultipleArtifactContentResponse.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::MultipleArtifactContentResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [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,
+                                 pulp_last_updated: null,
+                                 artifacts: null)
+```
+
+

data/docs/OCIBuildImage.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **containerfile_artifact** | **String** | Artifact representing the Containerfile that should be used to run podman-build. | [optional] 
 **containerfile** | **File** | An uploaded Containerfile that should be used to run podman-build. | [optional] 
 **tag** | **String** | A tag name for the new image being built. | [optional] [default to 'latest']
-**artifacts** | [**Object**](.md) | A JSON string where each key is an artifact href and the value is it's relative path (name) inside the /pulp_working_directory of the build container executing the Containerfile. | [optional] 
+**artifacts** | [**AnyType**](.md) | A JSON string where each key is an artifact href and the value is it's relative path (name) inside the /pulp_working_directory of the build container executing the Containerfile. | [optional] 
 
 ## Code Sample
 

data/docs/OrphansApi.md

@@ -0,0 +1,58 @@
+# PulpContainerClient::OrphansApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**orphans_delete**](OrphansApi.md#orphans_delete) | **DELETE** /pulp/api/v3/orphans/ | Delete orphans
+
+
+
+## orphans_delete
+
+> AsyncOperationResponse orphans_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.orphans_delete
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling OrphansApi->orphans_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 *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**orphans_cleanup_cleanup**](OrphansCleanupApi.md#orphans_cleanup_cleanup) | **POST** /pulp/api/v3/orphans/cleanup/ | 
+
+
+
+## orphans_cleanup_cleanup
+
+> AsyncOperationResponse orphans_cleanup_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.orphans_cleanup_cleanup(orphans_cleanup)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling OrphansCleanupApi->orphans_cleanup_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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<AccessPolicyResponse>**](AccessPolicyResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ArtifactDistributionResponse>**](ArtifactDistributionResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ArtifactResponse>**](ArtifactResponse.md) |  | 
+
+## 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/PaginatedCompositeContentGuardResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedCompositeContentGuardResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<CompositeContentGuardResponse>**](CompositeContentGuardResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedCompositeContentGuardResponseList.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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ContentGuardResponse>**](ContentGuardResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ContentRedirectContentGuardResponse>**](ContentRedirectContentGuardResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<DistributionResponse>**](DistributionResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<DomainResponse>**](DomainResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<FilesystemExportResponse>**](FilesystemExportResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<FilesystemExporterResponse>**](FilesystemExporterResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<GroupResponse>**](GroupResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<GroupRoleResponse>**](GroupRoleResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<GroupUserResponse>**](GroupUserResponse.md) |  | 
+
+## 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/PaginatedHeaderContentGuardResponseList.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PaginatedHeaderContentGuardResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<HeaderContentGuardResponse>**](HeaderContentGuardResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PaginatedHeaderContentGuardResponseList.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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ImportResponse>**](ImportResponse.md) |  | 
+
+## 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** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<MultipleArtifactContentResponse>**](MultipleArtifactContentResponse.md) |  | 
+
+## 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)
+```
+
+