Class: PulpAnsibleClient::AnsibleCollectionsApi
- Inherits:
-
Object
- Object
- PulpAnsibleClient::AnsibleCollectionsApi
- Defined in:
- lib/pulp_ansible_client/api/ansible_collections_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_role(ansible_collection_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Add a role Add a role for this object to users/groups.
-
#add_role_with_http_info(ansible_collection_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Add a role Add a role for this object to users/groups.
-
#initialize(api_client = ApiClient.default) ⇒ AnsibleCollectionsApi
constructor
A new instance of AnsibleCollectionsApi.
-
#list(opts = {}) ⇒ PaginatedansibleCollectionResponseList
List collections Viewset for Ansible Collections.
-
#list_roles(ansible_collection_href, opts = {}) ⇒ ObjectRolesResponse
List roles List roles assigned to this object.
-
#list_roles_with_http_info(ansible_collection_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>
List roles List roles assigned to this object.
-
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedansibleCollectionResponseList, Integer, Hash)>
List collections Viewset for Ansible Collections.
-
#my_permissions(ansible_collection_href, opts = {}) ⇒ MyPermissionsResponse
List user permissions List permissions available to the current user on this object.
-
#my_permissions_with_http_info(ansible_collection_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>
List user permissions List permissions available to the current user on this object.
-
#read(ansible_collection_href, opts = {}) ⇒ AnsibleCollectionResponse
Inspect a collection Viewset for Ansible Collections.
-
#read_with_http_info(ansible_collection_href, opts = {}) ⇒ Array<(AnsibleCollectionResponse, Integer, Hash)>
Inspect a collection Viewset for Ansible Collections.
-
#remove_role(ansible_collection_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Remove a role Remove a role for this object from users/groups.
-
#remove_role_with_http_info(ansible_collection_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Remove a role Remove a role for this object from users/groups.
-
#upload_collection(file, opts = {}) ⇒ AsyncOperationResponse
Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it.
-
#upload_collection_with_http_info(file, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AnsibleCollectionsApi
Returns a new instance of AnsibleCollectionsApi.
19 20 21 |
# File 'lib/pulp_ansible_client/api/ansible_collections_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/pulp_ansible_client/api/ansible_collections_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#add_role(ansible_collection_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Add a role Add a role for this object to users/groups.
28 29 30 31 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 28 def add_role(ansible_collection_href, nested_role, opts = {}) data, _status_code, _headers = add_role_with_http_info(ansible_collection_href, nested_role, opts) data end |
#add_role_with_http_info(ansible_collection_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Add a role Add a role for this object to users/groups.
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 89 90 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 39 def add_role_with_http_info(ansible_collection_href, nested_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.add_role ...' end # verify the required parameter 'ansible_collection_href' is set if @api_client.config.client_side_validation && ansible_collection_href.nil? fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling AnsibleCollectionsApi.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 AnsibleCollectionsApi.add_role" end # resource path local_var_path = '{ansible_collection_href}add_role/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_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: AnsibleCollectionsApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(opts = {}) ⇒ PaginatedansibleCollectionResponseList
List collections Viewset for Ansible Collections.
106 107 108 109 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 106 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
#list_roles(ansible_collection_href, opts = {}) ⇒ ObjectRolesResponse
List roles List roles assigned to this object.
189 190 191 192 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 189 def list_roles(ansible_collection_href, opts = {}) data, _status_code, _headers = list_roles_with_http_info(ansible_collection_href, opts) data end |
#list_roles_with_http_info(ansible_collection_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>
List roles List roles assigned to this object.
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 248 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 201 def list_roles_with_http_info(ansible_collection_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.list_roles ...' end # verify the required parameter 'ansible_collection_href' is set if @api_client.config.client_side_validation && ansible_collection_href.nil? fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling AnsibleCollectionsApi.list_roles" end # resource path local_var_path = '{ansible_collection_href}list_roles/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_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: AnsibleCollectionsApi#list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedansibleCollectionResponseList, Integer, Hash)>
List collections Viewset for Ansible Collections.
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 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 125 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.list ...' end allowable_values = ["-name", "-namespace", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "name", "namespace", "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/ansible/collections/' # 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[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].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] || 'PaginatedansibleCollectionResponseList' # 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: AnsibleCollectionsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#my_permissions(ansible_collection_href, opts = {}) ⇒ MyPermissionsResponse
List user permissions List permissions available to the current user on this object.
257 258 259 260 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 257 def (ansible_collection_href, opts = {}) data, _status_code, _headers = (ansible_collection_href, opts) data end |
#my_permissions_with_http_info(ansible_collection_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>
List user permissions List permissions available to the current user on this object.
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 314 315 316 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 269 def (ansible_collection_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.my_permissions ...' end # verify the required parameter 'ansible_collection_href' is set if @api_client.config.client_side_validation && ansible_collection_href.nil? fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling AnsibleCollectionsApi.my_permissions" end # resource path local_var_path = '{ansible_collection_href}my_permissions/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_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: AnsibleCollectionsApi#my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read(ansible_collection_href, opts = {}) ⇒ AnsibleCollectionResponse
Inspect a collection Viewset for Ansible Collections.
325 326 327 328 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 325 def read(ansible_collection_href, opts = {}) data, _status_code, _headers = read_with_http_info(ansible_collection_href, opts) data end |
#read_with_http_info(ansible_collection_href, opts = {}) ⇒ Array<(AnsibleCollectionResponse, Integer, Hash)>
Inspect a collection Viewset for Ansible Collections.
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 382 383 384 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 337 def read_with_http_info(ansible_collection_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.read ...' end # verify the required parameter 'ansible_collection_href' is set if @api_client.config.client_side_validation && ansible_collection_href.nil? fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling AnsibleCollectionsApi.read" end # resource path local_var_path = '{ansible_collection_href}'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_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] || 'AnsibleCollectionResponse' # 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: AnsibleCollectionsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#remove_role(ansible_collection_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Remove a role Remove a role for this object from users/groups.
392 393 394 395 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 392 def remove_role(ansible_collection_href, nested_role, opts = {}) data, _status_code, _headers = remove_role_with_http_info(ansible_collection_href, nested_role, opts) data end |
#remove_role_with_http_info(ansible_collection_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Remove a role Remove a role for this object from users/groups.
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 450 451 452 453 454 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 403 def remove_role_with_http_info(ansible_collection_href, nested_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.remove_role ...' end # verify the required parameter 'ansible_collection_href' is set if @api_client.config.client_side_validation && ansible_collection_href.nil? fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling AnsibleCollectionsApi.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 AnsibleCollectionsApi.remove_role" end # resource path local_var_path = '{ansible_collection_href}remove_role/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_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: AnsibleCollectionsApi#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#upload_collection(file, opts = {}) ⇒ AsyncOperationResponse
Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it.
465 466 467 468 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 465 def upload_collection(file, opts = {}) data, _status_code, _headers = upload_collection_with_http_info(file, opts) data end |
#upload_collection_with_http_info(file, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it.
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 |
# File 'lib/pulp_ansible_client/api/ansible_collections_api.rb', line 479 def upload_collection_with_http_info(file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.upload_collection ...' end # verify the required parameter 'file' is set if @api_client.config.client_side_validation && file.nil? fail ArgumentError, "Missing the required parameter 'file' when calling AnsibleCollectionsApi.upload_collection" end if @api_client.config.client_side_validation && !opts[:'sha256'].nil? && opts[:'sha256'].to_s.length < 1 fail ArgumentError, 'invalid value for "opts[:"sha256"]" when calling AnsibleCollectionsApi.upload_collection, the character length must be great than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'expected_namespace'].nil? && opts[:'expected_namespace'].to_s.length < 1 fail ArgumentError, 'invalid value for "opts[:"expected_namespace"]" when calling AnsibleCollectionsApi.upload_collection, the character length must be great than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'expected_name'].nil? && opts[:'expected_name'].to_s.length < 1 fail ArgumentError, 'invalid value for "opts[:"expected_name"]" when calling AnsibleCollectionsApi.upload_collection, the character length must be great than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'expected_version'].nil? && opts[:'expected_version'].to_s.length < 1 fail ArgumentError, 'invalid value for "opts[:"expected_version"]" when calling AnsibleCollectionsApi.upload_collection, the character length must be great than or equal to 1.' end # resource path local_var_path = '/ansible/collections/' # 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(['multipart/form-data', 'application/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} form_params['file'] = file form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil? form_params['expected_namespace'] = opts[:'expected_namespace'] if !opts[:'expected_namespace'].nil? form_params['expected_name'] = opts[:'expected_name'] if !opts[:'expected_name'].nil? form_params['expected_version'] = opts[:'expected_version'] if !opts[:'expected_version'].nil? # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'AsyncOperationResponse' # 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: AnsibleCollectionsApi#upload_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |