pulp_container_client 2.14.13 → 2.14.14

data/docs/PaginatedRoleResponseList.md

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,23 @@
+# PulpContainerClient::PatchedAccessPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permissions_assignment** | **Array<Object>** | List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead. | [optional] 
+**creation_hooks** | **Array<Object>** | List of callables that may associate user roles for new objects. | [optional] 
+**statements** | **Array<Object>** | List of policy statements defining the policy. | [optional] 
+**queryset_scoping** | [**Object**](.md) | A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedAccessPolicy.new(permissions_assignment: null,
+                                 creation_hooks: null,
+                                 statements: null,
+                                 queryset_scoping: null)
+```
+
+

data/docs/PatchedContentRedirectContentGuard.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::PatchedContentRedirectContentGuard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The unique name. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedContentRedirectContentGuard.new(name: null,
+                                 description: null)
+```
+
+

data/docs/PatchedDomain.md

@@ -0,0 +1,27 @@
+# PulpContainerClient::PatchedDomain
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A name for this domain. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain.  * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage | [optional] 
+**storage_settings** | [**Object**](.md) | Settings for storage class. | [optional] 
+**redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional] [default to true]
+**hide_guarded_distributions** | **Boolean** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedDomain.new(name: null,
+                                 description: null,
+                                 storage_class: null,
+                                 storage_settings: null,
+                                 redirect_to_object_storage: null,
+                                 hide_guarded_distributions: null)
+```
+
+

data/docs/PatchedFilesystemExporter.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::PatchedFilesystemExporter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the file system exporter. | [optional] 
+**path** | **String** | File system location to export to. | [optional] 
+**method** | [**MethodEnum**](MethodEnum.md) | Method of exporting  * `write` - Export by writing * `hardlink` - Export by hardlinking * `symlink` - Export by symlinking | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedFilesystemExporter.new(name: null,
+                                 path: null,
+                                 method: null)
+```
+
+

data/docs/PatchedGroup.md

@@ -0,0 +1,17 @@
+# PulpContainerClient::PatchedGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedGroup.new(name: null)
+```
+
+

data/docs/PatchedPulpExporter.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PatchedPulpExporter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the file system exporter. | [optional] 
+**path** | **String** | File system directory to store exported tar.gzs. | [optional] 
+**repositories** | **Array<String>** |  | [optional] 
+**last_export** | **String** | Last attempted export for this PulpExporter | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedPulpExporter.new(name: null,
+                                 path: null,
+                                 repositories: null,
+                                 last_export: null)
+```
+
+

data/docs/PatchedPulpImporter.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::PatchedPulpImporter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the Importer. | [optional] 
+**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 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedPulpImporter.new(name: null,
+                                 repo_mapping: null)
+```
+
+

data/docs/PatchedRBACContentGuard.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::PatchedRBACContentGuard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The unique name. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedRBACContentGuard.new(name: null,
+                                 description: null)
+```
+
+

data/docs/PatchedRole.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::PatchedRole
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this role. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+**permissions** | **Array<String>** | List of permissions defining the role. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedRole.new(name: null,
+                                 description: null,
+                                 permissions: null)
+```
+
+

data/docs/PatchedTaskCancel.md

@@ -0,0 +1,17 @@
+# PulpContainerClient::PatchedTaskCancel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**state** | **String** | The desired state of the task. Only 'canceled' is accepted. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedTaskCancel.new(state: null)
+```
+
+

data/docs/PatchedUpstreamPulp.md

@@ -0,0 +1,37 @@
+# PulpContainerClient::PatchedUpstreamPulp
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A unique name for this Pulp server. | [optional] 
+**base_url** | **String** | The transport, hostname, and an optional port of the Pulp server. e.g. https://example.com | [optional] 
+**api_root** | **String** | The API root. Defaults to '/pulp/'. | [optional] 
+**domain** | **String** | The domain of the Pulp server if enabled. | [optional] 
+**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
+**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] 
+**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
+**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
+**username** | **String** | The username to be used for authentication when syncing. | [optional] 
+**password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
+**pulp_label_select** | **String** | One or more comma separated labels that will be used to filter distributions on the upstream Pulp. E.g. \"foo=bar,key=val\" or \"foo,key\" | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedUpstreamPulp.new(name: null,
+                                 base_url: null,
+                                 api_root: null,
+                                 domain: null,
+                                 ca_cert: null,
+                                 client_cert: null,
+                                 client_key: null,
+                                 tls_validation: null,
+                                 username: null,
+                                 password: null,
+                                 pulp_label_select: null)
+```
+
+

data/docs/PatchedUser.md

@@ -0,0 +1,29 @@
+# PulpContainerClient::PatchedUser
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. | [optional] 
+**password** | **String** | Users password. Set to ``null`` to disable password authentication. | [optional] 
+**first_name** | **String** | First name | [optional] 
+**last_name** | **String** | Last name | [optional] 
+**email** | **String** | Email address | [optional] 
+**is_staff** | **Boolean** | Designates whether the user can log into this admin site. | [optional] [default to false]
+**is_active** | **Boolean** | Designates whether this user should be treated as active. | [optional] [default to true]
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PatchedUser.new(username: null,
+                                 password: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 email: null,
+                                 is_staff: null,
+                                 is_active: null)
+```
+
+

data/docs/PatchedcontainerContainerPushRepository.md

@@ -4,22 +4,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] 
 **description** | **String** | An optional description. | [optional] 
+**retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] 
+**manifest_signing_service** | **String** | A reference to an associated signing service. | [optional] 
 **name** | **String** | A unique name for this repository. | [optional] 
 **pulp_labels** | **Hash<String, String>** |  | [optional] 
-**manifest_signing_service** | **String** | A reference to an associated signing service. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpContainerClient'
 
-instance = PulpContainerClient::PatchedcontainerContainerPushRepository.new(retain_repo_versions: null,
-                                 description: null,
+instance = PulpContainerClient::PatchedcontainerContainerPushRepository.new(description: null,
+                                 retain_repo_versions: null,
+                                 manifest_signing_service: null,
                                  name: null,
-                                 pulp_labels: null,
-                                 manifest_signing_service: null)
+                                 pulp_labels: null)
 ```
 
 

data/docs/PatchedcontainerContainerRemote.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **pulp_labels** | **Hash<String, String>** |  | [optional] 
 **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
 **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] 
-**policy** | [**PolicyEnum**](PolicyEnum.md) |          immediate - All manifests and blobs are downloaded and saved during a sync.         on_demand - Only tags and manifests are downloaded. Blobs are not                     downloaded until they are requested for the first time by a client.         streamed - Blobs are streamed to the client with every request and never saved.           * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] 
+**policy** | [**Policy762Enum**](Policy762Enum.md) |          immediate - All manifests and blobs are downloaded and saved during a sync.         on_demand - Only tags and manifests are downloaded. Blobs are not                     downloaded until they are requested for the first time by a client.         streamed - Blobs are streamed to the client with every request and never saved.           * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] 
 **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
 **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 

data/docs/Policy762Enum.md

@@ -0,0 +1,16 @@
+# PulpContainerClient::Policy762Enum
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::Policy762Enum.new()
+```
+
+

data/docs/ProgressReportResponse.md

@@ -0,0 +1,27 @@
+# PulpContainerClient::ProgressReportResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | The message shown to the user for the progress report. | [optional] [readonly] 
+**code** | **String** | Identifies the type of progress report'. | [optional] [readonly] 
+**state** | **String** | The current state of the progress report. The possible values are: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. The default is 'waiting'. | [optional] [readonly] 
+**total** | **Integer** | The total count of items. | [optional] [readonly] 
+**done** | **Integer** | The count of items already processed. Defaults to 0. | [optional] [readonly] 
+**suffix** | **String** | The suffix to be shown with the progress report. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::ProgressReportResponse.new(message: null,
+                                 code: null,
+                                 state: null,
+                                 total: null,
+                                 done: null,
+                                 suffix: null)
+```
+
+

data/docs/PublicationResponse.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::PublicationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**repository_version** | **String** |  | [optional] 
+**repository** | **String** | A URI of the repository to be published. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::PublicationResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 repository_version: null,
+                                 repository: null)
+```
+
+