pulp_certguard_client 3.49.14 → 3.49.15

data/docs/TaskSchedulesApi.md

@@ -1,378 +0,0 @@
-# PulpCertguardClient::TaskSchedulesApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**task_schedules_add_role**](TaskSchedulesApi.md#task_schedules_add_role) | **POST** {task_schedule_href}add_role/ | Add a role
-[**task_schedules_list**](TaskSchedulesApi.md#task_schedules_list) | **GET** /pulp/api/v3/task-schedules/ | List task schedules
-[**task_schedules_list_roles**](TaskSchedulesApi.md#task_schedules_list_roles) | **GET** {task_schedule_href}list_roles/ | List roles
-[**task_schedules_my_permissions**](TaskSchedulesApi.md#task_schedules_my_permissions) | **GET** {task_schedule_href}my_permissions/ | List user permissions
-[**task_schedules_read**](TaskSchedulesApi.md#task_schedules_read) | **GET** {task_schedule_href} | Inspect a task schedule
-[**task_schedules_remove_role**](TaskSchedulesApi.md#task_schedules_remove_role) | **POST** {task_schedule_href}remove_role/ | Remove a role
-
-
-
-## task_schedules_add_role
-
-> NestedRoleResponse task_schedules_add_role(task_schedule_href, nested_role)
-
-Add a role
-
-Add a role for this object to users/groups.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_certguard_client'
-# setup authorization
-PulpCertguardClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpCertguardClient::TaskSchedulesApi.new
-task_schedule_href = 'task_schedule_href_example' # String | 
-nested_role = PulpCertguardClient::NestedRole.new # NestedRole | 
-
-begin
-  #Add a role
-  result = api_instance.task_schedules_add_role(task_schedule_href, nested_role)
-  p result
-rescue PulpCertguardClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->task_schedules_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
-
-
-## task_schedules_list
-
-> PaginatedTaskScheduleResponseList task_schedules_list(opts)
-
-List task schedules
-
-ViewSet to monitor task schedules.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_certguard_client'
-# setup authorization
-PulpCertguardClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpCertguardClient::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.
-  q: 'q_example', # String | 
-  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.task_schedules_list(opts)
-  p result
-rescue PulpCertguardClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->task_schedules_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] 
- **q** | **String**|  | [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
-
-
-## task_schedules_list_roles
-
-> ObjectRolesResponse task_schedules_list_roles(task_schedule_href, opts)
-
-List roles
-
-List roles assigned to this object.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_certguard_client'
-# setup authorization
-PulpCertguardClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpCertguardClient::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
-  #List roles
-  result = api_instance.task_schedules_list_roles(task_schedule_href, opts)
-  p result
-rescue PulpCertguardClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->task_schedules_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
-
-
-## task_schedules_my_permissions
-
-> MyPermissionsResponse task_schedules_my_permissions(task_schedule_href, opts)
-
-List user permissions
-
-List permissions available to the current user on this object.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_certguard_client'
-# setup authorization
-PulpCertguardClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpCertguardClient::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
-  #List user permissions
-  result = api_instance.task_schedules_my_permissions(task_schedule_href, opts)
-  p result
-rescue PulpCertguardClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->task_schedules_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
-
-
-## task_schedules_read
-
-> TaskScheduleResponse task_schedules_read(task_schedule_href, opts)
-
-Inspect a task schedule
-
-ViewSet to monitor task schedules.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_certguard_client'
-# setup authorization
-PulpCertguardClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpCertguardClient::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.task_schedules_read(task_schedule_href, opts)
-  p result
-rescue PulpCertguardClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->task_schedules_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
-
-
-## task_schedules_remove_role
-
-> NestedRoleResponse task_schedules_remove_role(task_schedule_href, nested_role)
-
-Remove a role
-
-Remove a role for this object from users/groups.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_certguard_client'
-# setup authorization
-PulpCertguardClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpCertguardClient::TaskSchedulesApi.new
-task_schedule_href = 'task_schedule_href_example' # String | 
-nested_role = PulpCertguardClient::NestedRole.new # NestedRole | 
-
-begin
-  #Remove a role
-  result = api_instance.task_schedules_remove_role(task_schedule_href, nested_role)
-  p result
-rescue PulpCertguardClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->task_schedules_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
-