Class: PulpFileClient::ExportersFilesystemApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_file_client/api/exporters_filesystem_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExportersFilesystemApi

Returns a new instance of ExportersFilesystemApi.



19
20
21
 
# File 'lib/pulp_file_client/api/exporters_filesystem_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/exporters_filesystem_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(file_file_filesystem_exporter, opts = {}) ⇒ FileFileFilesystemExporterResponse

Create a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 27

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

#create_with_http_info(file_file_filesystem_exporter, opts = {}) ⇒ Array<(FileFileFilesystemExporterResponse, Integer, Hash)>

Create a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

Returns:



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/exporters_filesystem_api.rb', line 37

def create_with_http_info(file_file_filesystem_exporter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.create ...'
  end
  # verify the required parameter 'file_file_filesystem_exporter' is set
  if @api_client.config.client_side_validation && file_file_filesystem_exporter.nil?
    fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter' when calling ExportersFilesystemApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/exporters/file/filesystem/'

  # 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_filesystem_exporter) 

  # return_type
  return_type = opts[:return_type] || 'FileFileFilesystemExporterResponse' 

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

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

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

Delete a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 91

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

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

Delete a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 101

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

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

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

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

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

#list(opts = {}) ⇒ PaginatedfileFileFilesystemExporterResponseList

List file filesystem exporters FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



157
158
159
160
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 157

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

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

List file filesystem exporters FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
217
218
219
220
221
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 173

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/exporters/file/filesystem/'

  # 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__in'] = opts[:'name__in'] if !opts[:'name__in'].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] || 'PaginatedfileFileFilesystemExporterResponseList' 

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

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

#partial_update(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter, opts = {}) ⇒ FileFileFilesystemExporterResponse

Update a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

  • file_file_filesystem_exporter_href (String)
  • patchedfile_file_filesystem_exporter (PatchedfileFileFilesystemExporter)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



229
230
231
232
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 229

def partial_update(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter, opts)
  data
end

#partial_update_with_http_info(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter, opts = {}) ⇒ Array<(FileFileFilesystemExporterResponse, Integer, Hash)>

Update a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

  • file_file_filesystem_exporter_href (String)
  • patchedfile_file_filesystem_exporter (PatchedfileFileFilesystemExporter)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



240
241
242
243
244
245
246
247
248
249
250
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
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 240

def partial_update_with_http_info(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.partial_update ...'
  end
  # verify the required parameter 'file_file_filesystem_exporter_href' is set
  if @api_client.config.client_side_validation && file_file_filesystem_exporter_href.nil?
    fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter_href' when calling ExportersFilesystemApi.partial_update"
  end
  # verify the required parameter 'patchedfile_file_filesystem_exporter' is set
  if @api_client.config.client_side_validation && patchedfile_file_filesystem_exporter.nil?
    fail ArgumentError, "Missing the required parameter 'patchedfile_file_filesystem_exporter' when calling ExportersFilesystemApi.partial_update"
  end
  # resource path
  local_var_path = '{file_file_filesystem_exporter_href}'.sub('{' + 'file_file_filesystem_exporter_href' + '}', CGI.escape(file_file_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'])
  # 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_filesystem_exporter) 

  # return_type
  return_type = opts[:return_type] || 'FileFileFilesystemExporterResponse' 

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

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

#read(file_file_filesystem_exporter_href, opts = {}) ⇒ FileFileFilesystemExporterResponse

Inspect a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



300
301
302
303
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 300

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

#read_with_http_info(file_file_filesystem_exporter_href, opts = {}) ⇒ Array<(FileFileFilesystemExporterResponse, Integer, Hash)>

Inspect a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
355
356
357
358
359
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 312

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

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

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

#update(file_file_filesystem_exporter_href, file_file_filesystem_exporter, opts = {}) ⇒ FileFileFilesystemExporterResponse

Update a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

  • file_file_filesystem_exporter_href (String)
  • file_file_filesystem_exporter (FileFileFilesystemExporter)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



367
368
369
370
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 367

def update(file_file_filesystem_exporter_href, file_file_filesystem_exporter, opts = {})
  data, _status_code, _headers = update_with_http_info(file_file_filesystem_exporter_href, file_file_filesystem_exporter, opts)
  data
end

#update_with_http_info(file_file_filesystem_exporter_href, file_file_filesystem_exporter, opts = {}) ⇒ Array<(FileFileFilesystemExporterResponse, Integer, Hash)>

Update a file filesystem exporter FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.

Parameters:

  • file_file_filesystem_exporter_href (String)
  • file_file_filesystem_exporter (FileFileFilesystemExporter)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
423
424
425
426
427
428
429
 
# File 'lib/pulp_file_client/api/exporters_filesystem_api.rb', line 378

def update_with_http_info(file_file_filesystem_exporter_href, file_file_filesystem_exporter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.update ...'
  end
  # verify the required parameter 'file_file_filesystem_exporter_href' is set
  if @api_client.config.client_side_validation && file_file_filesystem_exporter_href.nil?
    fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter_href' when calling ExportersFilesystemApi.update"
  end
  # verify the required parameter 'file_file_filesystem_exporter' is set
  if @api_client.config.client_side_validation && file_file_filesystem_exporter.nil?
    fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter' when calling ExportersFilesystemApi.update"
  end
  # resource path
  local_var_path = '{file_file_filesystem_exporter_href}'.sub('{' + 'file_file_filesystem_exporter_href' + '}', CGI.escape(file_file_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'])
  # 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_filesystem_exporter) 

  # return_type
  return_type = opts[:return_type] || 'FileFileFilesystemExporterResponse' 

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

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