pulpcore_client 3.17.8 → 3.18.0

data/docs/TaskSchedulesApi.md

@@ -0,0 +1,368 @@
+# PulpcoreClient::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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TaskSchedulesApi.new
+task_schedule_href = 'task_schedule_href_example' # String | 
+nested_role = PulpcoreClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(task_schedule_href, nested_role)
+  p result
+rescue PulpcoreClient::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.  NOTE: This feature is in tech-preview and may change in backwards incompatible ways.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TaskSchedulesApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | 
+  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', # String | Which field to use when ordering the results.
+  task_name: 'task_name_example', # String | 
+  task_name__contains: 'task_name__contains_example', # String | Filter results where task_name contains value
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List task schedules
+  result = api_instance.list(opts)
+  p result
+rescue PulpcoreClient::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**|  | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **task_name** | **String**|  | [optional] 
+ **task_name__contains** | **String**| Filter results where task_name contains value | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| 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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TaskSchedulesApi.new
+task_schedule_href = 'task_schedule_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.list_roles(task_schedule_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling TaskSchedulesApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_schedule_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| 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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TaskSchedulesApi.new
+task_schedule_href = 'task_schedule_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.my_permissions(task_schedule_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling TaskSchedulesApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_schedule_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| 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.  NOTE: This feature is in tech-preview and may change in backwards incompatible ways.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TaskSchedulesApi.new
+task_schedule_href = 'task_schedule_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # 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 PulpcoreClient::ApiError => e
+  puts "Exception when calling TaskSchedulesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_schedule_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| 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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::TaskSchedulesApi.new
+task_schedule_href = 'task_schedule_href_example' # String | 
+nested_role = PulpcoreClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(task_schedule_href, nested_role)
+  p result
+rescue PulpcoreClient::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
+

data/docs/WorkerResponse.md

@@ -4,20 +4,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
 **pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
 **name** | **String** | The name of the worker. | [optional] [readonly] 
 **last_heartbeat** | **DateTime** | Timestamp of the last time the worker talked to the service. | [optional] [readonly] 
+**current_task** | **String** | The task this worker is currently executing, or empty if the worker is not currently assigned to a task. | [optional] [readonly] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::WorkerResponse.new(pulp_created: null,
-                                 pulp_href: null,
+instance = PulpcoreClient::WorkerResponse.new(pulp_href: null,
+                                 pulp_created: null,
                                  name: null,
-                                 last_heartbeat: null)
+                                 last_heartbeat: null,
+                                 current_task: null)
 ```