Class: PulpcoreClient::ExportersFilesystemExportsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExportersFilesystemExportsApi

Returns a new instance of ExportersFilesystemExportsApi.



19
20
21
 
# File 'lib/pulpcore_client/api/exporters_filesystem_exports_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/exporters_filesystem_exports_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(filesystem_exporter_href, filesystem_export, opts = {}) ⇒ AsyncOperationResponse

Create a filesystem export Trigger an asynchronous task to export files to the filesystem

Parameters:

  • filesystem_exporter_href (String)
  • filesystem_export (FilesystemExport)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



29
30
31
32
 
# File 'lib/pulpcore_client/api/exporters_filesystem_exports_api.rb', line 29

def create(filesystem_exporter_href, filesystem_export, opts = {})
  data, _status_code, _headers = create_with_http_info(filesystem_exporter_href, filesystem_export, opts)
  data
end

#create_with_http_info(filesystem_exporter_href, filesystem_export, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a filesystem export Trigger an asynchronous task to export files to the filesystem

Parameters:

  • filesystem_exporter_href (String)
  • filesystem_export (FilesystemExport)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>) —

    AsyncOperationResponse data, response status code and response headers



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
91
92
93
94
95
96
97
 
# File 'lib/pulpcore_client/api/exporters_filesystem_exports_api.rb', line 41

def create_with_http_info(filesystem_exporter_href, filesystem_export, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFilesystemExportsApi.create ...'
  end
  # verify the required parameter 'filesystem_exporter_href' is set
  if @api_client.config.client_side_validation && filesystem_exporter_href.nil?
    fail ArgumentError, "Missing the required parameter 'filesystem_exporter_href' when calling ExportersFilesystemExportsApi.create"
  end
  # verify the required parameter 'filesystem_export' is set
  if @api_client.config.client_side_validation && filesystem_export.nil?
    fail ArgumentError, "Missing the required parameter 'filesystem_export' when calling ExportersFilesystemExportsApi.create"
  end
  # resource path
  local_var_path = '{filesystem_exporter_href}exports/'.sub('{' + 'filesystem_exporter_href' + '}', CGI.escape(filesystem_exporter_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']) 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(filesystem_export)

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

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

  new_options = opts.merge(
    :operation => :"ExportersFilesystemExportsApi.create",
    :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: ExportersFilesystemExportsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(filesystem_filesystem_export_href, opts = {}) ⇒ nil

Delete a filesystem export Endpoint for managing FilesystemExports.

Parameters:

  • filesystem_filesystem_export_href (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

  • (nil) 


105
106
107
108
 
# File 'lib/pulpcore_client/api/exporters_filesystem_exports_api.rb', line 105

def delete(filesystem_filesystem_export_href, opts = {})
  delete_with_http_info(filesystem_filesystem_export_href, opts)
  nil
end

#delete_with_http_info(filesystem_filesystem_export_href, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a filesystem export Endpoint for managing FilesystemExports.

Parameters:

  • filesystem_filesystem_export_href (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
155
156
157
158
159
160
161
 
# File 'lib/pulpcore_client/api/exporters_filesystem_exports_api.rb', line 116

def delete_with_http_info(filesystem_filesystem_export_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFilesystemExportsApi.delete ...'
  end
  # verify the required parameter 'filesystem_filesystem_export_href' is set
  if @api_client.config.client_side_validation && filesystem_filesystem_export_href.nil?
    fail ArgumentError, "Missing the required parameter 'filesystem_filesystem_export_href' when calling ExportersFilesystemExportsApi.delete"
  end
  # resource path
  local_var_path = '{filesystem_filesystem_export_href}'.sub('{' + 'filesystem_filesystem_export_href' + '}', CGI.escape(filesystem_filesystem_export_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  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]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#list(filesystem_exporter_href, opts = {}) ⇒ PaginatedFilesystemExportResponseList

List filesystem exports Endpoint for managing FilesystemExports.

Parameters:

  • filesystem_exporter_href (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



173
174
175
176
 
# File 'lib/pulpcore_client/api/exporters_filesystem_exports_api.rb', line 173

def list(filesystem_exporter_href, opts = {})
  data, _status_code, _headers = list_with_http_info(filesystem_exporter_href, opts)
  data
end

#list_with_http_info(filesystem_exporter_href, opts = {}) ⇒ Array<(PaginatedFilesystemExportResponseList, Integer, Hash)>

List filesystem exports Endpoint for managing FilesystemExports.

Parameters:

  • filesystem_exporter_href (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



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
233
234
235
236
237
238
239
 
# File 'lib/pulpcore_client/api/exporters_filesystem_exports_api.rb', line 188

def list_with_http_info(filesystem_exporter_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFilesystemExportsApi.list ...'
  end
  # verify the required parameter 'filesystem_exporter_href' is set
  if @api_client.config.client_side_validation && filesystem_exporter_href.nil?
    fail ArgumentError, "Missing the required parameter 'filesystem_exporter_href' when calling ExportersFilesystemExportsApi.list"
  end
  # resource path
  local_var_path = '{filesystem_exporter_href}exports/'.sub('{' + 'filesystem_exporter_href' + '}', CGI.escape(filesystem_exporter_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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']) unless header_params['Accept']
  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]

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

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

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

#read(filesystem_filesystem_export_href, opts = {}) ⇒ FilesystemExportResponse

Inspect a filesystem export Endpoint for managing FilesystemExports.

Parameters:

  • filesystem_filesystem_export_href (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



249
250
251
252
 
# File 'lib/pulpcore_client/api/exporters_filesystem_exports_api.rb', line 249

def read(filesystem_filesystem_export_href, opts = {})
  data, _status_code, _headers = read_with_http_info(filesystem_filesystem_export_href, opts)
  data
end

#read_with_http_info(filesystem_filesystem_export_href, opts = {}) ⇒ Array<(FilesystemExportResponse, Integer, Hash)>

Inspect a filesystem export Endpoint for managing FilesystemExports.

Parameters:

  • filesystem_filesystem_export_href (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

  • (Array<(FilesystemExportResponse, Integer, Hash)>) —

    FilesystemExportResponse data, response status code and response headers



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
303
304
305
306
307
308
309
310
311
 
# File 'lib/pulpcore_client/api/exporters_filesystem_exports_api.rb', line 262

def read_with_http_info(filesystem_filesystem_export_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFilesystemExportsApi.read ...'
  end
  # verify the required parameter 'filesystem_filesystem_export_href' is set
  if @api_client.config.client_side_validation && filesystem_filesystem_export_href.nil?
    fail ArgumentError, "Missing the required parameter 'filesystem_filesystem_export_href' when calling ExportersFilesystemExportsApi.read"
  end
  # resource path
  local_var_path = '{filesystem_filesystem_export_href}'.sub('{' + 'filesystem_filesystem_export_href' + '}', CGI.escape(filesystem_filesystem_export_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']) unless header_params['Accept']
  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]

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

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

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