Class: PulpFileClient::AcsFileApi
- Inherits:
-
Object
- Object
- PulpFileClient::AcsFileApi
- Defined in:
- lib/pulp_file_client/api/acs_file_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create(file_file_alternate_content_source, opts = {}) ⇒ FileFileAlternateContentSourceResponse
Create a file alternate content source Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
-
#create_with_http_info(file_file_alternate_content_source, opts = {}) ⇒ Array<(FileFileAlternateContentSourceResponse, Integer, Hash)>
Create a file alternate content source Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
-
#delete(file_file_alternate_content_source_href, opts = {}) ⇒ AsyncOperationResponse
Delete a file alternate content source Trigger an asynchronous delete ACS task.
-
#delete_with_http_info(file_file_alternate_content_source_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Delete a file alternate content source Trigger an asynchronous delete ACS task.
-
#initialize(api_client = ApiClient.default) ⇒ AcsFileApi
constructor
A new instance of AcsFileApi.
-
#list(opts = {}) ⇒ PaginatedfileFileAlternateContentSourceResponseList
List file alternate content sources Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
-
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedfileFileAlternateContentSourceResponseList, Integer, Hash)>
List file alternate content sources Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
-
#partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source, opts = {}) ⇒ AsyncOperationResponse
Update a file alternate content source Trigger an asynchronous partial update task.
-
#partial_update_with_http_info(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Update a file alternate content source Trigger an asynchronous partial update task.
-
#read(file_file_alternate_content_source_href, opts = {}) ⇒ FileFileAlternateContentSourceResponse
Inspect a file alternate content source Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
-
#read_with_http_info(file_file_alternate_content_source_href, opts = {}) ⇒ Array<(FileFileAlternateContentSourceResponse, Integer, Hash)>
Inspect a file alternate content source Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
-
#refresh(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) ⇒ TaskGroupOperationResponse
Trigger an asynchronous task to create Alternate Content Source content.
-
#refresh_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) ⇒ Array<(TaskGroupOperationResponse, Integer, Hash)>
Trigger an asynchronous task to create Alternate Content Source content.
-
#update(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) ⇒ AsyncOperationResponse
Update a file alternate content source Trigger an asynchronous update task.
-
#update_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Update a file alternate content source Trigger an asynchronous update task.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AcsFileApi
Returns a new instance of AcsFileApi.
19 20 21 |
# File 'lib/pulp_file_client/api/acs_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/acs_file_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create(file_file_alternate_content_source, opts = {}) ⇒ FileFileAlternateContentSourceResponse
Create a file alternate content source Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
27 28 29 30 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 27 def create(file_file_alternate_content_source, opts = {}) data, _status_code, _headers = create_with_http_info(file_file_alternate_content_source, opts) data end |
#create_with_http_info(file_file_alternate_content_source, opts = {}) ⇒ Array<(FileFileAlternateContentSourceResponse, Integer, Hash)>
Create a file alternate content source Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
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/pulp_file_client/api/acs_file_api.rb', line 37 def create_with_http_info(file_file_alternate_content_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AcsFileApi.create ...' end # verify the required parameter 'file_file_alternate_content_source' is set if @api_client.config.client_side_validation && file_file_alternate_content_source.nil? fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source' when calling AcsFileApi.create" end # resource path local_var_path = '/pulp/api/v3/acs/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_alternate_content_source) # return_type return_type = opts[:return_type] || 'FileFileAlternateContentSourceResponse' # 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: AcsFileApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete(file_file_alternate_content_source_href, opts = {}) ⇒ AsyncOperationResponse
Delete a file alternate content source Trigger an asynchronous delete ACS task
91 92 93 94 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 91 def delete(file_file_alternate_content_source_href, opts = {}) data, _status_code, _headers = delete_with_http_info(file_file_alternate_content_source_href, opts) data end |
#delete_with_http_info(file_file_alternate_content_source_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Delete a file alternate content source Trigger an asynchronous delete ACS task
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 145 146 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 101 def delete_with_http_info(file_file_alternate_content_source_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AcsFileApi.delete ...' end # verify the required parameter 'file_file_alternate_content_source_href' is set if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.delete" end # resource path local_var_path = '{file_file_alternate_content_source_href}'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_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: AcsFileApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(opts = {}) ⇒ PaginatedfileFileAlternateContentSourceResponseList
List file alternate content sources Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
162 163 164 165 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 162 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedfileFileAlternateContentSourceResponseList, Integer, Hash)>
List file alternate content sources Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 181 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AcsFileApi.list ...' end # resource path local_var_path = '/pulp/api/v3/acs/file/file/' # 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[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil? query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].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'] = opts[:'ordering'] if !opts[:'ordering'].nil? query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil? query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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] || 'PaginatedfileFileAlternateContentSourceResponseList' # 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: AcsFileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source, opts = {}) ⇒ AsyncOperationResponse
Update a file alternate content source Trigger an asynchronous partial update task
240 241 242 243 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 240 def partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source, opts = {}) data, _status_code, _headers = partial_update_with_http_info(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source, opts) data end |
#partial_update_with_http_info(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Update a file alternate content source Trigger an asynchronous partial update task
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 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 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 251 def partial_update_with_http_info(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AcsFileApi.partial_update ...' end # verify the required parameter 'file_file_alternate_content_source_href' is set if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.partial_update" end # verify the required parameter 'patchedfile_file_alternate_content_source' is set if @api_client.config.client_side_validation && patchedfile_file_alternate_content_source.nil? fail ArgumentError, "Missing the required parameter 'patchedfile_file_alternate_content_source' when calling AcsFileApi.partial_update" end # resource path local_var_path = '{file_file_alternate_content_source_href}'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_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_alternate_content_source) # 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: AcsFileApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read(file_file_alternate_content_source_href, opts = {}) ⇒ FileFileAlternateContentSourceResponse
Inspect a file alternate content source Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
311 312 313 314 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 311 def read(file_file_alternate_content_source_href, opts = {}) data, _status_code, _headers = read_with_http_info(file_file_alternate_content_source_href, opts) data end |
#read_with_http_info(file_file_alternate_content_source_href, opts = {}) ⇒ Array<(FileFileAlternateContentSourceResponse, Integer, Hash)>
Inspect a file alternate content source Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
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 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 323 def read_with_http_info(file_file_alternate_content_source_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AcsFileApi.read ...' end # verify the required parameter 'file_file_alternate_content_source_href' is set if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.read" end # resource path local_var_path = '{file_file_alternate_content_source_href}'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil? query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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] || 'FileFileAlternateContentSourceResponse' # 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: AcsFileApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#refresh(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) ⇒ TaskGroupOperationResponse
Trigger an asynchronous task to create Alternate Content Source content.
377 378 379 380 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 377 def refresh(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) data, _status_code, _headers = refresh_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts) data end |
#refresh_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) ⇒ Array<(TaskGroupOperationResponse, Integer, Hash)>
Trigger an asynchronous task to create Alternate Content Source content.
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 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 387 def refresh_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AcsFileApi.refresh ...' end # verify the required parameter 'file_file_alternate_content_source_href' is set if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.refresh" end # verify the required parameter 'file_file_alternate_content_source' is set if @api_client.config.client_side_validation && file_file_alternate_content_source.nil? fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source' when calling AcsFileApi.refresh" end # resource path local_var_path = '{file_file_alternate_content_source_href}refresh/'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_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_alternate_content_source) # return_type return_type = opts[:return_type] || 'TaskGroupOperationResponse' # 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: AcsFileApi#refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) ⇒ AsyncOperationResponse
Update a file alternate content source Trigger an asynchronous update task
446 447 448 449 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 446 def update(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) data, _status_code, _headers = update_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts) data end |
#update_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>
Update a file alternate content source Trigger an asynchronous update task
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 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
# File 'lib/pulp_file_client/api/acs_file_api.rb', line 457 def update_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AcsFileApi.update ...' end # verify the required parameter 'file_file_alternate_content_source_href' is set if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.update" end # verify the required parameter 'file_file_alternate_content_source' is set if @api_client.config.client_side_validation && file_file_alternate_content_source.nil? fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source' when calling AcsFileApi.update" end # resource path local_var_path = '{file_file_alternate_content_source_href}'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_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_alternate_content_source) # 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: AcsFileApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |