pulp_file_client 1.8.0.dev1621916753 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -21
  3. data/lib/pulp_file_client.rb +0 -9
  4. data/lib/pulp_file_client/version.rb +1 -1
  5. metadata +4 -40
  6. data/docs/ExportResponse.md +0 -25
  7. data/docs/ExportersFileExportsApi.md +0 -243
  8. data/docs/ExportersFilesystemApi.md +0 -362
  9. data/docs/FileFileFilesystemExporter.md +0 -19
  10. data/docs/FileFileFilesystemExporterResponse.md +0 -23
  11. data/docs/PaginatedExportResponseList.md +0 -23
  12. data/docs/PaginatedfileFileFilesystemExporterResponseList.md +0 -23
  13. data/docs/PatchedfileFileFilesystemExporter.md +0 -19
  14. data/docs/PublicationExport.md +0 -17
  15. data/lib/pulp_file_client/api/exporters_file_exports_api.rb +0 -297
  16. data/lib/pulp_file_client/api/exporters_filesystem_api.rb +0 -442
  17. data/lib/pulp_file_client/models/export_response.rb +0 -250
  18. data/lib/pulp_file_client/models/file_file_filesystem_exporter.rb +0 -228
  19. data/lib/pulp_file_client/models/file_file_filesystem_exporter_response.rb +0 -247
  20. data/lib/pulp_file_client/models/paginated_export_response_list.rb +0 -237
  21. data/lib/pulp_file_client/models/paginatedfile_file_filesystem_exporter_response_list.rb +0 -237
  22. data/lib/pulp_file_client/models/patchedfile_file_filesystem_exporter.rb +0 -218
  23. data/lib/pulp_file_client/models/publication_export.rb +0 -213
  24. data/spec/api/exporters_file_exports_api_spec.rb +0 -91
  25. data/spec/api/exporters_filesystem_api_spec.rb +0 -120
  26. data/spec/models/export_response_spec.rb +0 -65
  27. data/spec/models/file_file_filesystem_exporter_response_spec.rb +0 -59
  28. data/spec/models/file_file_filesystem_exporter_spec.rb +0 -47
  29. data/spec/models/paginated_export_response_list_spec.rb +0 -59
  30. data/spec/models/paginatedfile_file_filesystem_exporter_response_list_spec.rb +0 -59
  31. data/spec/models/patchedfile_file_filesystem_exporter_spec.rb +0 -47
  32. data/spec/models/publication_export_spec.rb +0 -41
@@ -1,19 +0,0 @@
1
- # PulpFileClient::PatchedfileFileFilesystemExporter
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | Unique name of the file system exporter. | [optional]
8
- **path** | **String** | File system location to export to. | [optional]
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'PulpFileClient'
14
-
15
- instance = PulpFileClient::PatchedfileFileFilesystemExporter.new(name: null,
16
- path: null)
17
- ```
18
-
19
-
@@ -1,17 +0,0 @@
1
- # PulpFileClient::PublicationExport
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **publication** | **String** | A URI of the publication to be exported. |
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'PulpFileClient'
13
-
14
- instance = PulpFileClient::PublicationExport.new(publication: null)
15
- ```
16
-
17
-
@@ -1,297 +0,0 @@
1
- =begin
2
- #Pulp 3 API
3
-
4
- #Fetch, Upload, Organize, and Distribute Software Packages
5
-
6
- The version of the OpenAPI document: v3
7
- Contact: pulp-list@redhat.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.3
10
-
11
- =end
12
-
13
- require 'cgi'
14
-
15
- module PulpFileClient
16
- class ExportersFileExportsApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
- # Create an export
23
- # Trigger an asynchronous task to export a file publication.
24
- # @param file_file_filesystem_exporter_href [String]
25
- # @param publication_export [PublicationExport]
26
- # @param [Hash] opts the optional parameters
27
- # @return [AsyncOperationResponse]
28
- def create(file_file_filesystem_exporter_href, publication_export, opts = {})
29
- data, _status_code, _headers = create_with_http_info(file_file_filesystem_exporter_href, publication_export, opts)
30
- data
31
- end
32
-
33
- # Create an export
34
- # Trigger an asynchronous task to export a file publication.
35
- # @param file_file_filesystem_exporter_href [String]
36
- # @param publication_export [PublicationExport]
37
- # @param [Hash] opts the optional parameters
38
- # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
39
- def create_with_http_info(file_file_filesystem_exporter_href, publication_export, opts = {})
40
- if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: ExportersFileExportsApi.create ...'
42
- end
43
- # verify the required parameter 'file_file_filesystem_exporter_href' is set
44
- if @api_client.config.client_side_validation && file_file_filesystem_exporter_href.nil?
45
- fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter_href' when calling ExportersFileExportsApi.create"
46
- end
47
- # verify the required parameter 'publication_export' is set
48
- if @api_client.config.client_side_validation && publication_export.nil?
49
- fail ArgumentError, "Missing the required parameter 'publication_export' when calling ExportersFileExportsApi.create"
50
- end
51
- # resource path
52
- 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', '/'))
53
-
54
- # query parameters
55
- query_params = opts[:query_params] || {}
56
-
57
- # header parameters
58
- header_params = opts[:header_params] || {}
59
- # HTTP header 'Accept' (if needed)
60
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
61
- # HTTP header 'Content-Type'
62
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
63
-
64
- # form parameters
65
- form_params = opts[:form_params] || {}
66
-
67
- # http body (model)
68
- post_body = opts[:body] || @api_client.object_to_http_body(publication_export)
69
-
70
- # return_type
71
- return_type = opts[:return_type] || 'AsyncOperationResponse'
72
-
73
- # auth_names
74
- auth_names = opts[:auth_names] || ['basicAuth']
75
-
76
- new_options = opts.merge(
77
- :header_params => header_params,
78
- :query_params => query_params,
79
- :form_params => form_params,
80
- :body => post_body,
81
- :auth_names => auth_names,
82
- :return_type => return_type
83
- )
84
-
85
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
86
- if @api_client.config.debugging
87
- @api_client.config.logger.debug "API called: ExportersFileExportsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
- end
89
- return data, status_code, headers
90
- end
91
-
92
- # Delete an export
93
- # FilesystemExports provide a history of previous exports.
94
- # @param file_filesystem_export_href [String]
95
- # @param [Hash] opts the optional parameters
96
- # @return [nil]
97
- def delete(file_filesystem_export_href, opts = {})
98
- delete_with_http_info(file_filesystem_export_href, opts)
99
- nil
100
- end
101
-
102
- # Delete an export
103
- # FilesystemExports provide a history of previous exports.
104
- # @param file_filesystem_export_href [String]
105
- # @param [Hash] opts the optional parameters
106
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
107
- def delete_with_http_info(file_filesystem_export_href, opts = {})
108
- if @api_client.config.debugging
109
- @api_client.config.logger.debug 'Calling API: ExportersFileExportsApi.delete ...'
110
- end
111
- # verify the required parameter 'file_filesystem_export_href' is set
112
- if @api_client.config.client_side_validation && file_filesystem_export_href.nil?
113
- fail ArgumentError, "Missing the required parameter 'file_filesystem_export_href' when calling ExportersFileExportsApi.delete"
114
- end
115
- # resource path
116
- local_var_path = '{file_filesystem_export_href}'.sub('{' + 'file_filesystem_export_href' + '}', CGI.escape(file_filesystem_export_href.to_s).gsub('%2F', '/'))
117
-
118
- # query parameters
119
- query_params = opts[:query_params] || {}
120
-
121
- # header parameters
122
- header_params = opts[:header_params] || {}
123
-
124
- # form parameters
125
- form_params = opts[:form_params] || {}
126
-
127
- # http body (model)
128
- post_body = opts[:body]
129
-
130
- # return_type
131
- return_type = opts[:return_type]
132
-
133
- # auth_names
134
- auth_names = opts[:auth_names] || ['basicAuth']
135
-
136
- new_options = opts.merge(
137
- :header_params => header_params,
138
- :query_params => query_params,
139
- :form_params => form_params,
140
- :body => post_body,
141
- :auth_names => auth_names,
142
- :return_type => return_type
143
- )
144
-
145
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
146
- if @api_client.config.debugging
147
- @api_client.config.logger.debug "API called: ExportersFileExportsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
148
- end
149
- return data, status_code, headers
150
- end
151
-
152
- # List exports
153
- # FilesystemExports provide a history of previous exports.
154
- # @param file_file_filesystem_exporter_href [String]
155
- # @param [Hash] opts the optional parameters
156
- # @option opts [Integer] :limit Number of results to return per page.
157
- # @option opts [Integer] :offset The initial index from which to return the results.
158
- # @option opts [String] :ordering Which field to use when ordering the results.
159
- # @option opts [String] :fields A list of fields to include in the response.
160
- # @option opts [String] :exclude_fields A list of fields to exclude from the response.
161
- # @return [PaginatedExportResponseList]
162
- def list(file_file_filesystem_exporter_href, opts = {})
163
- data, _status_code, _headers = list_with_http_info(file_file_filesystem_exporter_href, opts)
164
- data
165
- end
166
-
167
- # List exports
168
- # FilesystemExports provide a history of previous exports.
169
- # @param file_file_filesystem_exporter_href [String]
170
- # @param [Hash] opts the optional parameters
171
- # @option opts [Integer] :limit Number of results to return per page.
172
- # @option opts [Integer] :offset The initial index from which to return the results.
173
- # @option opts [String] :ordering Which field to use when ordering the results.
174
- # @option opts [String] :fields A list of fields to include in the response.
175
- # @option opts [String] :exclude_fields A list of fields to exclude from the response.
176
- # @return [Array<(PaginatedExportResponseList, Integer, Hash)>] PaginatedExportResponseList data, response status code and response headers
177
- def list_with_http_info(file_file_filesystem_exporter_href, opts = {})
178
- if @api_client.config.debugging
179
- @api_client.config.logger.debug 'Calling API: ExportersFileExportsApi.list ...'
180
- end
181
- # verify the required parameter 'file_file_filesystem_exporter_href' is set
182
- if @api_client.config.client_side_validation && file_file_filesystem_exporter_href.nil?
183
- fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter_href' when calling ExportersFileExportsApi.list"
184
- end
185
- # resource path
186
- 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', '/'))
187
-
188
- # query parameters
189
- query_params = opts[:query_params] || {}
190
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
191
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
192
- query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
193
- query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
194
- query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
195
-
196
- # header parameters
197
- header_params = opts[:header_params] || {}
198
- # HTTP header 'Accept' (if needed)
199
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
200
-
201
- # form parameters
202
- form_params = opts[:form_params] || {}
203
-
204
- # http body (model)
205
- post_body = opts[:body]
206
-
207
- # return_type
208
- return_type = opts[:return_type] || 'PaginatedExportResponseList'
209
-
210
- # auth_names
211
- auth_names = opts[:auth_names] || ['basicAuth']
212
-
213
- new_options = opts.merge(
214
- :header_params => header_params,
215
- :query_params => query_params,
216
- :form_params => form_params,
217
- :body => post_body,
218
- :auth_names => auth_names,
219
- :return_type => return_type
220
- )
221
-
222
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
223
- if @api_client.config.debugging
224
- @api_client.config.logger.debug "API called: ExportersFileExportsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
225
- end
226
- return data, status_code, headers
227
- end
228
-
229
- # Inspect an export
230
- # FilesystemExports provide a history of previous exports.
231
- # @param file_filesystem_export_href [String]
232
- # @param [Hash] opts the optional parameters
233
- # @option opts [String] :fields A list of fields to include in the response.
234
- # @option opts [String] :exclude_fields A list of fields to exclude from the response.
235
- # @return [ExportResponse]
236
- def read(file_filesystem_export_href, opts = {})
237
- data, _status_code, _headers = read_with_http_info(file_filesystem_export_href, opts)
238
- data
239
- end
240
-
241
- # Inspect an export
242
- # FilesystemExports provide a history of previous exports.
243
- # @param file_filesystem_export_href [String]
244
- # @param [Hash] opts the optional parameters
245
- # @option opts [String] :fields A list of fields to include in the response.
246
- # @option opts [String] :exclude_fields A list of fields to exclude from the response.
247
- # @return [Array<(ExportResponse, Integer, Hash)>] ExportResponse data, response status code and response headers
248
- def read_with_http_info(file_filesystem_export_href, opts = {})
249
- if @api_client.config.debugging
250
- @api_client.config.logger.debug 'Calling API: ExportersFileExportsApi.read ...'
251
- end
252
- # verify the required parameter 'file_filesystem_export_href' is set
253
- if @api_client.config.client_side_validation && file_filesystem_export_href.nil?
254
- fail ArgumentError, "Missing the required parameter 'file_filesystem_export_href' when calling ExportersFileExportsApi.read"
255
- end
256
- # resource path
257
- local_var_path = '{file_filesystem_export_href}'.sub('{' + 'file_filesystem_export_href' + '}', CGI.escape(file_filesystem_export_href.to_s).gsub('%2F', '/'))
258
-
259
- # query parameters
260
- query_params = opts[:query_params] || {}
261
- query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
262
- query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
263
-
264
- # header parameters
265
- header_params = opts[:header_params] || {}
266
- # HTTP header 'Accept' (if needed)
267
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
268
-
269
- # form parameters
270
- form_params = opts[:form_params] || {}
271
-
272
- # http body (model)
273
- post_body = opts[:body]
274
-
275
- # return_type
276
- return_type = opts[:return_type] || 'ExportResponse'
277
-
278
- # auth_names
279
- auth_names = opts[:auth_names] || ['basicAuth']
280
-
281
- new_options = opts.merge(
282
- :header_params => header_params,
283
- :query_params => query_params,
284
- :form_params => form_params,
285
- :body => post_body,
286
- :auth_names => auth_names,
287
- :return_type => return_type
288
- )
289
-
290
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
291
- if @api_client.config.debugging
292
- @api_client.config.logger.debug "API called: ExportersFileExportsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
293
- end
294
- return data, status_code, headers
295
- end
296
- end
297
- end
@@ -1,442 +0,0 @@
1
- =begin
2
- #Pulp 3 API
3
-
4
- #Fetch, Upload, Organize, and Distribute Software Packages
5
-
6
- The version of the OpenAPI document: v3
7
- Contact: pulp-list@redhat.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.3
10
-
11
- =end
12
-
13
- require 'cgi'
14
-
15
- module PulpFileClient
16
- class ExportersFilesystemApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
- # Create a file filesystem exporter
23
- # 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.
24
- # @param file_file_filesystem_exporter [FileFileFilesystemExporter]
25
- # @param [Hash] opts the optional parameters
26
- # @return [FileFileFilesystemExporterResponse]
27
- def create(file_file_filesystem_exporter, opts = {})
28
- data, _status_code, _headers = create_with_http_info(file_file_filesystem_exporter, opts)
29
- data
30
- end
31
-
32
- # Create a file filesystem exporter
33
- # 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.
34
- # @param file_file_filesystem_exporter [FileFileFilesystemExporter]
35
- # @param [Hash] opts the optional parameters
36
- # @return [Array<(FileFileFilesystemExporterResponse, Integer, Hash)>] FileFileFilesystemExporterResponse data, response status code and response headers
37
- def create_with_http_info(file_file_filesystem_exporter, opts = {})
38
- if @api_client.config.debugging
39
- @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.create ...'
40
- end
41
- # verify the required parameter 'file_file_filesystem_exporter' is set
42
- if @api_client.config.client_side_validation && file_file_filesystem_exporter.nil?
43
- fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter' when calling ExportersFilesystemApi.create"
44
- end
45
- # resource path
46
- local_var_path = '/pulp/api/v3/exporters/file/filesystem/'
47
-
48
- # query parameters
49
- query_params = opts[:query_params] || {}
50
-
51
- # header parameters
52
- header_params = opts[:header_params] || {}
53
- # HTTP header 'Accept' (if needed)
54
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
- # HTTP header 'Content-Type'
56
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
57
-
58
- # form parameters
59
- form_params = opts[:form_params] || {}
60
-
61
- # http body (model)
62
- post_body = opts[:body] || @api_client.object_to_http_body(file_file_filesystem_exporter)
63
-
64
- # return_type
65
- return_type = opts[:return_type] || 'FileFileFilesystemExporterResponse'
66
-
67
- # auth_names
68
- auth_names = opts[:auth_names] || ['basicAuth']
69
-
70
- new_options = opts.merge(
71
- :header_params => header_params,
72
- :query_params => query_params,
73
- :form_params => form_params,
74
- :body => post_body,
75
- :auth_names => auth_names,
76
- :return_type => return_type
77
- )
78
-
79
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
80
- if @api_client.config.debugging
81
- @api_client.config.logger.debug "API called: ExportersFilesystemApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
- end
83
- return data, status_code, headers
84
- end
85
-
86
- # Delete a file filesystem exporter
87
- # Trigger an asynchronous delete task
88
- # @param file_file_filesystem_exporter_href [String]
89
- # @param [Hash] opts the optional parameters
90
- # @return [AsyncOperationResponse]
91
- def delete(file_file_filesystem_exporter_href, opts = {})
92
- data, _status_code, _headers = delete_with_http_info(file_file_filesystem_exporter_href, opts)
93
- data
94
- end
95
-
96
- # Delete a file filesystem exporter
97
- # Trigger an asynchronous delete task
98
- # @param file_file_filesystem_exporter_href [String]
99
- # @param [Hash] opts the optional parameters
100
- # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
101
- def delete_with_http_info(file_file_filesystem_exporter_href, opts = {})
102
- if @api_client.config.debugging
103
- @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.delete ...'
104
- end
105
- # verify the required parameter 'file_file_filesystem_exporter_href' is set
106
- if @api_client.config.client_side_validation && file_file_filesystem_exporter_href.nil?
107
- fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter_href' when calling ExportersFilesystemApi.delete"
108
- end
109
- # resource path
110
- 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', '/'))
111
-
112
- # query parameters
113
- query_params = opts[:query_params] || {}
114
-
115
- # header parameters
116
- header_params = opts[:header_params] || {}
117
- # HTTP header 'Accept' (if needed)
118
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
119
-
120
- # form parameters
121
- form_params = opts[:form_params] || {}
122
-
123
- # http body (model)
124
- post_body = opts[:body]
125
-
126
- # return_type
127
- return_type = opts[:return_type] || 'AsyncOperationResponse'
128
-
129
- # auth_names
130
- auth_names = opts[:auth_names] || ['basicAuth']
131
-
132
- new_options = opts.merge(
133
- :header_params => header_params,
134
- :query_params => query_params,
135
- :form_params => form_params,
136
- :body => post_body,
137
- :auth_names => auth_names,
138
- :return_type => return_type
139
- )
140
-
141
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
142
- if @api_client.config.debugging
143
- @api_client.config.logger.debug "API called: ExportersFilesystemApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
- end
145
- return data, status_code, headers
146
- end
147
-
148
- # List file filesystem exporters
149
- # 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.
150
- # @param [Hash] opts the optional parameters
151
- # @option opts [Integer] :limit Number of results to return per page.
152
- # @option opts [String] :name
153
- # @option opts [String] :name__contains Filter results where name contains value
154
- # @option opts [String] :name__icontains Filter results where name contains value
155
- # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
156
- # @option opts [String] :name__startswith Filter results where name starts with value
157
- # @option opts [Integer] :offset The initial index from which to return the results.
158
- # @option opts [String] :ordering Which field to use when ordering the results.
159
- # @option opts [String] :fields A list of fields to include in the response.
160
- # @option opts [String] :exclude_fields A list of fields to exclude from the response.
161
- # @return [PaginatedfileFileFilesystemExporterResponseList]
162
- def list(opts = {})
163
- data, _status_code, _headers = list_with_http_info(opts)
164
- data
165
- end
166
-
167
- # List file filesystem exporters
168
- # 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.
169
- # @param [Hash] opts the optional parameters
170
- # @option opts [Integer] :limit Number of results to return per page.
171
- # @option opts [String] :name
172
- # @option opts [String] :name__contains Filter results where name contains value
173
- # @option opts [String] :name__icontains Filter results where name contains value
174
- # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
175
- # @option opts [String] :name__startswith Filter results where name starts with value
176
- # @option opts [Integer] :offset The initial index from which to return the results.
177
- # @option opts [String] :ordering Which field to use when ordering the results.
178
- # @option opts [String] :fields A list of fields to include in the response.
179
- # @option opts [String] :exclude_fields A list of fields to exclude from the response.
180
- # @return [Array<(PaginatedfileFileFilesystemExporterResponseList, Integer, Hash)>] PaginatedfileFileFilesystemExporterResponseList data, response status code and response headers
181
- def list_with_http_info(opts = {})
182
- if @api_client.config.debugging
183
- @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.list ...'
184
- end
185
- # resource path
186
- local_var_path = '/pulp/api/v3/exporters/file/filesystem/'
187
-
188
- # query parameters
189
- query_params = opts[:query_params] || {}
190
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
191
- query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
192
- query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
193
- query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
194
- query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
195
- query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
196
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
197
- query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
198
- query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
199
- query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
200
-
201
- # header parameters
202
- header_params = opts[:header_params] || {}
203
- # HTTP header 'Accept' (if needed)
204
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
205
-
206
- # form parameters
207
- form_params = opts[:form_params] || {}
208
-
209
- # http body (model)
210
- post_body = opts[:body]
211
-
212
- # return_type
213
- return_type = opts[:return_type] || 'PaginatedfileFileFilesystemExporterResponseList'
214
-
215
- # auth_names
216
- auth_names = opts[:auth_names] || ['basicAuth']
217
-
218
- new_options = opts.merge(
219
- :header_params => header_params,
220
- :query_params => query_params,
221
- :form_params => form_params,
222
- :body => post_body,
223
- :auth_names => auth_names,
224
- :return_type => return_type
225
- )
226
-
227
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
228
- if @api_client.config.debugging
229
- @api_client.config.logger.debug "API called: ExportersFilesystemApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
230
- end
231
- return data, status_code, headers
232
- end
233
-
234
- # Update a file filesystem exporter
235
- # Trigger an asynchronous partial update task
236
- # @param file_file_filesystem_exporter_href [String]
237
- # @param patchedfile_file_filesystem_exporter [PatchedfileFileFilesystemExporter]
238
- # @param [Hash] opts the optional parameters
239
- # @return [AsyncOperationResponse]
240
- def partial_update(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter, opts = {})
241
- data, _status_code, _headers = partial_update_with_http_info(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter, opts)
242
- data
243
- end
244
-
245
- # Update a file filesystem exporter
246
- # Trigger an asynchronous partial update task
247
- # @param file_file_filesystem_exporter_href [String]
248
- # @param patchedfile_file_filesystem_exporter [PatchedfileFileFilesystemExporter]
249
- # @param [Hash] opts the optional parameters
250
- # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
251
- def partial_update_with_http_info(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter, opts = {})
252
- if @api_client.config.debugging
253
- @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.partial_update ...'
254
- end
255
- # verify the required parameter 'file_file_filesystem_exporter_href' is set
256
- if @api_client.config.client_side_validation && file_file_filesystem_exporter_href.nil?
257
- fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter_href' when calling ExportersFilesystemApi.partial_update"
258
- end
259
- # verify the required parameter 'patchedfile_file_filesystem_exporter' is set
260
- if @api_client.config.client_side_validation && patchedfile_file_filesystem_exporter.nil?
261
- fail ArgumentError, "Missing the required parameter 'patchedfile_file_filesystem_exporter' when calling ExportersFilesystemApi.partial_update"
262
- end
263
- # resource path
264
- 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', '/'))
265
-
266
- # query parameters
267
- query_params = opts[:query_params] || {}
268
-
269
- # header parameters
270
- header_params = opts[:header_params] || {}
271
- # HTTP header 'Accept' (if needed)
272
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
273
- # HTTP header 'Content-Type'
274
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
275
-
276
- # form parameters
277
- form_params = opts[:form_params] || {}
278
-
279
- # http body (model)
280
- post_body = opts[:body] || @api_client.object_to_http_body(patchedfile_file_filesystem_exporter)
281
-
282
- # return_type
283
- return_type = opts[:return_type] || 'AsyncOperationResponse'
284
-
285
- # auth_names
286
- auth_names = opts[:auth_names] || ['basicAuth']
287
-
288
- new_options = opts.merge(
289
- :header_params => header_params,
290
- :query_params => query_params,
291
- :form_params => form_params,
292
- :body => post_body,
293
- :auth_names => auth_names,
294
- :return_type => return_type
295
- )
296
-
297
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
298
- if @api_client.config.debugging
299
- @api_client.config.logger.debug "API called: ExportersFilesystemApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
300
- end
301
- return data, status_code, headers
302
- end
303
-
304
- # Inspect a file filesystem exporter
305
- # 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.
306
- # @param file_file_filesystem_exporter_href [String]
307
- # @param [Hash] opts the optional parameters
308
- # @option opts [String] :fields A list of fields to include in the response.
309
- # @option opts [String] :exclude_fields A list of fields to exclude from the response.
310
- # @return [FileFileFilesystemExporterResponse]
311
- def read(file_file_filesystem_exporter_href, opts = {})
312
- data, _status_code, _headers = read_with_http_info(file_file_filesystem_exporter_href, opts)
313
- data
314
- end
315
-
316
- # Inspect a file filesystem exporter
317
- # 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.
318
- # @param file_file_filesystem_exporter_href [String]
319
- # @param [Hash] opts the optional parameters
320
- # @option opts [String] :fields A list of fields to include in the response.
321
- # @option opts [String] :exclude_fields A list of fields to exclude from the response.
322
- # @return [Array<(FileFileFilesystemExporterResponse, Integer, Hash)>] FileFileFilesystemExporterResponse data, response status code and response headers
323
- def read_with_http_info(file_file_filesystem_exporter_href, opts = {})
324
- if @api_client.config.debugging
325
- @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.read ...'
326
- end
327
- # verify the required parameter 'file_file_filesystem_exporter_href' is set
328
- if @api_client.config.client_side_validation && file_file_filesystem_exporter_href.nil?
329
- fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter_href' when calling ExportersFilesystemApi.read"
330
- end
331
- # resource path
332
- 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', '/'))
333
-
334
- # query parameters
335
- query_params = opts[:query_params] || {}
336
- query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
337
- query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
338
-
339
- # header parameters
340
- header_params = opts[:header_params] || {}
341
- # HTTP header 'Accept' (if needed)
342
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
343
-
344
- # form parameters
345
- form_params = opts[:form_params] || {}
346
-
347
- # http body (model)
348
- post_body = opts[:body]
349
-
350
- # return_type
351
- return_type = opts[:return_type] || 'FileFileFilesystemExporterResponse'
352
-
353
- # auth_names
354
- auth_names = opts[:auth_names] || ['basicAuth']
355
-
356
- new_options = opts.merge(
357
- :header_params => header_params,
358
- :query_params => query_params,
359
- :form_params => form_params,
360
- :body => post_body,
361
- :auth_names => auth_names,
362
- :return_type => return_type
363
- )
364
-
365
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
366
- if @api_client.config.debugging
367
- @api_client.config.logger.debug "API called: ExportersFilesystemApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
368
- end
369
- return data, status_code, headers
370
- end
371
-
372
- # Update a file filesystem exporter
373
- # Trigger an asynchronous update task
374
- # @param file_file_filesystem_exporter_href [String]
375
- # @param file_file_filesystem_exporter [FileFileFilesystemExporter]
376
- # @param [Hash] opts the optional parameters
377
- # @return [AsyncOperationResponse]
378
- def update(file_file_filesystem_exporter_href, file_file_filesystem_exporter, opts = {})
379
- data, _status_code, _headers = update_with_http_info(file_file_filesystem_exporter_href, file_file_filesystem_exporter, opts)
380
- data
381
- end
382
-
383
- # Update a file filesystem exporter
384
- # Trigger an asynchronous update task
385
- # @param file_file_filesystem_exporter_href [String]
386
- # @param file_file_filesystem_exporter [FileFileFilesystemExporter]
387
- # @param [Hash] opts the optional parameters
388
- # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
389
- def update_with_http_info(file_file_filesystem_exporter_href, file_file_filesystem_exporter, opts = {})
390
- if @api_client.config.debugging
391
- @api_client.config.logger.debug 'Calling API: ExportersFilesystemApi.update ...'
392
- end
393
- # verify the required parameter 'file_file_filesystem_exporter_href' is set
394
- if @api_client.config.client_side_validation && file_file_filesystem_exporter_href.nil?
395
- fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter_href' when calling ExportersFilesystemApi.update"
396
- end
397
- # verify the required parameter 'file_file_filesystem_exporter' is set
398
- if @api_client.config.client_side_validation && file_file_filesystem_exporter.nil?
399
- fail ArgumentError, "Missing the required parameter 'file_file_filesystem_exporter' when calling ExportersFilesystemApi.update"
400
- end
401
- # resource path
402
- 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', '/'))
403
-
404
- # query parameters
405
- query_params = opts[:query_params] || {}
406
-
407
- # header parameters
408
- header_params = opts[:header_params] || {}
409
- # HTTP header 'Accept' (if needed)
410
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
411
- # HTTP header 'Content-Type'
412
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
413
-
414
- # form parameters
415
- form_params = opts[:form_params] || {}
416
-
417
- # http body (model)
418
- post_body = opts[:body] || @api_client.object_to_http_body(file_file_filesystem_exporter)
419
-
420
- # return_type
421
- return_type = opts[:return_type] || 'AsyncOperationResponse'
422
-
423
- # auth_names
424
- auth_names = opts[:auth_names] || ['basicAuth']
425
-
426
- new_options = opts.merge(
427
- :header_params => header_params,
428
- :query_params => query_params,
429
- :form_params => form_params,
430
- :body => post_body,
431
- :auth_names => auth_names,
432
- :return_type => return_type
433
- )
434
-
435
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
436
- if @api_client.config.debugging
437
- @api_client.config.logger.debug "API called: ExportersFilesystemApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
438
- end
439
- return data, status_code, headers
440
- end
441
- end
442
- end