pulpcore_client 3.69.1 → 3.70.0

data/docs/TaskSchedulesApi.md

@@ -2,29 +2,28 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**add_role**](TaskSchedulesApi.md#add_role) | **POST** {task_schedule_href}add_role/ | Add a 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/ | List roles
-[**my_permissions**](TaskSchedulesApi.md#my_permissions) | **GET** {task_schedule_href}my_permissions/ | List user 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/ | Remove a role
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_role**](TaskSchedulesApi.md#add_role) | **POST** {task_schedule_href}add_role/ | Add a 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/ | List roles |
+| [**my_permissions**](TaskSchedulesApi.md#my_permissions) | **GET** {task_schedule_href}my_permissions/ | List user 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/ | Remove a role |
 
 
 ## add_role
 
-> NestedRoleResponse add_role(task_schedule_href, nested_role)
+> <NestedRoleResponse> add_role(task_schedule_href, nested_role)
 
 Add a role
 
 Add a role for this object to users/groups.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -35,24 +34,41 @@ end
 
 api_instance = PulpcoreClient::TaskSchedulesApi.new
 task_schedule_href = 'task_schedule_href_example' # String | 
-nested_role = PulpcoreClient::NestedRole.new # NestedRole | 
+nested_role = PulpcoreClient::NestedRole.new({role: 'role_example'}) # NestedRole | 
 
 begin
-  #Add a role
+  # Add a role
   result = api_instance.add_role(task_schedule_href, nested_role)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->add_role: #{e}"
+  puts "Error when calling TaskSchedulesApi->add_role: #{e}"
 end
 ```
 
-### Parameters
+#### Using the add_role_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(task_schedule_href, nested_role)
+
+```ruby
+begin
+  # Add a role
+  data, status_code, headers = api_instance.add_role_with_http_info(task_schedule_href, nested_role)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NestedRoleResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling TaskSchedulesApi->add_role_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **task_schedule_href** | **String**|  | 
- **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_schedule_href** | **String** |  |  |
+| **nested_role** | [**NestedRole**](NestedRole.md) |  |  |
 
 ### Return type
 
@@ -70,16 +86,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginatedTaskScheduleResponseList list(opts)
+> <PaginatedTaskScheduleResponseList> list(opts)
 
 List task schedules
 
 ViewSet to monitor task schedules.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -94,44 +110,61 @@ opts = {
   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)
-  prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
-  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.
+  ordering: ['-dispatch_interval'], # 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)
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
   q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
   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.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List task schedules
+  # List task schedules
   result = api_instance.list(opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->list: #{e}"
+  puts "Error when calling TaskSchedulesApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-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] 
- **prn__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [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**| Filter results by using NOT, AND and OR operations on other filters | [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] 
+> <Array(<PaginatedTaskScheduleResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List task schedules
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedTaskScheduleResponseList>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling TaskSchedulesApi->list_with_http_info: #{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] |
+| **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [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** | Filter results by using NOT, AND and OR operations on other filters | [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
 
@@ -149,16 +182,16 @@ Name | Type | Description  | Notes
 
 ## list_roles
 
-> ObjectRolesResponse list_roles(task_schedule_href, opts)
+> <ObjectRolesResponse> list_roles(task_schedule_href, opts)
 
 List roles
 
 List roles assigned to this object.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -170,27 +203,44 @@ end
 api_instance = PulpcoreClient::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.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List roles
+  # List roles
   result = api_instance.list_roles(task_schedule_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->list_roles: #{e}"
+  puts "Error when calling TaskSchedulesApi->list_roles: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_roles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(task_schedule_href, opts)
 
+```ruby
+begin
+  # List roles
+  data, status_code, headers = api_instance.list_roles_with_http_info(task_schedule_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ObjectRolesResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling TaskSchedulesApi->list_roles_with_http_info: #{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] 
+| 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
 
@@ -208,16 +258,16 @@ Name | Type | Description  | Notes
 
 ## my_permissions
 
-> MyPermissionsResponse my_permissions(task_schedule_href, opts)
+> <MyPermissionsResponse> my_permissions(task_schedule_href, opts)
 
 List user permissions
 
 List permissions available to the current user on this object.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -229,27 +279,44 @@ end
 api_instance = PulpcoreClient::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.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List user permissions
+  # List user permissions
   result = api_instance.my_permissions(task_schedule_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->my_permissions: #{e}"
+  puts "Error when calling TaskSchedulesApi->my_permissions: #{e}"
 end
 ```
 
-### Parameters
+#### Using the my_permissions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(task_schedule_href, opts)
 
-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] 
+```ruby
+begin
+  # List user permissions
+  data, status_code, headers = api_instance.my_permissions_with_http_info(task_schedule_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MyPermissionsResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling TaskSchedulesApi->my_permissions_with_http_info: #{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
 
@@ -267,16 +334,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> TaskScheduleResponse read(task_schedule_href, opts)
+> <TaskScheduleResponse> read(task_schedule_href, opts)
 
 Inspect a task schedule
 
 ViewSet to monitor task schedules.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -288,27 +355,44 @@ end
 api_instance = PulpcoreClient::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.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #Inspect a task schedule
+  # 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}"
+  puts "Error when calling TaskSchedulesApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TaskScheduleResponse>, Integer, Hash)> read_with_http_info(task_schedule_href, opts)
+
+```ruby
+begin
+  # Inspect a task schedule
+  data, status_code, headers = api_instance.read_with_http_info(task_schedule_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TaskScheduleResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling TaskSchedulesApi->read_with_http_info: #{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] 
+| 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
 
@@ -326,16 +410,16 @@ Name | Type | Description  | Notes
 
 ## remove_role
 
-> NestedRoleResponse remove_role(task_schedule_href, nested_role)
+> <NestedRoleResponse> remove_role(task_schedule_href, nested_role)
 
 Remove a role
 
 Remove a role for this object from users/groups.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -346,24 +430,41 @@ end
 
 api_instance = PulpcoreClient::TaskSchedulesApi.new
 task_schedule_href = 'task_schedule_href_example' # String | 
-nested_role = PulpcoreClient::NestedRole.new # NestedRole | 
+nested_role = PulpcoreClient::NestedRole.new({role: 'role_example'}) # NestedRole | 
 
 begin
-  #Remove a role
+  # Remove a role
   result = api_instance.remove_role(task_schedule_href, nested_role)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling TaskSchedulesApi->remove_role: #{e}"
+  puts "Error when calling TaskSchedulesApi->remove_role: #{e}"
 end
 ```
 
-### Parameters
+#### Using the remove_role_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(task_schedule_href, nested_role)
 
+```ruby
+begin
+  # Remove a role
+  data, status_code, headers = api_instance.remove_role_with_http_info(task_schedule_href, nested_role)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NestedRoleResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling TaskSchedulesApi->remove_role_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **task_schedule_href** | **String**|  | 
- **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_schedule_href** | **String** |  |  |
+| **nested_role** | [**NestedRole**](NestedRole.md) |  |  |
 
 ### Return type