pulp_file_client 3.55.0 → 3.55.2

data/docs/SigningServicesApi.md

@@ -0,0 +1,140 @@
+# PulpFileClient::SigningServicesApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**signing_services_list**](SigningServicesApi.md#signing_services_list) | **GET** /pulp/api/v3/signing-services/ | List signing services
+[**signing_services_read**](SigningServicesApi.md#signing_services_read) | **GET** {signing_service_href} | Inspect a signing service
+
+
+
+## signing_services_list
+
+> PaginatedSigningServiceResponseList signing_services_list(opts)
+
+List signing services
+
+A ViewSet that supports browsing of existing signing services.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::SigningServicesApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | Filter results where name matches value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `name` - Name * `-name` - Name (descending) * `public_key` - Public key * `-public_key` - Public key (descending) * `pubkey_fingerprint` - Pubkey fingerprint * `-pubkey_fingerprint` - Pubkey fingerprint (descending) * `script` - Script * `-script` - Script (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  q: 'q_example', # String | 
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List signing services
+  result = api_instance.signing_services_list(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling SigningServicesApi->signing_services_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;public_key&#x60; - Public key * &#x60;-public_key&#x60; - Public key (descending) * &#x60;pubkey_fingerprint&#x60; - Pubkey fingerprint * &#x60;-pubkey_fingerprint&#x60; - Pubkey fingerprint (descending) * &#x60;script&#x60; - Script * &#x60;-script&#x60; - Script (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
+ **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **q** | **String**|  | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedSigningServiceResponseList**](PaginatedSigningServiceResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## signing_services_read
+
+> SigningServiceResponse signing_services_read(signing_service_href, opts)
+
+Inspect a signing service
+
+A ViewSet that supports browsing of existing signing services.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::SigningServicesApi.new
+signing_service_href = 'signing_service_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a signing service
+  result = api_instance.signing_services_read(signing_service_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling SigningServicesApi->signing_services_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **signing_service_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**SigningServiceResponse**](SigningServiceResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/StatesEnum.md

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

data/docs/StatusApi.md

@@ -0,0 +1,52 @@
+# PulpFileClient::StatusApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**status_read**](StatusApi.md#status_read) | **GET** /pulp/api/v3/status/ | Inspect status of Pulp
+
+
+
+## status_read
+
+> StatusResponse status_read
+
+Inspect status of Pulp
+
+Returns status and app information about Pulp.  Information includes:  * version of pulpcore and loaded pulp plugins  * known workers  * known content apps  * database connection status  * redis connection status  * disk usage information
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+
+api_instance = PulpFileClient::StatusApi.new
+
+begin
+  #Inspect status of Pulp
+  result = api_instance.status_read
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling StatusApi->status_read: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**StatusResponse**](StatusResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/StatusResponse.md

@@ -0,0 +1,33 @@
+# PulpFileClient::StatusResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**versions** | [**Array<VersionResponse>**](VersionResponse.md) | Version information of Pulp components | 
+**online_workers** | [**Array<WorkerResponse>**](WorkerResponse.md) | List of online workers known to the application. An online worker is actively heartbeating and can respond to new work. | 
+**online_api_apps** | [**Array<ApiAppStatusResponse>**](ApiAppStatusResponse.md) | List of online api apps known to the application. An online api app is actively heartbeating and can serve the rest api to clients. | 
+**online_content_apps** | [**Array<ContentAppStatusResponse>**](ContentAppStatusResponse.md) | List of online content apps known to the application. An online content app is actively heartbeating and can serve data to clients. | 
+**database_connection** | [**DatabaseConnectionResponse**](DatabaseConnectionResponse.md) | Database connection information | 
+**redis_connection** | [**RedisConnectionResponse**](RedisConnectionResponse.md) | Redis connection information | [optional] 
+**storage** | [**StorageResponse**](StorageResponse.md) | Storage information | [optional] 
+**content_settings** | [**ContentSettingsResponse**](ContentSettingsResponse.md) | Content-app settings | 
+**domain_enabled** | **Boolean** | Is Domains enabled | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::StatusResponse.new(versions: null,
+                                 online_workers: null,
+                                 online_api_apps: null,
+                                 online_content_apps: null,
+                                 database_connection: null,
+                                 redis_connection: null,
+                                 storage: null,
+                                 content_settings: null,
+                                 domain_enabled: null)
+```
+
+

data/docs/StorageClassEnum.md

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

data/docs/StorageResponse.md

@@ -0,0 +1,21 @@
+# PulpFileClient::StorageResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | Total number of bytes | 
+**used** | **Integer** | Number of bytes in use | 
+**free** | **Integer** | Number of free bytes | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::StorageResponse.new(total: null,
+                                 used: null,
+                                 free: null)
+```
+
+

data/docs/TaskGroupResponse.md

@@ -0,0 +1,39 @@
+# PulpFileClient::TaskGroupResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**description** | **String** | A description of the task group. | 
+**all_tasks_dispatched** | **Boolean** | Whether all tasks have been spawned for this task group. | 
+**waiting** | **Integer** | Number of tasks in the 'waiting' state | [optional] [readonly] 
+**skipped** | **Integer** | Number of tasks in the 'skipped' state | [optional] [readonly] 
+**running** | **Integer** | Number of tasks in the 'running' state | [optional] [readonly] 
+**completed** | **Integer** | Number of tasks in the 'completed' state | [optional] [readonly] 
+**canceled** | **Integer** | Number of tasks in the 'canceled' state | [optional] [readonly] 
+**failed** | **Integer** | Number of tasks in the 'failed' state | [optional] [readonly] 
+**canceling** | **Integer** | Number of tasks in the 'canceling' state | [optional] [readonly] 
+**group_progress_reports** | [**Array<GroupProgressReportResponse>**](GroupProgressReportResponse.md) |  | [optional] [readonly] 
+**tasks** | [**Array<MinimalTaskResponse>**](MinimalTaskResponse.md) |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::TaskGroupResponse.new(pulp_href: null,
+                                 description: null,
+                                 all_tasks_dispatched: null,
+                                 waiting: null,
+                                 skipped: null,
+                                 running: null,
+                                 completed: null,
+                                 canceled: null,
+                                 failed: null,
+                                 canceling: null,
+                                 group_progress_reports: null,
+                                 tasks: null)
+```
+
+

data/docs/TaskGroupsApi.md

@@ -0,0 +1,130 @@
+# PulpFileClient::TaskGroupsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**task_groups_list**](TaskGroupsApi.md#task_groups_list) | **GET** /pulp/api/v3/task-groups/ | List task groups
+[**task_groups_read**](TaskGroupsApi.md#task_groups_read) | **GET** {task_group_href} | Inspect a task group
+
+
+
+## task_groups_list
+
+> PaginatedTaskGroupResponseList task_groups_list(opts)
+
+List task groups
+
+A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'     endpoint_name (str): The name of the final path segment that should identify the ViewSet's         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object's         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::TaskGroupsApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List task groups
+  result = api_instance.task_groups_list(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling TaskGroupsApi->task_groups_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedTaskGroupResponseList**](PaginatedTaskGroupResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## task_groups_read
+
+> TaskGroupResponse task_groups_read(task_group_href, opts)
+
+Inspect a task group
+
+A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'     endpoint_name (str): The name of the final path segment that should identify the ViewSet's         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object's         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::TaskGroupsApi.new
+task_group_href = 'task_group_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a task group
+  result = api_instance.task_groups_read(task_group_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling TaskGroupsApi->task_groups_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_group_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**TaskGroupResponse**](TaskGroupResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TaskResponse.md

@@ -0,0 +1,51 @@
+# PulpFileClient::TaskResponse
+
+## 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] 
+**state** | **String** | The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. | [optional] [readonly] 
+**name** | **String** | The name of task. | 
+**logging_cid** | **String** | The logging correlation id associated with this task | 
+**created_by** | **String** | User who dispatched this task. | [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] 
+**error** | [**Hash<String, AnyType>**](AnyType.md) | A JSON Object of a fatal error encountered during the execution of this task. | [optional] [readonly] 
+**worker** | **String** | The worker associated with this task. This field is empty if a worker is not yet assigned. | [optional] [readonly] 
+**parent_task** | **String** | The parent task that spawned this task. | [optional] [readonly] 
+**child_tasks** | **Array<String>** | Any tasks spawned by this task. | [optional] [readonly] 
+**task_group** | **String** | The task group that this task is a member of. | [optional] [readonly] 
+**progress_reports** | [**Array<ProgressReportResponse>**](ProgressReportResponse.md) |  | [optional] [readonly] 
+**created_resources** | **Array<String>** | Resources created by this task. | [optional] [readonly] 
+**reserved_resources_record** | **Array<String>** | A list of resources required by that task. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::TaskResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 pulp_last_updated: null,
+                                 state: null,
+                                 name: null,
+                                 logging_cid: null,
+                                 created_by: null,
+                                 unblocked_at: null,
+                                 started_at: null,
+                                 finished_at: null,
+                                 error: null,
+                                 worker: null,
+                                 parent_task: null,
+                                 child_tasks: null,
+                                 task_group: null,
+                                 progress_reports: null,
+                                 created_resources: null,
+                                 reserved_resources_record: null)
+```
+
+

data/docs/TaskScheduleResponse.md

@@ -0,0 +1,31 @@
+# PulpFileClient::TaskScheduleResponse
+
+## 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 the task schedule. | 
+**task_name** | **String** | The name of the task to be scheduled. | 
+**dispatch_interval** | **String** | Periodicity of the schedule. | 
+**next_dispatch** | **DateTime** | Timestamp of the next time the task will be dispatched. | [optional] [readonly] 
+**last_task** | **String** | The last task dispatched by this schedule. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::TaskScheduleResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 pulp_last_updated: null,
+                                 name: null,
+                                 task_name: null,
+                                 dispatch_interval: null,
+                                 next_dispatch: null,
+                                 last_task: null)
+```
+
+