Class: PulpcoreClient::RolesApi
- Inherits:
-
Object
- Object
- PulpcoreClient::RolesApi
- Defined in:
- lib/pulpcore_client/api/roles_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create(role, opts = {}) ⇒ RoleResponse
Create a role ViewSet for Role.
-
#create_with_http_info(role, opts = {}) ⇒ Array<(RoleResponse, Integer, Hash)>
Create a role ViewSet for Role.
-
#delete(role_href, opts = {}) ⇒ nil
Delete a role ViewSet for Role.
-
#delete_with_http_info(role_href, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a role ViewSet for Role.
-
#initialize(api_client = ApiClient.default) ⇒ RolesApi
constructor
A new instance of RolesApi.
-
#list(opts = {}) ⇒ PaginatedRoleResponseList
List roles ViewSet for Role.
-
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedRoleResponseList, Integer, Hash)>
List roles ViewSet for Role.
-
#partial_update(role_href, patched_role, opts = {}) ⇒ RoleResponse
Update a role ViewSet for Role.
-
#partial_update_with_http_info(role_href, patched_role, opts = {}) ⇒ Array<(RoleResponse, Integer, Hash)>
Update a role ViewSet for Role.
-
#read(role_href, opts = {}) ⇒ RoleResponse
Inspect a role ViewSet for Role.
-
#read_with_http_info(role_href, opts = {}) ⇒ Array<(RoleResponse, Integer, Hash)>
Inspect a role ViewSet for Role.
-
#update(role_href, role, opts = {}) ⇒ RoleResponse
Update a role ViewSet for Role.
-
#update_with_http_info(role_href, role, opts = {}) ⇒ Array<(RoleResponse, Integer, Hash)>
Update a role ViewSet for Role.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create(role, opts = {}) ⇒ RoleResponse
Create a role ViewSet for Role.
27 28 29 30 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 27 def create(role, opts = {}) data, _status_code, _headers = create_with_http_info(role, opts) data end |
#create_with_http_info(role, opts = {}) ⇒ Array<(RoleResponse, Integer, Hash)>
Create a role ViewSet for Role.
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 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 37 def create_with_http_info(role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.create ...' end # verify the required parameter 'role' is set if @api_client.config.client_side_validation && role.nil? fail ArgumentError, "Missing the required parameter 'role' when calling RolesApi.create" end # resource path local_var_path = '/pulp/api/v3/roles/' # 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(role) # return_type return_type = opts[:return_type] || 'RoleResponse' # 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: RolesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete(role_href, opts = {}) ⇒ nil
Delete a role ViewSet for Role.
91 92 93 94 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 91 def delete(role_href, opts = {}) delete_with_http_info(role_href, opts) nil end |
#delete_with_http_info(role_href, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a role ViewSet for Role.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 101 def delete_with_http_info(role_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.delete ...' end # verify the required parameter 'role_href' is set if @api_client.config.client_side_validation && role_href.nil? fail ArgumentError, "Missing the required parameter 'role_href' when calling RolesApi.delete" end # resource path local_var_path = '{role_href}'.sub('{' + 'role_href' + '}', CGI.escape(role_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # 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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(opts = {}) ⇒ PaginatedRoleResponseList
List roles ViewSet for Role.
174 175 176 177 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 174 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedRoleResponseList, Integer, Hash)>
List roles ViewSet for Role.
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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 207 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.list ...' end allowable_values = ["-description", "-locked", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "description", "locked", "name", "pk", "pulp_created", "pulp_id", "pulp_last_updated"] 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/roles/' # query parameters query_params = opts[:query_params] || {} query_params[:'contains_permission'] = @api_client.build_collection_param(opts[:'contains_permission'], :multi) if !opts[:'contains_permission'].nil? query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil? query_params[:'description__contains'] = opts[:'description__contains'] if !opts[:'description__contains'].nil? query_params[:'description__icontains'] = opts[:'description__icontains'] if !opts[:'description__icontains'].nil? query_params[:'description__iexact'] = opts[:'description__iexact'] if !opts[:'description__iexact'].nil? query_params[:'for_object_type'] = opts[:'for_object_type'] if !opts[:'for_object_type'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'locked'] = opts[:'locked'] if !opts[:'locked'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil? query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil? query_params[:'name__iexact'] = opts[:'name__iexact'] if !opts[:'name__iexact'].nil? query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil? query_params[:'name__iregex'] = opts[:'name__iregex'] if !opts[:'name__iregex'].nil? query_params[:'name__istartswith'] = opts[:'name__istartswith'] if !opts[:'name__istartswith'].nil? query_params[:'name__regex'] = opts[:'name__regex'] if !opts[:'name__regex'].nil? query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].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[:'q'] = opts[:'q'] if !opts[:'q'].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] || 'PaginatedRoleResponseList' # 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: RolesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#partial_update(role_href, patched_role, opts = {}) ⇒ RoleResponse
Update a role ViewSet for Role.
284 285 286 287 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 284 def partial_update(role_href, patched_role, opts = {}) data, _status_code, _headers = partial_update_with_http_info(role_href, patched_role, opts) data end |
#partial_update_with_http_info(role_href, patched_role, opts = {}) ⇒ Array<(RoleResponse, Integer, Hash)>
Update a role ViewSet for Role.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 295 def partial_update_with_http_info(role_href, patched_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.partial_update ...' end # verify the required parameter 'role_href' is set if @api_client.config.client_side_validation && role_href.nil? fail ArgumentError, "Missing the required parameter 'role_href' when calling RolesApi.partial_update" end # verify the required parameter 'patched_role' is set if @api_client.config.client_side_validation && patched_role.nil? fail ArgumentError, "Missing the required parameter 'patched_role' when calling RolesApi.partial_update" end # resource path local_var_path = '{role_href}'.sub('{' + 'role_href' + '}', CGI.escape(role_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(patched_role) # return_type return_type = opts[:return_type] || 'RoleResponse' # 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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read(role_href, opts = {}) ⇒ RoleResponse
Inspect a role ViewSet for Role.
355 356 357 358 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 355 def read(role_href, opts = {}) data, _status_code, _headers = read_with_http_info(role_href, opts) data end |
#read_with_http_info(role_href, opts = {}) ⇒ Array<(RoleResponse, Integer, Hash)>
Inspect a role ViewSet for Role.
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 367 def read_with_http_info(role_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.read ...' end # verify the required parameter 'role_href' is set if @api_client.config.client_side_validation && role_href.nil? fail ArgumentError, "Missing the required parameter 'role_href' when calling RolesApi.read" end # resource path local_var_path = '{role_href}'.sub('{' + 'role_href' + '}', CGI.escape(role_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] || 'RoleResponse' # 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: RolesApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(role_href, role, opts = {}) ⇒ RoleResponse
Update a role ViewSet for Role.
422 423 424 425 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 422 def update(role_href, role, opts = {}) data, _status_code, _headers = update_with_http_info(role_href, role, opts) data end |
#update_with_http_info(role_href, role, opts = {}) ⇒ Array<(RoleResponse, Integer, Hash)>
Update a role ViewSet for Role.
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 |
# File 'lib/pulpcore_client/api/roles_api.rb', line 433 def update_with_http_info(role_href, role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.update ...' end # verify the required parameter 'role_href' is set if @api_client.config.client_side_validation && role_href.nil? fail ArgumentError, "Missing the required parameter 'role_href' when calling RolesApi.update" end # verify the required parameter 'role' is set if @api_client.config.client_side_validation && role.nil? fail ArgumentError, "Missing the required parameter 'role' when calling RolesApi.update" end # resource path local_var_path = '{role_href}'.sub('{' + 'role_href' + '}', CGI.escape(role_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(role) # return_type return_type = opts[:return_type] || 'RoleResponse' # 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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |