pulp_rpm_client 3.18.21 → 3.19.0.dev1675307375

data/docs/TaskGroupResponse.md

@@ -1,39 +0,0 @@
-# PulpRpmClient::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 'PulpRpmClient'
-
-instance = PulpRpmClient::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

@@ -1,130 +0,0 @@
-# PulpRpmClient::TaskGroupsApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](TaskGroupsApi.md#list) | **GET** /pulp/api/v3/task-groups/ | List task groups
-[**read**](TaskGroupsApi.md#read) | **GET** {task_group_href} | Inspect a task group
-
-
-
-## list
-
-> PaginatedTaskGroupResponseList 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_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::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.list(opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling TaskGroupsApi->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
-
-
-## read
-
-> TaskGroupResponse 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_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::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.read(task_group_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling TaskGroupsApi->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

@@ -1,45 +0,0 @@
-# PulpRpmClient::TaskResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [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 | 
-**started_at** | **DateTime** | Timestamp of the when this task started execution. | [optional] [readonly] 
-**finished_at** | **DateTime** | Timestamp of the when this task stopped execution. | [optional] [readonly] 
-**error** | **Hash<String, Object>** | 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 'PulpRpmClient'
-
-instance = PulpRpmClient::TaskResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 state: null,
-                                 name: null,
-                                 logging_cid: 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

@@ -1,29 +0,0 @@
-# PulpRpmClient::TaskScheduleResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [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 'PulpRpmClient'
-
-instance = PulpRpmClient::TaskScheduleResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null,
-                                 task_name: null,
-                                 dispatch_interval: null,
-                                 next_dispatch: null,
-                                 last_task: null)
-```
-
-

data/docs/TaskSchedulesApi.md

@@ -1,372 +0,0 @@
-# PulpRpmClient::TaskSchedulesApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**add_role**](TaskSchedulesApi.md#add_role) | **POST** {task_schedule_href}add_role/ | 
-[**list**](TaskSchedulesApi.md#list) | **GET** /pulp/api/v3/task-schedules/ | List task schedules
-[**list_roles**](TaskSchedulesApi.md#list_roles) | **GET** {task_schedule_href}list_roles/ | 
-[**my_permissions**](TaskSchedulesApi.md#my_permissions) | **GET** {task_schedule_href}my_permissions/ | 
-[**read**](TaskSchedulesApi.md#read) | **GET** {task_schedule_href} | Inspect a task schedule
-[**remove_role**](TaskSchedulesApi.md#remove_role) | **POST** {task_schedule_href}remove_role/ | 
-
-
-
-## add_role
-
-> NestedRoleResponse add_role(task_schedule_href, nested_role)
-
-
-
-Add a role for this object to users/groups.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::TaskSchedulesApi.new
-task_schedule_href = 'task_schedule_href_example' # String | 
-nested_role = PulpRpmClient::NestedRole.new # NestedRole | 
-
-begin
-  result = api_instance.add_role(task_schedule_href, nested_role)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->add_role: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **task_schedule_href** | **String**|  | 
- **nested_role** | [**NestedRole**](NestedRole.md)|  | 
-
-### Return type
-
-[**NestedRoleResponse**](NestedRoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## list
-
-> PaginatedTaskScheduleResponseList list(opts)
-
-List task schedules
-
-ViewSet to monitor task schedules.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::TaskSchedulesApi.new
-opts = {
-  limit: 56, # Integer | Number of results to return per page.
-  name: 'name_example', # String | Filter results where name matches value
-  name__contains: 'name__contains_example', # String | Filter results where name contains 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) * `next_dispatch` - Next dispatch * `-next_dispatch` - Next dispatch (descending) * `dispatch_interval` - Dispatch interval * `-dispatch_interval` - Dispatch interval (descending) * `task_name` - Task name * `-task_name` - Task name (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.
-  task_name: 'task_name_example', # String | Filter results where task_name matches value
-  task_name__contains: 'task_name__contains_example', # String | Filter results where task_name contains value
-  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 schedules
-  result = api_instance.list(opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->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] 
- **name__contains** | **String**| Filter results where name contains 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;next_dispatch&#x60; - Next dispatch * &#x60;-next_dispatch&#x60; - Next dispatch (descending) * &#x60;dispatch_interval&#x60; - Dispatch interval * &#x60;-dispatch_interval&#x60; - Dispatch interval (descending) * &#x60;task_name&#x60; - Task name * &#x60;-task_name&#x60; - Task name (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] 
- **task_name** | **String**| Filter results where task_name matches value | [optional] 
- **task_name__contains** | **String**| Filter results where task_name contains value | [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
-
-[**PaginatedTaskScheduleResponseList**](PaginatedTaskScheduleResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## list_roles
-
-> ObjectRolesResponse list_roles(task_schedule_href, opts)
-
-
-
-List roles assigned to this object.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::TaskSchedulesApi.new
-task_schedule_href = 'task_schedule_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
-  result = api_instance.list_roles(task_schedule_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->list_roles: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **task_schedule_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
-
-[**ObjectRolesResponse**](ObjectRolesResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## my_permissions
-
-> MyPermissionsResponse my_permissions(task_schedule_href, opts)
-
-
-
-List permissions available to the current user on this object.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::TaskSchedulesApi.new
-task_schedule_href = 'task_schedule_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
-  result = api_instance.my_permissions(task_schedule_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->my_permissions: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **task_schedule_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
-
-[**MyPermissionsResponse**](MyPermissionsResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## read
-
-> TaskScheduleResponse read(task_schedule_href, opts)
-
-Inspect a task schedule
-
-ViewSet to monitor task schedules.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::TaskSchedulesApi.new
-task_schedule_href = 'task_schedule_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 schedule
-  result = api_instance.read(task_schedule_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **task_schedule_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
-
-[**TaskScheduleResponse**](TaskScheduleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## remove_role
-
-> NestedRoleResponse remove_role(task_schedule_href, nested_role)
-
-
-
-Remove a role for this object from users/groups.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::TaskSchedulesApi.new
-task_schedule_href = 'task_schedule_href_example' # String | 
-nested_role = PulpRpmClient::NestedRole.new # NestedRole | 
-
-begin
-  result = api_instance.remove_role(task_schedule_href, nested_role)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->remove_role: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **task_schedule_href** | **String**|  | 
- **nested_role** | [**NestedRole**](NestedRole.md)|  | 
-
-### Return type
-
-[**NestedRoleResponse**](NestedRoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-