Class: PulpcoreClient::TaskSchedulesApi
- Inherits:
-
Object
- Object
- PulpcoreClient::TaskSchedulesApi
- Defined in:
- lib/pulpcore_client/api/task_schedules_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_role(task_schedule_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Add a role for this object to users/groups.
-
#add_role_with_http_info(task_schedule_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Add a role for this object to users/groups.
-
#initialize(api_client = ApiClient.default) ⇒ TaskSchedulesApi
constructor
A new instance of TaskSchedulesApi.
-
#list(opts = {}) ⇒ PaginatedTaskScheduleResponseList
List task schedules ViewSet to monitor task schedules.
-
#list_roles(task_schedule_href, opts = {}) ⇒ ObjectRolesResponse
List roles assigned to this object.
-
#list_roles_with_http_info(task_schedule_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>
List roles assigned to this object.
-
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedTaskScheduleResponseList, Integer, Hash)>
List task schedules ViewSet to monitor task schedules.
-
#my_permissions(task_schedule_href, opts = {}) ⇒ MyPermissionsResponse
List permissions available to the current user on this object.
-
#my_permissions_with_http_info(task_schedule_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>
List permissions available to the current user on this object.
-
#read(task_schedule_href, opts = {}) ⇒ TaskScheduleResponse
Inspect a task schedule ViewSet to monitor task schedules.
-
#read_with_http_info(task_schedule_href, opts = {}) ⇒ Array<(TaskScheduleResponse, Integer, Hash)>
Inspect a task schedule ViewSet to monitor task schedules.
-
#remove_role(task_schedule_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Remove a role for this object from users/groups.
-
#remove_role_with_http_info(task_schedule_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Remove a role for this object from users/groups.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ TaskSchedulesApi
Returns a new instance of TaskSchedulesApi.
19 20 21 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#add_role(task_schedule_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Add a role for this object to users/groups.
27 28 29 30 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 27 def add_role(task_schedule_href, nested_role, opts = {}) data, _status_code, _headers = add_role_with_http_info(task_schedule_href, nested_role, opts) data end |
#add_role_with_http_info(task_schedule_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Add a role for this object to users/groups.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 37 def add_role_with_http_info(task_schedule_href, nested_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.add_role ...' end # verify the required parameter 'task_schedule_href' is set if @api_client.config.client_side_validation && task_schedule_href.nil? fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.add_role" end # verify the required parameter 'nested_role' is set if @api_client.config.client_side_validation && nested_role.nil? fail ArgumentError, "Missing the required parameter 'nested_role' when calling TaskSchedulesApi.add_role" end # resource path local_var_path = '{task_schedule_href}add_role/'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(nested_role) # return_type return_type = opts[:return_type] || 'NestedRoleResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TaskSchedulesApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(opts = {}) ⇒ PaginatedTaskScheduleResponseList
List task schedules ViewSet to monitor task schedules.
105 106 107 108 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 105 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
#list_roles(task_schedule_href, opts = {}) ⇒ ObjectRolesResponse
List roles assigned to this object.
189 190 191 192 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 189 def list_roles(task_schedule_href, opts = {}) data, _status_code, _headers = list_roles_with_http_info(task_schedule_href, opts) data end |
#list_roles_with_http_info(task_schedule_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>
List roles assigned to this object.
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 200 def list_roles_with_http_info(task_schedule_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.list_roles ...' end # verify the required parameter 'task_schedule_href' is set if @api_client.config.client_side_validation && task_schedule_href.nil? fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.list_roles" end # resource path local_var_path = '{task_schedule_href}list_roles/'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ObjectRolesResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TaskSchedulesApi#list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedTaskScheduleResponseList, Integer, Hash)>
List task schedules ViewSet to monitor task schedules.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 125 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.list ...' end allowable_values = ["-dispatch_interval", "-name", "-next_dispatch", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-task_name", "dispatch_interval", "name", "next_dispatch", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "task_name"] if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}" end # resource path local_var_path = '/pulp/api/v3/task-schedules/' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil? query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil? query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil? query_params[:'task_name'] = opts[:'task_name'] if !opts[:'task_name'].nil? query_params[:'task_name__contains'] = opts[:'task_name__contains'] if !opts[:'task_name__contains'].nil? query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PaginatedTaskScheduleResponseList' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TaskSchedulesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#my_permissions(task_schedule_href, opts = {}) ⇒ MyPermissionsResponse
List permissions available to the current user on this object.
255 256 257 258 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 255 def (task_schedule_href, opts = {}) data, _status_code, _headers = (task_schedule_href, opts) data end |
#my_permissions_with_http_info(task_schedule_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>
List permissions available to the current user on this object.
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 266 def (task_schedule_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.my_permissions ...' end # verify the required parameter 'task_schedule_href' is set if @api_client.config.client_side_validation && task_schedule_href.nil? fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.my_permissions" end # resource path local_var_path = '{task_schedule_href}my_permissions/'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'MyPermissionsResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TaskSchedulesApi#my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read(task_schedule_href, opts = {}) ⇒ TaskScheduleResponse
Inspect a task schedule ViewSet to monitor task schedules.
322 323 324 325 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 322 def read(task_schedule_href, opts = {}) data, _status_code, _headers = read_with_http_info(task_schedule_href, opts) data end |
#read_with_http_info(task_schedule_href, opts = {}) ⇒ Array<(TaskScheduleResponse, Integer, Hash)>
Inspect a task schedule ViewSet to monitor task schedules.
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 334 def read_with_http_info(task_schedule_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.read ...' end # verify the required parameter 'task_schedule_href' is set if @api_client.config.client_side_validation && task_schedule_href.nil? fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.read" end # resource path local_var_path = '{task_schedule_href}'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'TaskScheduleResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TaskSchedulesApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#remove_role(task_schedule_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Remove a role for this object from users/groups.
388 389 390 391 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 388 def remove_role(task_schedule_href, nested_role, opts = {}) data, _status_code, _headers = remove_role_with_http_info(task_schedule_href, nested_role, opts) data end |
#remove_role_with_http_info(task_schedule_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Remove a role for this object from users/groups.
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 |
# File 'lib/pulpcore_client/api/task_schedules_api.rb', line 398 def remove_role_with_http_info(task_schedule_href, nested_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.remove_role ...' end # verify the required parameter 'task_schedule_href' is set if @api_client.config.client_side_validation && task_schedule_href.nil? fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.remove_role" end # verify the required parameter 'nested_role' is set if @api_client.config.client_side_validation && nested_role.nil? fail ArgumentError, "Missing the required parameter 'nested_role' when calling TaskSchedulesApi.remove_role" end # resource path local_var_path = '{task_schedule_href}remove_role/'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(nested_role) # return_type return_type = opts[:return_type] || 'NestedRoleResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TaskSchedulesApi#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |