Class: PulpcoreClient::OrphansCleanupApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/orphans_cleanup_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrphansCleanupApi 



19
20
21
 
# File 'lib/pulpcore_client/api/orphans_cleanup_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pulpcore_client/api/orphans_cleanup_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cleanup(orphans_cleanup, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous orphan cleanup operation.

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.



27
28
29
30
 
# File 'lib/pulpcore_client/api/orphans_cleanup_api.rb', line 27

def cleanup(orphans_cleanup, opts = {})
  data, _status_code, _headers = cleanup_with_http_info(orphans_cleanup, opts)
  data
end

#cleanup_with_http_info(orphans_cleanup, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Trigger an asynchronous orphan cleanup operation.

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/pulpcore_client/api/orphans_cleanup_api.rb', line 37

def cleanup_with_http_info(orphans_cleanup, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrphansCleanupApi.cleanup ...'
  end
  # verify the required parameter 'orphans_cleanup' is set
  if @api_client.config.client_side_validation && orphans_cleanup.nil?
    fail ArgumentError, "Missing the required parameter 'orphans_cleanup' when calling OrphansCleanupApi.cleanup"
  end
  # resource path
  local_var_path = '/pulp/api/v3/orphans/cleanup/'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(orphans_cleanup)

  # return_type
  return_type = opts[:debug_return_type] || 'AsyncOperationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"OrphansCleanupApi.cleanup",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrphansCleanupApi#cleanup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end