pulp_file_client 3.49.12 → 3.49.14

data/docs/PaginatedPulpImporterResponseList.md

@@ -0,0 +1,23 @@
+# PulpFileClient::PaginatedPulpImporterResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<PulpImporterResponse>**](PulpImporterResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedRBACContentGuardResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<RBACContentGuardResponse>**](RBACContentGuardResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedRemoteResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<RemoteResponse>**](RemoteResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedRepositoryResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<RepositoryResponse>**](RepositoryResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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)
+```
+
+

data/docs/PaginatedRoleResponseList.md

@@ -0,0 +1,23 @@
+# PulpFileClient::PaginatedRoleResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<RoleResponse>**](RoleResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedSigningServiceResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<SigningServiceResponse>**](SigningServiceResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedTaskGroupResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<TaskGroupResponse>**](TaskGroupResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedTaskResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<TaskResponse>**](TaskResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedTaskScheduleResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<TaskScheduleResponse>**](TaskScheduleResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedUploadResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<UploadResponse>**](UploadResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedUpstreamPulpResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<UpstreamPulpResponse>**](UpstreamPulpResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedUserResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<UserResponse>**](UserResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedUserRoleResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<UserRoleResponse>**](UserRoleResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::PaginatedWorkerResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<WorkerResponse>**](WorkerResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::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/PaginatedcertguardRHSMCertGuardResponseList.md

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

@@ -0,0 +1,23 @@
+# PulpFileClient::PaginatedcertguardX509CertGuardResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<CertguardX509CertGuardResponse>**](CertguardX509CertGuardResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::PaginatedcertguardX509CertGuardResponseList.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 @@
+# PulpFileClient::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 'PulpFileClient'
+
+instance = PulpFileClient::PatchedAccessPolicy.new(permissions_assignment: null,
+                                 creation_hooks: null,
+                                 statements: null,
+                                 queryset_scoping: null)
+```
+
+

data/docs/PatchedCompositeContentGuard.md

@@ -0,0 +1,21 @@
+# PulpFileClient::PatchedCompositeContentGuard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The unique name. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+**guards** | **Array<String>** | List of ContentGuards to ask for access-permission. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::PatchedCompositeContentGuard.new(name: null,
+                                 description: null,
+                                 guards: null)
+```
+
+

data/docs/PatchedContentRedirectContentGuard.md

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

data/docs/PatchedDomain.md

@@ -0,0 +1,27 @@
+# PulpFileClient::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 'PulpFileClient'
+
+instance = PulpFileClient::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 @@
+# PulpFileClient::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 'PulpFileClient'
+
+instance = PulpFileClient::PatchedFilesystemExporter.new(name: null,
+                                 path: null,
+                                 method: null)
+```
+
+

data/docs/PatchedGroup.md

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

data/docs/PatchedHeaderContentGuard.md

@@ -0,0 +1,25 @@
+# PulpFileClient::PatchedHeaderContentGuard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The unique name. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+**header_name** | **String** | The header name the guard will check on. | [optional] 
+**header_value** | **String** | The value that will authorize the request. | [optional] 
+**jq_filter** | **String** | A JQ syntax compatible filter. If jq_filter is not set, then the value willonly be Base64 decoded and checked as an explicit string match. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::PatchedHeaderContentGuard.new(name: null,
+                                 description: null,
+                                 header_name: null,
+                                 header_value: null,
+                                 jq_filter: null)
+```
+
+

data/docs/PatchedPulpExporter.md

@@ -0,0 +1,23 @@
+# PulpFileClient::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 'PulpFileClient'
+
+instance = PulpFileClient::PatchedPulpExporter.new(name: null,
+                                 path: null,
+                                 repositories: null,
+                                 last_export: null)
+```
+
+

data/docs/PatchedPulpImporter.md

@@ -0,0 +1,19 @@
+# PulpFileClient::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 'PulpFileClient'
+
+instance = PulpFileClient::PatchedPulpImporter.new(name: null,
+                                 repo_mapping: null)
+```
+
+

data/docs/PatchedRBACContentGuard.md

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

data/docs/PatchedRole.md

@@ -0,0 +1,21 @@
+# PulpFileClient::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 'PulpFileClient'
+
+instance = PulpFileClient::PatchedRole.new(name: null,
+                                 description: null,
+                                 permissions: null)
+```
+
+

data/docs/PatchedTaskCancel.md

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