pulp_file_client 1.8.0.dev1621570431 → 1.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +4 -21
- data/lib/pulp_file_client.rb +0 -9
- data/lib/pulp_file_client/version.rb +1 -1
- metadata +4 -40
- data/docs/ExportResponse.md +0 -25
- data/docs/ExportersFileExportsApi.md +0 -243
- data/docs/ExportersFilesystemApi.md +0 -362
- data/docs/FileFileFilesystemExporter.md +0 -19
- data/docs/FileFileFilesystemExporterResponse.md +0 -23
- data/docs/PaginatedExportResponseList.md +0 -23
- data/docs/PaginatedfileFileFilesystemExporterResponseList.md +0 -23
- data/docs/PatchedfileFileFilesystemExporter.md +0 -19
- data/docs/PublicationExport.md +0 -17
- data/lib/pulp_file_client/api/exporters_file_exports_api.rb +0 -297
- data/lib/pulp_file_client/api/exporters_filesystem_api.rb +0 -442
- data/lib/pulp_file_client/models/export_response.rb +0 -250
- data/lib/pulp_file_client/models/file_file_filesystem_exporter.rb +0 -228
- data/lib/pulp_file_client/models/file_file_filesystem_exporter_response.rb +0 -247
- data/lib/pulp_file_client/models/paginated_export_response_list.rb +0 -237
- data/lib/pulp_file_client/models/paginatedfile_file_filesystem_exporter_response_list.rb +0 -237
- data/lib/pulp_file_client/models/patchedfile_file_filesystem_exporter.rb +0 -218
- data/lib/pulp_file_client/models/publication_export.rb +0 -213
- data/spec/api/exporters_file_exports_api_spec.rb +0 -91
- data/spec/api/exporters_filesystem_api_spec.rb +0 -120
- data/spec/models/export_response_spec.rb +0 -65
- data/spec/models/file_file_filesystem_exporter_response_spec.rb +0 -59
- data/spec/models/file_file_filesystem_exporter_spec.rb +0 -47
- data/spec/models/paginated_export_response_list_spec.rb +0 -59
- data/spec/models/paginatedfile_file_filesystem_exporter_response_list_spec.rb +0 -59
- data/spec/models/patchedfile_file_filesystem_exporter_spec.rb +0 -47
- data/spec/models/publication_export_spec.rb +0 -41
@@ -1,362 +0,0 @@
|
|
1
|
-
# PulpFileClient::ExportersFilesystemApi
|
2
|
-
|
3
|
-
All URIs are relative to *http://pulp*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**create**](ExportersFilesystemApi.md#create) | **POST** /pulp/api/v3/exporters/file/filesystem/ | Create a file filesystem exporter
|
8
|
-
[**delete**](ExportersFilesystemApi.md#delete) | **DELETE** {file_file_filesystem_exporter_href} | Delete a file filesystem exporter
|
9
|
-
[**list**](ExportersFilesystemApi.md#list) | **GET** /pulp/api/v3/exporters/file/filesystem/ | List file filesystem exporters
|
10
|
-
[**partial_update**](ExportersFilesystemApi.md#partial_update) | **PATCH** {file_file_filesystem_exporter_href} | Update a file filesystem exporter
|
11
|
-
[**read**](ExportersFilesystemApi.md#read) | **GET** {file_file_filesystem_exporter_href} | Inspect a file filesystem exporter
|
12
|
-
[**update**](ExportersFilesystemApi.md#update) | **PUT** {file_file_filesystem_exporter_href} | Update a file filesystem exporter
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
## create
|
17
|
-
|
18
|
-
> FileFileFilesystemExporterResponse create(file_file_filesystem_exporter)
|
19
|
-
|
20
|
-
Create a file filesystem exporter
|
21
|
-
|
22
|
-
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.
|
23
|
-
|
24
|
-
### Example
|
25
|
-
|
26
|
-
```ruby
|
27
|
-
# load the gem
|
28
|
-
require 'pulp_file_client'
|
29
|
-
# setup authorization
|
30
|
-
PulpFileClient.configure do |config|
|
31
|
-
# Configure HTTP basic authorization: basicAuth
|
32
|
-
config.username = 'YOUR USERNAME'
|
33
|
-
config.password = 'YOUR PASSWORD'
|
34
|
-
end
|
35
|
-
|
36
|
-
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
37
|
-
file_file_filesystem_exporter = PulpFileClient::FileFileFilesystemExporter.new # FileFileFilesystemExporter |
|
38
|
-
|
39
|
-
begin
|
40
|
-
#Create a file filesystem exporter
|
41
|
-
result = api_instance.create(file_file_filesystem_exporter)
|
42
|
-
p result
|
43
|
-
rescue PulpFileClient::ApiError => e
|
44
|
-
puts "Exception when calling ExportersFilesystemApi->create: #{e}"
|
45
|
-
end
|
46
|
-
```
|
47
|
-
|
48
|
-
### Parameters
|
49
|
-
|
50
|
-
|
51
|
-
Name | Type | Description | Notes
|
52
|
-
------------- | ------------- | ------------- | -------------
|
53
|
-
**file_file_filesystem_exporter** | [**FileFileFilesystemExporter**](FileFileFilesystemExporter.md)| |
|
54
|
-
|
55
|
-
### Return type
|
56
|
-
|
57
|
-
[**FileFileFilesystemExporterResponse**](FileFileFilesystemExporterResponse.md)
|
58
|
-
|
59
|
-
### Authorization
|
60
|
-
|
61
|
-
[basicAuth](../README.md#basicAuth)
|
62
|
-
|
63
|
-
### HTTP request headers
|
64
|
-
|
65
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
66
|
-
- **Accept**: application/json
|
67
|
-
|
68
|
-
|
69
|
-
## delete
|
70
|
-
|
71
|
-
> AsyncOperationResponse delete(file_file_filesystem_exporter_href)
|
72
|
-
|
73
|
-
Delete a file filesystem exporter
|
74
|
-
|
75
|
-
Trigger an asynchronous delete task
|
76
|
-
|
77
|
-
### Example
|
78
|
-
|
79
|
-
```ruby
|
80
|
-
# load the gem
|
81
|
-
require 'pulp_file_client'
|
82
|
-
# setup authorization
|
83
|
-
PulpFileClient.configure do |config|
|
84
|
-
# Configure HTTP basic authorization: basicAuth
|
85
|
-
config.username = 'YOUR USERNAME'
|
86
|
-
config.password = 'YOUR PASSWORD'
|
87
|
-
end
|
88
|
-
|
89
|
-
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
90
|
-
file_file_filesystem_exporter_href = 'file_file_filesystem_exporter_href_example' # String |
|
91
|
-
|
92
|
-
begin
|
93
|
-
#Delete a file filesystem exporter
|
94
|
-
result = api_instance.delete(file_file_filesystem_exporter_href)
|
95
|
-
p result
|
96
|
-
rescue PulpFileClient::ApiError => e
|
97
|
-
puts "Exception when calling ExportersFilesystemApi->delete: #{e}"
|
98
|
-
end
|
99
|
-
```
|
100
|
-
|
101
|
-
### Parameters
|
102
|
-
|
103
|
-
|
104
|
-
Name | Type | Description | Notes
|
105
|
-
------------- | ------------- | ------------- | -------------
|
106
|
-
**file_file_filesystem_exporter_href** | **String**| |
|
107
|
-
|
108
|
-
### Return type
|
109
|
-
|
110
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
111
|
-
|
112
|
-
### Authorization
|
113
|
-
|
114
|
-
[basicAuth](../README.md#basicAuth)
|
115
|
-
|
116
|
-
### HTTP request headers
|
117
|
-
|
118
|
-
- **Content-Type**: Not defined
|
119
|
-
- **Accept**: application/json
|
120
|
-
|
121
|
-
|
122
|
-
## list
|
123
|
-
|
124
|
-
> PaginatedfileFileFilesystemExporterResponseList list(opts)
|
125
|
-
|
126
|
-
List file filesystem exporters
|
127
|
-
|
128
|
-
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.
|
129
|
-
|
130
|
-
### Example
|
131
|
-
|
132
|
-
```ruby
|
133
|
-
# load the gem
|
134
|
-
require 'pulp_file_client'
|
135
|
-
# setup authorization
|
136
|
-
PulpFileClient.configure do |config|
|
137
|
-
# Configure HTTP basic authorization: basicAuth
|
138
|
-
config.username = 'YOUR USERNAME'
|
139
|
-
config.password = 'YOUR PASSWORD'
|
140
|
-
end
|
141
|
-
|
142
|
-
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
143
|
-
opts = {
|
144
|
-
limit: 56, # Integer | Number of results to return per page.
|
145
|
-
name: 'name_example', # String |
|
146
|
-
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
147
|
-
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
148
|
-
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
149
|
-
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
150
|
-
offset: 56, # Integer | The initial index from which to return the results.
|
151
|
-
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
152
|
-
fields: 'fields_example', # String | A list of fields to include in the response.
|
153
|
-
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
154
|
-
}
|
155
|
-
|
156
|
-
begin
|
157
|
-
#List file filesystem exporters
|
158
|
-
result = api_instance.list(opts)
|
159
|
-
p result
|
160
|
-
rescue PulpFileClient::ApiError => e
|
161
|
-
puts "Exception when calling ExportersFilesystemApi->list: #{e}"
|
162
|
-
end
|
163
|
-
```
|
164
|
-
|
165
|
-
### Parameters
|
166
|
-
|
167
|
-
|
168
|
-
Name | Type | Description | Notes
|
169
|
-
------------- | ------------- | ------------- | -------------
|
170
|
-
**limit** | **Integer**| Number of results to return per page. | [optional]
|
171
|
-
**name** | **String**| | [optional]
|
172
|
-
**name__contains** | **String**| Filter results where name contains value | [optional]
|
173
|
-
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
174
|
-
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
175
|
-
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
176
|
-
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
177
|
-
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
178
|
-
**fields** | **String**| A list of fields to include in the response. | [optional]
|
179
|
-
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
180
|
-
|
181
|
-
### Return type
|
182
|
-
|
183
|
-
[**PaginatedfileFileFilesystemExporterResponseList**](PaginatedfileFileFilesystemExporterResponseList.md)
|
184
|
-
|
185
|
-
### Authorization
|
186
|
-
|
187
|
-
[basicAuth](../README.md#basicAuth)
|
188
|
-
|
189
|
-
### HTTP request headers
|
190
|
-
|
191
|
-
- **Content-Type**: Not defined
|
192
|
-
- **Accept**: application/json
|
193
|
-
|
194
|
-
|
195
|
-
## partial_update
|
196
|
-
|
197
|
-
> AsyncOperationResponse partial_update(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter)
|
198
|
-
|
199
|
-
Update a file filesystem exporter
|
200
|
-
|
201
|
-
Trigger an asynchronous partial update task
|
202
|
-
|
203
|
-
### Example
|
204
|
-
|
205
|
-
```ruby
|
206
|
-
# load the gem
|
207
|
-
require 'pulp_file_client'
|
208
|
-
# setup authorization
|
209
|
-
PulpFileClient.configure do |config|
|
210
|
-
# Configure HTTP basic authorization: basicAuth
|
211
|
-
config.username = 'YOUR USERNAME'
|
212
|
-
config.password = 'YOUR PASSWORD'
|
213
|
-
end
|
214
|
-
|
215
|
-
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
216
|
-
file_file_filesystem_exporter_href = 'file_file_filesystem_exporter_href_example' # String |
|
217
|
-
patchedfile_file_filesystem_exporter = PulpFileClient::PatchedfileFileFilesystemExporter.new # PatchedfileFileFilesystemExporter |
|
218
|
-
|
219
|
-
begin
|
220
|
-
#Update a file filesystem exporter
|
221
|
-
result = api_instance.partial_update(file_file_filesystem_exporter_href, patchedfile_file_filesystem_exporter)
|
222
|
-
p result
|
223
|
-
rescue PulpFileClient::ApiError => e
|
224
|
-
puts "Exception when calling ExportersFilesystemApi->partial_update: #{e}"
|
225
|
-
end
|
226
|
-
```
|
227
|
-
|
228
|
-
### Parameters
|
229
|
-
|
230
|
-
|
231
|
-
Name | Type | Description | Notes
|
232
|
-
------------- | ------------- | ------------- | -------------
|
233
|
-
**file_file_filesystem_exporter_href** | **String**| |
|
234
|
-
**patchedfile_file_filesystem_exporter** | [**PatchedfileFileFilesystemExporter**](PatchedfileFileFilesystemExporter.md)| |
|
235
|
-
|
236
|
-
### Return type
|
237
|
-
|
238
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
239
|
-
|
240
|
-
### Authorization
|
241
|
-
|
242
|
-
[basicAuth](../README.md#basicAuth)
|
243
|
-
|
244
|
-
### HTTP request headers
|
245
|
-
|
246
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
247
|
-
- **Accept**: application/json
|
248
|
-
|
249
|
-
|
250
|
-
## read
|
251
|
-
|
252
|
-
> FileFileFilesystemExporterResponse read(file_file_filesystem_exporter_href, opts)
|
253
|
-
|
254
|
-
Inspect a file filesystem exporter
|
255
|
-
|
256
|
-
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.
|
257
|
-
|
258
|
-
### Example
|
259
|
-
|
260
|
-
```ruby
|
261
|
-
# load the gem
|
262
|
-
require 'pulp_file_client'
|
263
|
-
# setup authorization
|
264
|
-
PulpFileClient.configure do |config|
|
265
|
-
# Configure HTTP basic authorization: basicAuth
|
266
|
-
config.username = 'YOUR USERNAME'
|
267
|
-
config.password = 'YOUR PASSWORD'
|
268
|
-
end
|
269
|
-
|
270
|
-
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
271
|
-
file_file_filesystem_exporter_href = 'file_file_filesystem_exporter_href_example' # String |
|
272
|
-
opts = {
|
273
|
-
fields: 'fields_example', # String | A list of fields to include in the response.
|
274
|
-
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
275
|
-
}
|
276
|
-
|
277
|
-
begin
|
278
|
-
#Inspect a file filesystem exporter
|
279
|
-
result = api_instance.read(file_file_filesystem_exporter_href, opts)
|
280
|
-
p result
|
281
|
-
rescue PulpFileClient::ApiError => e
|
282
|
-
puts "Exception when calling ExportersFilesystemApi->read: #{e}"
|
283
|
-
end
|
284
|
-
```
|
285
|
-
|
286
|
-
### Parameters
|
287
|
-
|
288
|
-
|
289
|
-
Name | Type | Description | Notes
|
290
|
-
------------- | ------------- | ------------- | -------------
|
291
|
-
**file_file_filesystem_exporter_href** | **String**| |
|
292
|
-
**fields** | **String**| A list of fields to include in the response. | [optional]
|
293
|
-
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
294
|
-
|
295
|
-
### Return type
|
296
|
-
|
297
|
-
[**FileFileFilesystemExporterResponse**](FileFileFilesystemExporterResponse.md)
|
298
|
-
|
299
|
-
### Authorization
|
300
|
-
|
301
|
-
[basicAuth](../README.md#basicAuth)
|
302
|
-
|
303
|
-
### HTTP request headers
|
304
|
-
|
305
|
-
- **Content-Type**: Not defined
|
306
|
-
- **Accept**: application/json
|
307
|
-
|
308
|
-
|
309
|
-
## update
|
310
|
-
|
311
|
-
> AsyncOperationResponse update(file_file_filesystem_exporter_href, file_file_filesystem_exporter)
|
312
|
-
|
313
|
-
Update a file filesystem exporter
|
314
|
-
|
315
|
-
Trigger an asynchronous update task
|
316
|
-
|
317
|
-
### Example
|
318
|
-
|
319
|
-
```ruby
|
320
|
-
# load the gem
|
321
|
-
require 'pulp_file_client'
|
322
|
-
# setup authorization
|
323
|
-
PulpFileClient.configure do |config|
|
324
|
-
# Configure HTTP basic authorization: basicAuth
|
325
|
-
config.username = 'YOUR USERNAME'
|
326
|
-
config.password = 'YOUR PASSWORD'
|
327
|
-
end
|
328
|
-
|
329
|
-
api_instance = PulpFileClient::ExportersFilesystemApi.new
|
330
|
-
file_file_filesystem_exporter_href = 'file_file_filesystem_exporter_href_example' # String |
|
331
|
-
file_file_filesystem_exporter = PulpFileClient::FileFileFilesystemExporter.new # FileFileFilesystemExporter |
|
332
|
-
|
333
|
-
begin
|
334
|
-
#Update a file filesystem exporter
|
335
|
-
result = api_instance.update(file_file_filesystem_exporter_href, file_file_filesystem_exporter)
|
336
|
-
p result
|
337
|
-
rescue PulpFileClient::ApiError => e
|
338
|
-
puts "Exception when calling ExportersFilesystemApi->update: #{e}"
|
339
|
-
end
|
340
|
-
```
|
341
|
-
|
342
|
-
### Parameters
|
343
|
-
|
344
|
-
|
345
|
-
Name | Type | Description | Notes
|
346
|
-
------------- | ------------- | ------------- | -------------
|
347
|
-
**file_file_filesystem_exporter_href** | **String**| |
|
348
|
-
**file_file_filesystem_exporter** | [**FileFileFilesystemExporter**](FileFileFilesystemExporter.md)| |
|
349
|
-
|
350
|
-
### Return type
|
351
|
-
|
352
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
353
|
-
|
354
|
-
### Authorization
|
355
|
-
|
356
|
-
[basicAuth](../README.md#basicAuth)
|
357
|
-
|
358
|
-
### HTTP request headers
|
359
|
-
|
360
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
361
|
-
- **Accept**: application/json
|
362
|
-
|
@@ -1,19 +0,0 @@
|
|
1
|
-
# PulpFileClient::FileFileFilesystemExporter
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**name** | **String** | Unique name of the file system exporter. |
|
8
|
-
**path** | **String** | File system location to export to. |
|
9
|
-
|
10
|
-
## Code Sample
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'PulpFileClient'
|
14
|
-
|
15
|
-
instance = PulpFileClient::FileFileFilesystemExporter.new(name: null,
|
16
|
-
path: null)
|
17
|
-
```
|
18
|
-
|
19
|
-
|
@@ -1,23 +0,0 @@
|
|
1
|
-
# PulpFileClient::FileFileFilesystemExporterResponse
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**pulp_href** | **String** | | [optional] [readonly]
|
8
|
-
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
|
-
**name** | **String** | Unique name of the file system exporter. |
|
10
|
-
**path** | **String** | File system location to export to. |
|
11
|
-
|
12
|
-
## Code Sample
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'PulpFileClient'
|
16
|
-
|
17
|
-
instance = PulpFileClient::FileFileFilesystemExporterResponse.new(pulp_href: null,
|
18
|
-
pulp_created: null,
|
19
|
-
name: null,
|
20
|
-
path: null)
|
21
|
-
```
|
22
|
-
|
23
|
-
|
@@ -1,23 +0,0 @@
|
|
1
|
-
# PulpFileClient::PaginatedExportResponseList
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**count** | **Integer** | | [optional]
|
8
|
-
**_next** | **String** | | [optional]
|
9
|
-
**previous** | **String** | | [optional]
|
10
|
-
**results** | [**Array<ExportResponse>**](ExportResponse.md) | | [optional]
|
11
|
-
|
12
|
-
## Code Sample
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'PulpFileClient'
|
16
|
-
|
17
|
-
instance = PulpFileClient::PaginatedExportResponseList.new(count: 123,
|
18
|
-
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
19
|
-
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
20
|
-
results: null)
|
21
|
-
```
|
22
|
-
|
23
|
-
|
@@ -1,23 +0,0 @@
|
|
1
|
-
# PulpFileClient::PaginatedfileFileFilesystemExporterResponseList
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**count** | **Integer** | | [optional]
|
8
|
-
**_next** | **String** | | [optional]
|
9
|
-
**previous** | **String** | | [optional]
|
10
|
-
**results** | [**Array<FileFileFilesystemExporterResponse>**](FileFileFilesystemExporterResponse.md) | | [optional]
|
11
|
-
|
12
|
-
## Code Sample
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'PulpFileClient'
|
16
|
-
|
17
|
-
instance = PulpFileClient::PaginatedfileFileFilesystemExporterResponseList.new(count: 123,
|
18
|
-
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
19
|
-
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
20
|
-
results: null)
|
21
|
-
```
|
22
|
-
|
23
|
-
|