pulp_ostree_client 2.4.0 → 2.4.2

data/docs/PatchedCompositeContentGuard.md

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

data/docs/PatchedContentRedirectContentGuard.md

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

data/docs/PatchedDomain.md

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

data/docs/PatchedGroup.md

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

data/docs/PatchedHeaderContentGuard.md

@@ -0,0 +1,25 @@
+# PulpOstreeClient::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 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedHeaderContentGuard.new(name: null,
+                                 description: null,
+                                 header_name: null,
+                                 header_value: null,
+                                 jq_filter: null)
+```
+
+

data/docs/PatchedPulpExporter.md

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

data/docs/PatchedPulpImporter.md

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

data/docs/PatchedRBACContentGuard.md

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

data/docs/PatchedRole.md

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

data/docs/PatchedTaskCancel.md

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

data/docs/PatchedUpstreamPulp.md

@@ -0,0 +1,37 @@
+# PulpOstreeClient::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 'PulpOstreeClient'
+
+instance = PulpOstreeClient::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 @@
+# PulpOstreeClient::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 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedUser.new(username: null,
+                                 password: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 email: null,
+                                 is_staff: null,
+                                 is_active: null)
+```
+
+

data/docs/PatchedcertguardRHSMCertGuard.md

@@ -0,0 +1,21 @@
+# PulpOstreeClient::PatchedcertguardRHSMCertGuard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The unique name. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+**ca_certificate** | **String** | A Certificate Authority (CA) certificate (or a bundle thereof) used to verify client-certificate authenticity. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedcertguardRHSMCertGuard.new(name: null,
+                                 description: null,
+                                 ca_certificate: null)
+```
+
+

data/docs/PatchedcertguardX509CertGuard.md

@@ -0,0 +1,21 @@
+# PulpOstreeClient::PatchedcertguardX509CertGuard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The unique name. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+**ca_certificate** | **String** | A Certificate Authority (CA) certificate (or a bundle thereof) used to verify client-certificate authenticity. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedcertguardX509CertGuard.new(name: null,
+                                 description: null,
+                                 ca_certificate: null)
+```
+
+

data/docs/PatchedfileFileAlternateContentSource.md

@@ -0,0 +1,23 @@
+# PulpOstreeClient::PatchedfileFileAlternateContentSource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of Alternate Content Source. | [optional] 
+**last_refreshed** | **DateTime** | Date of last refresh of AlternateContentSource. | [optional] 
+**paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional] 
+**remote** | **String** | The remote to provide alternate content source. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedfileFileAlternateContentSource.new(name: null,
+                                 last_refreshed: null,
+                                 paths: null,
+                                 remote: null)
+```
+
+

data/docs/PatchedfileFileDistribution.md

@@ -0,0 +1,29 @@
+# PulpOstreeClient::PatchedfileFileDistribution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | [optional] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional] [default to false]
+**pulp_labels** | **Hash<String, String>** |  | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] 
+**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
+**publication** | **String** | Publication to be served | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedfileFileDistribution.new(base_path: null,
+                                 content_guard: null,
+                                 hidden: null,
+                                 pulp_labels: null,
+                                 name: null,
+                                 repository: null,
+                                 publication: null)
+```
+
+

data/docs/PatchedfileFileRemote.md

@@ -0,0 +1,57 @@
+# PulpOstreeClient::PatchedfileFileRemote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A unique name for this remote. | [optional] 
+**url** | **String** | The URL of an external content source. | [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] 
+**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
+**proxy_username** | **String** | The username to authenticte to the proxy. | [optional] 
+**proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [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_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** | [**Policy692Enum**](Policy692Enum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default.  * `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] 
+**sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
+**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] 
+**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedfileFileRemote.new(name: null,
+                                 url: null,
+                                 ca_cert: null,
+                                 client_cert: null,
+                                 client_key: null,
+                                 tls_validation: null,
+                                 proxy_url: null,
+                                 proxy_username: null,
+                                 proxy_password: null,
+                                 username: null,
+                                 password: null,
+                                 pulp_labels: null,
+                                 download_concurrency: null,
+                                 max_retries: null,
+                                 policy: null,
+                                 total_timeout: null,
+                                 connect_timeout: null,
+                                 sock_connect_timeout: null,
+                                 sock_read_timeout: null,
+                                 headers: null,
+                                 rate_limit: null)
+```
+
+

data/docs/PatchedfileFileRepository.md

@@ -0,0 +1,29 @@
+# PulpOstreeClient::PatchedfileFileRepository
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_labels** | **Hash<String, String>** |  | [optional] 
+**name** | **String** | A unique name for this repository. | [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] 
+**remote** | **String** | An optional remote to use by default when syncing. | [optional] 
+**autopublish** | **Boolean** | Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository. | [optional] [default to false]
+**manifest** | **String** | Filename to use for manifest file containing metadata for all the files. | [optional] [default to 'PULP_MANIFEST']
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedfileFileRepository.new(pulp_labels: null,
+                                 name: null,
+                                 description: null,
+                                 retain_repo_versions: null,
+                                 remote: null,
+                                 autopublish: null,
+                                 manifest: null)
+```
+
+

data/docs/PatchedostreeOstreeRemote.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 OSTree objects are downloaded and saved during synchronization.         on_demand - Only commits, dirtrees, and refs are downloaded. Other OSTree objects are                     not downloaded until they are requested for the first time by a client.           * `immediate` - immediate * `on_demand` - on_demand | [optional] 
+**policy** | [**PolicyBfeEnum**](PolicyBfeEnum.md) |          immediate - All OSTree objects are downloaded and saved during synchronization.         on_demand - Only commits, dirtrees, and refs are downloaded. Other OSTree objects are                     not downloaded until they are requested for the first time by a client.           * `immediate` - immediate * `on_demand` - on_demand | [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/Policy692Enum.md

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

data/docs/PolicyBfeEnum.md

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

data/docs/ProgressReportResponse.md

@@ -0,0 +1,27 @@
+# PulpOstreeClient::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 'PulpOstreeClient'
+
+instance = PulpOstreeClient::ProgressReportResponse.new(message: null,
+                                 code: null,
+                                 state: null,
+                                 total: null,
+                                 done: null,
+                                 suffix: null)
+```
+
+

data/docs/PublicationResponse.md

@@ -0,0 +1,25 @@
+# PulpOstreeClient::PublicationResponse
+
+## 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] 
+**repository_version** | **String** |  | [optional] 
+**repository** | **String** | A URI of the repository to be published. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PublicationResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 pulp_last_updated: null,
+                                 repository_version: null,
+                                 repository: null)
+```
+
+