Class: PulpFileClient::ExportersFileExportsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExportersFileExportsApi

Returns a new instance of ExportersFileExportsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create(file_filesystem_export_href, publication_export, opts = {}) ⇒ AsyncOperationResponse

Create an export Trigger an asynchronous task to export a file publication.

Parameters:

  • file_filesystem_export_href (String)
  • publication_export (PublicationExport)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/pulp_file_client/api/exporters_file_exports_api.rb', line 28

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

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

Create an export Trigger an asynchronous task to export a file publication.

Parameters:

  • file_filesystem_export_href (String)
  • publication_export (PublicationExport)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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/exporters_file_exports_api.rb', line 39

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

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

  # 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: ExportersFileExportsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an export FilesystemExports provide a history of previous exports.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


97
98
99
100
 
# File 'lib/pulp_file_client/api/exporters_file_exports_api.rb', line 97

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

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

Delete an export FilesystemExports provide a history of previous exports.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_with_http_info(file_filesystem_export_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFileExportsApi.delete ...'
  end
  # verify the required parameter 'file_filesystem_export_href' is set
  if @api_client.config.client_side_validation && file_filesystem_export_href.nil?
    fail ArgumentError, "Missing the required parameter 'file_filesystem_export_href' when calling ExportersFileExportsApi.delete"
  end
  # resource path
  local_var_path = '{file_filesystem_export_href}'.sub('{' + 'file_filesystem_export_href' + '}', CGI.escape(file_filesystem_export_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: ExportersFileExportsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(file_file_filesystem_exporter_href, opts = {}) ⇒ PaginatedExportResponseList

List exports FilesystemExports provide a history of previous exports.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :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:



162
163
164
165
 
# File 'lib/pulp_file_client/api/exporters_file_exports_api.rb', line 162

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

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

List exports FilesystemExports provide a history of previous exports.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :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:

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

    PaginatedExportResponseList data, response status code and response headers



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
222
223
224
225
226
227
 
# File 'lib/pulp_file_client/api/exporters_file_exports_api.rb', line 177

def list_with_http_info(file_file_filesystem_exporter_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersFileExportsApi.list ...'
  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 ExportersFileExportsApi.list"
  end
  # resource path
  local_var_path = '{file_file_filesystem_exporter_href}exports/'.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[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'PaginatedExportResponseList' 

  # 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: ExportersFileExportsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(file_filesystem_export_href, opts = {}) ⇒ ExportResponse

Inspect an export FilesystemExports provide a history of previous exports.

Parameters:

  • file_filesystem_export_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:



236
237
238
239
 
# File 'lib/pulp_file_client/api/exporters_file_exports_api.rb', line 236

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

#read_with_http_info(file_filesystem_export_href, opts = {}) ⇒ Array<(ExportResponse, Integer, Hash)>

Inspect an export FilesystemExports provide a history of previous exports.

Parameters:

  • file_filesystem_export_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:

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

    ExportResponse data, response status code and response headers



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
292
293
294
295
 
# File 'lib/pulp_file_client/api/exporters_file_exports_api.rb', line 248

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

  # 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: ExportersFileExportsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end