Class: PulpFileClient::DistributionsFileApi
- Inherits:
-
Object
- Object
- PulpFileClient::DistributionsFileApi
- Defined in:
- lib/pulp_file_client/api/distributions_file_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_role(file_file_distribution_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Add a role Add a role for this object to users/groups.
-
#add_role_with_http_info(file_file_distribution_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Add a role Add a role for this object to users/groups.
-
#create(file_file_distribution, opts = {}) ⇒ AsyncOperationResponse
Create a file distribution Trigger an asynchronous create task.
-
#create_with_http_info(file_file_distribution, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Create a file distribution Trigger an asynchronous create task.
-
#delete(file_file_distribution_href, opts = {}) ⇒ AsyncOperationResponse
Delete a file distribution Trigger an asynchronous delete task.
-
#delete_with_http_info(file_file_distribution_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Delete a file distribution Trigger an asynchronous delete task.
-
#initialize(api_client = ApiClient.default) ⇒ DistributionsFileApi
constructor
A new instance of DistributionsFileApi.
-
#list(opts = {}) ⇒ PaginatedfileFileDistributionResponseList
List file distributions FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients.
-
#list_roles(file_file_distribution_href, opts = {}) ⇒ ObjectRolesResponse
List roles List roles assigned to this object.
-
#list_roles_with_http_info(file_file_distribution_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>
List roles List roles assigned to this object.
-
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedfileFileDistributionResponseList, Integer, Hash)>
List file distributions FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients.
-
#my_permissions(file_file_distribution_href, opts = {}) ⇒ MyPermissionsResponse
List user permissions List permissions available to the current user on this object.
-
#my_permissions_with_http_info(file_file_distribution_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>
List user permissions List permissions available to the current user on this object.
-
#partial_update(file_file_distribution_href, patchedfile_file_distribution, opts = {}) ⇒ AsyncOperationResponse
Update a file distribution Trigger an asynchronous partial update task.
-
#partial_update_with_http_info(file_file_distribution_href, patchedfile_file_distribution, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Update a file distribution Trigger an asynchronous partial update task.
-
#read(file_file_distribution_href, opts = {}) ⇒ FileFileDistributionResponse
Inspect a file distribution FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients.
-
#read_with_http_info(file_file_distribution_href, opts = {}) ⇒ Array<(FileFileDistributionResponse, Integer, Hash)>
Inspect a file distribution FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients.
-
#remove_role(file_file_distribution_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Remove a role Remove a role for this object from users/groups.
-
#remove_role_with_http_info(file_file_distribution_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Remove a role Remove a role for this object from users/groups.
-
#set_label(file_file_distribution_href, set_label, opts = {}) ⇒ SetLabelResponse
Set a label Set a single pulp_label on the object to a specific value or null.
-
#set_label_with_http_info(file_file_distribution_href, set_label, opts = {}) ⇒ Array<(SetLabelResponse, Integer, Hash)>
Set a label Set a single pulp_label on the object to a specific value or null.
-
#unset_label(file_file_distribution_href, unset_label, opts = {}) ⇒ UnsetLabelResponse
Unset a label Unset a single pulp_label on the object.
-
#unset_label_with_http_info(file_file_distribution_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, Integer, Hash)>
Unset a label Unset a single pulp_label on the object.
-
#update(file_file_distribution_href, file_file_distribution, opts = {}) ⇒ AsyncOperationResponse
Update a file distribution Trigger an asynchronous update task.
-
#update_with_http_info(file_file_distribution_href, file_file_distribution, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Update a file distribution Trigger an asynchronous update task.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ DistributionsFileApi
Returns a new instance of DistributionsFileApi.
19 20 21 |
# File 'lib/pulp_file_client/api/distributions_file_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_file_client/api/distributions_file_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#add_role(file_file_distribution_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Add a role Add a role for this object to users/groups.
28 29 30 31 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 28 def add_role(file_file_distribution_href, nested_role, opts = {}) data, _status_code, _headers = add_role_with_http_info(file_file_distribution_href, nested_role, opts) data end |
#add_role_with_http_info(file_file_distribution_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_file_client/api/distributions_file_api.rb', line 39 def add_role_with_http_info(file_file_distribution_href, nested_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.add_role ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.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 DistributionsFileApi.add_role" end # resource path local_var_path = '{file_file_distribution_href}add_role/'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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: DistributionsFileApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create(file_file_distribution, opts = {}) ⇒ AsyncOperationResponse
Create a file distribution Trigger an asynchronous create task
97 98 99 100 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 97 def create(file_file_distribution, opts = {}) data, _status_code, _headers = create_with_http_info(file_file_distribution, opts) data end |
#create_with_http_info(file_file_distribution, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Create a file distribution Trigger an asynchronous create task
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 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 107 def create_with_http_info(file_file_distribution, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.create ...' end # verify the required parameter 'file_file_distribution' is set if @api_client.config.client_side_validation && file_file_distribution.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution' when calling DistributionsFileApi.create" end # resource path local_var_path = '/pulp/api/v3/distributions/file/file/' # 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(file_file_distribution) # 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: DistributionsFileApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete(file_file_distribution_href, opts = {}) ⇒ AsyncOperationResponse
Delete a file distribution Trigger an asynchronous delete task
161 162 163 164 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 161 def delete(file_file_distribution_href, opts = {}) data, _status_code, _headers = delete_with_http_info(file_file_distribution_href, opts) data end |
#delete_with_http_info(file_file_distribution_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Delete a file distribution Trigger an asynchronous delete task
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 171 def delete_with_http_info(file_file_distribution_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.delete ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.delete" end # resource path local_var_path = '{file_file_distribution_href}'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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']) # form parameters form_params = opts[:form_params] || {} # 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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistributionsFileApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(opts = {}) ⇒ PaginatedfileFileDistributionResponseList
List file distributions
FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.
248 249 250 251 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 248 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
#list_roles(file_file_distribution_href, opts = {}) ⇒ ObjectRolesResponse
List roles List roles assigned to this object.
363 364 365 366 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 363 def list_roles(file_file_distribution_href, opts = {}) data, _status_code, _headers = list_roles_with_http_info(file_file_distribution_href, opts) data end |
#list_roles_with_http_info(file_file_distribution_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>
List roles List roles assigned to this object.
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 415 416 417 418 419 420 421 422 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 375 def list_roles_with_http_info(file_file_distribution_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.list_roles ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.list_roles" end # resource path local_var_path = '{file_file_distribution_href}list_roles/'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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: DistributionsFileApi#list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedfileFileDistributionResponseList, Integer, Hash)>
List file distributions
FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.
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 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 347 348 349 350 351 352 353 354 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 283 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.list ...' end allowable_values = ["-base_path", "-hidden", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "base_path", "hidden", "name", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type"] 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/distributions/file/file/' # query parameters query_params = opts[:query_params] || {} query_params[:'base_path'] = opts[:'base_path'] if !opts[:'base_path'].nil? query_params[:'base_path__contains'] = opts[:'base_path__contains'] if !opts[:'base_path__contains'].nil? query_params[:'base_path__icontains'] = opts[:'base_path__icontains'] if !opts[:'base_path__icontains'].nil? query_params[:'base_path__in'] = @api_client.build_collection_param(opts[:'base_path__in'], :csv) if !opts[:'base_path__in'].nil? 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[:'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[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].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[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil? query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil? query_params[:'repository'] = opts[:'repository'] if !opts[:'repository'].nil? query_params[:'repository__in'] = @api_client.build_collection_param(opts[:'repository__in'], :csv) if !opts[:'repository__in'].nil? query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].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] || 'PaginatedfileFileDistributionResponseList' # 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: DistributionsFileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#my_permissions(file_file_distribution_href, opts = {}) ⇒ MyPermissionsResponse
List user permissions List permissions available to the current user on this object.
431 432 433 434 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 431 def (file_file_distribution_href, opts = {}) data, _status_code, _headers = (file_file_distribution_href, opts) data end |
#my_permissions_with_http_info(file_file_distribution_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>
List user permissions List permissions available to the current user on this object.
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 485 486 487 488 489 490 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 443 def (file_file_distribution_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.my_permissions ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.my_permissions" end # resource path local_var_path = '{file_file_distribution_href}my_permissions/'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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: DistributionsFileApi#my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#partial_update(file_file_distribution_href, patchedfile_file_distribution, opts = {}) ⇒ AsyncOperationResponse
Update a file distribution Trigger an asynchronous partial update task
498 499 500 501 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 498 def partial_update(file_file_distribution_href, patchedfile_file_distribution, opts = {}) data, _status_code, _headers = partial_update_with_http_info(file_file_distribution_href, patchedfile_file_distribution, opts) data end |
#partial_update_with_http_info(file_file_distribution_href, patchedfile_file_distribution, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Update a file distribution Trigger an asynchronous partial update task
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 548 549 550 551 552 553 554 555 556 557 558 559 560 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 509 def partial_update_with_http_info(file_file_distribution_href, patchedfile_file_distribution, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.partial_update ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.partial_update" end # verify the required parameter 'patchedfile_file_distribution' is set if @api_client.config.client_side_validation && patchedfile_file_distribution.nil? fail ArgumentError, "Missing the required parameter 'patchedfile_file_distribution' when calling DistributionsFileApi.partial_update" end # resource path local_var_path = '{file_file_distribution_href}'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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(patchedfile_file_distribution) # 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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistributionsFileApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read(file_file_distribution_href, opts = {}) ⇒ FileFileDistributionResponse
Inspect a file distribution
FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.
569 570 571 572 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 569 def read(file_file_distribution_href, opts = {}) data, _status_code, _headers = read_with_http_info(file_file_distribution_href, opts) data end |
#read_with_http_info(file_file_distribution_href, opts = {}) ⇒ Array<(FileFileDistributionResponse, Integer, Hash)>
Inspect a file distribution
FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 581 def read_with_http_info(file_file_distribution_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.read ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.read" end # resource path local_var_path = '{file_file_distribution_href}'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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] || 'FileFileDistributionResponse' # 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: DistributionsFileApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#remove_role(file_file_distribution_href, nested_role, opts = {}) ⇒ NestedRoleResponse
Remove a role Remove a role for this object from users/groups.
636 637 638 639 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 636 def remove_role(file_file_distribution_href, nested_role, opts = {}) data, _status_code, _headers = remove_role_with_http_info(file_file_distribution_href, nested_role, opts) data end |
#remove_role_with_http_info(file_file_distribution_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>
Remove a role Remove a role for this object from users/groups.
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 647 def remove_role_with_http_info(file_file_distribution_href, nested_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.remove_role ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.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 DistributionsFileApi.remove_role" end # resource path local_var_path = '{file_file_distribution_href}remove_role/'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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: DistributionsFileApi#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#set_label(file_file_distribution_href, set_label, opts = {}) ⇒ SetLabelResponse
Set a label Set a single pulp_label on the object to a specific value or null.
706 707 708 709 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 706 def set_label(file_file_distribution_href, set_label, opts = {}) data, _status_code, _headers = set_label_with_http_info(file_file_distribution_href, set_label, opts) data end |
#set_label_with_http_info(file_file_distribution_href, set_label, opts = {}) ⇒ Array<(SetLabelResponse, Integer, Hash)>
Set a label Set a single pulp_label on the object to a specific value or null.
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 717 def set_label_with_http_info(file_file_distribution_href, set_label, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.set_label ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.set_label" end # verify the required parameter 'set_label' is set if @api_client.config.client_side_validation && set_label.nil? fail ArgumentError, "Missing the required parameter 'set_label' when calling DistributionsFileApi.set_label" end # resource path local_var_path = '{file_file_distribution_href}set_label/'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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(set_label) # return_type return_type = opts[:return_type] || 'SetLabelResponse' # 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: DistributionsFileApi#set_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#unset_label(file_file_distribution_href, unset_label, opts = {}) ⇒ UnsetLabelResponse
Unset a label Unset a single pulp_label on the object.
776 777 778 779 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 776 def unset_label(file_file_distribution_href, unset_label, opts = {}) data, _status_code, _headers = unset_label_with_http_info(file_file_distribution_href, unset_label, opts) data end |
#unset_label_with_http_info(file_file_distribution_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, Integer, Hash)>
Unset a label Unset a single pulp_label on the object.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 787 def unset_label_with_http_info(file_file_distribution_href, unset_label, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.unset_label ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.unset_label" end # verify the required parameter 'unset_label' is set if @api_client.config.client_side_validation && unset_label.nil? fail ArgumentError, "Missing the required parameter 'unset_label' when calling DistributionsFileApi.unset_label" end # resource path local_var_path = '{file_file_distribution_href}unset_label/'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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(unset_label) # return_type return_type = opts[:return_type] || 'UnsetLabelResponse' # 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: DistributionsFileApi#unset_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(file_file_distribution_href, file_file_distribution, opts = {}) ⇒ AsyncOperationResponse
Update a file distribution Trigger an asynchronous update task
846 847 848 849 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 846 def update(file_file_distribution_href, file_file_distribution, opts = {}) data, _status_code, _headers = update_with_http_info(file_file_distribution_href, file_file_distribution, opts) data end |
#update_with_http_info(file_file_distribution_href, file_file_distribution, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Update a file distribution Trigger an asynchronous update task
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 |
# File 'lib/pulp_file_client/api/distributions_file_api.rb', line 857 def update_with_http_info(file_file_distribution_href, file_file_distribution, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.update ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.update" end # verify the required parameter 'file_file_distribution' is set if @api_client.config.client_side_validation && file_file_distribution.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution' when calling DistributionsFileApi.update" end # resource path local_var_path = '{file_file_distribution_href}'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_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(file_file_distribution) # 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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistributionsFileApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |