pulpcore_client 3.14.19 → 3.15.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 +38 -5
- data/docs/AccessPoliciesApi.md +1 -1
- data/docs/ArtifactsApi.md +1 -1
- data/docs/ContentApi.md +1 -1
- data/docs/ContentguardsApi.md +1 -1
- data/docs/ContentguardsRbacApi.md +473 -0
- data/docs/ExportersFilesystemApi.md +362 -0
- data/docs/ExportersFilesystemExportsApi.md +243 -0
- data/docs/ExportersPulpApi.md +1 -1
- data/docs/ExportersPulpExportsApi.md +1 -1
- data/docs/FilesystemExport.md +21 -0
- data/docs/FilesystemExportResponse.md +25 -0
- data/docs/FilesystemExporter.md +21 -0
- data/docs/FilesystemExporterResponse.md +25 -0
- data/docs/GroupsApi.md +1 -1
- data/docs/GroupsModelPermissionsApi.md +1 -1
- data/docs/GroupsObjectPermissionsApi.md +1 -1
- data/docs/GroupsUsersApi.md +1 -1
- data/docs/ImportersPulpApi.md +1 -1
- data/docs/ImportersPulpImportCheckApi.md +1 -1
- data/docs/ImportersPulpImportsApi.md +1 -1
- data/docs/MethodEnum.md +16 -0
- data/docs/OrphansApi.md +1 -1
- data/docs/OrphansCleanup.md +3 -1
- data/docs/OrphansCleanupApi.md +1 -1
- data/docs/PaginatedFilesystemExportResponseList.md +23 -0
- data/docs/PaginatedFilesystemExporterResponseList.md +23 -0
- data/docs/PaginatedRBACContentGuardResponseList.md +23 -0
- data/docs/PatchedFilesystemExporter.md +21 -0
- data/docs/PatchedRBACContentGuard.md +19 -0
- data/docs/PublicationsApi.md +1 -1
- data/docs/RBACContentGuard.md +19 -0
- data/docs/RBACContentGuardPermission.md +19 -0
- data/docs/RBACContentGuardResponse.md +27 -0
- data/docs/ReclaimSpace.md +19 -0
- data/docs/RepairApi.md +1 -1
- data/docs/RepositoriesApi.md +1 -1
- data/docs/RepositoriesReclaimSpaceApi.md +61 -0
- data/docs/RepositoryResponse.md +3 -3
- data/docs/RepositoryVersionsApi.md +1 -1
- data/docs/SigningServicesApi.md +1 -1
- data/docs/StatusApi.md +1 -1
- data/docs/TaskGroupsApi.md +1 -1
- data/docs/TasksApi.md +1 -1
- data/docs/UploadsApi.md +1 -1
- data/docs/UsersApi.md +1 -1
- data/docs/WorkersApi.md +1 -1
- data/git_push.sh +58 -0
- data/lib/pulpcore_client/api/contentguards_rbac_api.rb +580 -0
- data/lib/pulpcore_client/api/exporters_filesystem_api.rb +442 -0
- data/lib/pulpcore_client/api/exporters_filesystem_exports_api.rb +297 -0
- data/lib/pulpcore_client/api/repositories_reclaim_space_api.rb +84 -0
- data/lib/pulpcore_client/api_client.rb +5 -2
- data/lib/pulpcore_client/configuration.rb +2 -3
- data/lib/pulpcore_client/models/filesystem_export.rb +229 -0
- data/lib/pulpcore_client/models/filesystem_export_response.rb +250 -0
- data/lib/pulpcore_client/models/filesystem_exporter.rb +238 -0
- data/lib/pulpcore_client/models/filesystem_exporter_response.rb +257 -0
- data/lib/pulpcore_client/models/method_enum.rb +37 -0
- data/lib/pulpcore_client/models/orphans_cleanup.rb +17 -4
- data/lib/pulpcore_client/models/paginated_filesystem_export_response_list.rb +237 -0
- data/lib/pulpcore_client/models/paginated_filesystem_exporter_response_list.rb +237 -0
- data/lib/pulpcore_client/models/paginated_rbac_content_guard_response_list.rb +237 -0
- data/lib/pulpcore_client/models/patched_filesystem_exporter.rb +228 -0
- data/lib/pulpcore_client/models/patched_rbac_content_guard.rb +219 -0
- data/lib/pulpcore_client/models/rbac_content_guard.rb +224 -0
- data/lib/pulpcore_client/models/rbac_content_guard_permission.rb +219 -0
- data/lib/pulpcore_client/models/rbac_content_guard_response.rb +261 -0
- data/lib/pulpcore_client/models/reclaim_space.rb +227 -0
- data/lib/pulpcore_client/models/repository_response.rb +17 -16
- data/lib/pulpcore_client/version.rb +1 -1
- data/lib/pulpcore_client.rb +18 -0
- data/pulpcore_client.gemspec +3 -3
- data/spec/api/contentguards_rbac_api_spec.rb +146 -0
- data/spec/api/exporters_filesystem_api_spec.rb +120 -0
- data/spec/api/exporters_filesystem_exports_api_spec.rb +91 -0
- data/spec/api/repositories_reclaim_space_api_spec.rb +46 -0
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/filesystem_export_response_spec.rb +65 -0
- data/spec/models/filesystem_export_spec.rb +53 -0
- data/spec/models/filesystem_exporter_response_spec.rb +65 -0
- data/spec/models/filesystem_exporter_spec.rb +53 -0
- data/spec/models/method_enum_spec.rb +35 -0
- data/spec/models/orphans_cleanup_spec.rb +6 -0
- data/spec/models/paginated_filesystem_export_response_list_spec.rb +59 -0
- data/spec/models/paginated_filesystem_exporter_response_list_spec.rb +59 -0
- data/spec/models/paginated_rbac_content_guard_response_list_spec.rb +59 -0
- data/spec/models/patched_filesystem_exporter_spec.rb +53 -0
- data/spec/models/patched_rbac_content_guard_spec.rb +47 -0
- data/spec/models/rbac_content_guard_permission_spec.rb +47 -0
- data/spec/models/rbac_content_guard_response_spec.rb +71 -0
- data/spec/models/rbac_content_guard_spec.rb +47 -0
- data/spec/models/reclaim_space_spec.rb +47 -0
- data/spec/models/repository_response_spec.rb +1 -1
- metadata +158 -91
@@ -0,0 +1,362 @@
|
|
1
|
+
# PulpcoreClient::ExportersFilesystemApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](ExportersFilesystemApi.md#create) | **POST** /pulp/api/v3/exporters/core/filesystem/ | Create a filesystem exporter
|
8
|
+
[**delete**](ExportersFilesystemApi.md#delete) | **DELETE** {filesystem_exporter_href} | Delete a filesystem exporter
|
9
|
+
[**list**](ExportersFilesystemApi.md#list) | **GET** /pulp/api/v3/exporters/core/filesystem/ | List filesystem exporters
|
10
|
+
[**partial_update**](ExportersFilesystemApi.md#partial_update) | **PATCH** {filesystem_exporter_href} | Update a filesystem exporter
|
11
|
+
[**read**](ExportersFilesystemApi.md#read) | **GET** {filesystem_exporter_href} | Inspect a filesystem exporter
|
12
|
+
[**update**](ExportersFilesystemApi.md#update) | **PUT** {filesystem_exporter_href} | Update a filesystem exporter
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
## create
|
17
|
+
|
18
|
+
> FilesystemExporterResponse create(filesystem_exporter)
|
19
|
+
|
20
|
+
Create a filesystem exporter
|
21
|
+
|
22
|
+
Endpoint for managing FilesystemExporters. FilesystemExporters are provided as a tech preview.
|
23
|
+
|
24
|
+
### Example
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'pulpcore_client'
|
29
|
+
# setup authorization
|
30
|
+
PulpcoreClient.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 = PulpcoreClient::ExportersFilesystemApi.new
|
37
|
+
filesystem_exporter = PulpcoreClient::FilesystemExporter.new # FilesystemExporter |
|
38
|
+
|
39
|
+
begin
|
40
|
+
#Create a filesystem exporter
|
41
|
+
result = api_instance.create(filesystem_exporter)
|
42
|
+
p result
|
43
|
+
rescue PulpcoreClient::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
|
+
**filesystem_exporter** | [**FilesystemExporter**](FilesystemExporter.md)| |
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**FilesystemExporterResponse**](FilesystemExporterResponse.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(filesystem_exporter_href)
|
72
|
+
|
73
|
+
Delete a filesystem exporter
|
74
|
+
|
75
|
+
Trigger an asynchronous delete task
|
76
|
+
|
77
|
+
### Example
|
78
|
+
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'pulpcore_client'
|
82
|
+
# setup authorization
|
83
|
+
PulpcoreClient.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 = PulpcoreClient::ExportersFilesystemApi.new
|
90
|
+
filesystem_exporter_href = 'filesystem_exporter_href_example' # String |
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Delete a filesystem exporter
|
94
|
+
result = api_instance.delete(filesystem_exporter_href)
|
95
|
+
p result
|
96
|
+
rescue PulpcoreClient::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
|
+
**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
|
+
> PaginatedFilesystemExporterResponseList list(opts)
|
125
|
+
|
126
|
+
List filesystem exporters
|
127
|
+
|
128
|
+
Endpoint for managing FilesystemExporters. FilesystemExporters are provided as a tech preview.
|
129
|
+
|
130
|
+
### Example
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
# load the gem
|
134
|
+
require 'pulpcore_client'
|
135
|
+
# setup authorization
|
136
|
+
PulpcoreClient.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 = PulpcoreClient::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 filesystem exporters
|
158
|
+
result = api_instance.list(opts)
|
159
|
+
p result
|
160
|
+
rescue PulpcoreClient::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
|
+
[**PaginatedFilesystemExporterResponseList**](PaginatedFilesystemExporterResponseList.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(filesystem_exporter_href, patched_filesystem_exporter)
|
198
|
+
|
199
|
+
Update a filesystem exporter
|
200
|
+
|
201
|
+
Trigger an asynchronous partial update task
|
202
|
+
|
203
|
+
### Example
|
204
|
+
|
205
|
+
```ruby
|
206
|
+
# load the gem
|
207
|
+
require 'pulpcore_client'
|
208
|
+
# setup authorization
|
209
|
+
PulpcoreClient.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 = PulpcoreClient::ExportersFilesystemApi.new
|
216
|
+
filesystem_exporter_href = 'filesystem_exporter_href_example' # String |
|
217
|
+
patched_filesystem_exporter = PulpcoreClient::PatchedFilesystemExporter.new # PatchedFilesystemExporter |
|
218
|
+
|
219
|
+
begin
|
220
|
+
#Update a filesystem exporter
|
221
|
+
result = api_instance.partial_update(filesystem_exporter_href, patched_filesystem_exporter)
|
222
|
+
p result
|
223
|
+
rescue PulpcoreClient::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
|
+
**filesystem_exporter_href** | **String**| |
|
234
|
+
**patched_filesystem_exporter** | [**PatchedFilesystemExporter**](PatchedFilesystemExporter.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
|
+
> FilesystemExporterResponse read(filesystem_exporter_href, opts)
|
253
|
+
|
254
|
+
Inspect a filesystem exporter
|
255
|
+
|
256
|
+
Endpoint for managing FilesystemExporters. FilesystemExporters are provided as a tech preview.
|
257
|
+
|
258
|
+
### Example
|
259
|
+
|
260
|
+
```ruby
|
261
|
+
# load the gem
|
262
|
+
require 'pulpcore_client'
|
263
|
+
# setup authorization
|
264
|
+
PulpcoreClient.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 = PulpcoreClient::ExportersFilesystemApi.new
|
271
|
+
filesystem_exporter_href = '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 filesystem exporter
|
279
|
+
result = api_instance.read(filesystem_exporter_href, opts)
|
280
|
+
p result
|
281
|
+
rescue PulpcoreClient::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
|
+
**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
|
+
[**FilesystemExporterResponse**](FilesystemExporterResponse.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(filesystem_exporter_href, filesystem_exporter)
|
312
|
+
|
313
|
+
Update a filesystem exporter
|
314
|
+
|
315
|
+
Trigger an asynchronous update task
|
316
|
+
|
317
|
+
### Example
|
318
|
+
|
319
|
+
```ruby
|
320
|
+
# load the gem
|
321
|
+
require 'pulpcore_client'
|
322
|
+
# setup authorization
|
323
|
+
PulpcoreClient.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 = PulpcoreClient::ExportersFilesystemApi.new
|
330
|
+
filesystem_exporter_href = 'filesystem_exporter_href_example' # String |
|
331
|
+
filesystem_exporter = PulpcoreClient::FilesystemExporter.new # FilesystemExporter |
|
332
|
+
|
333
|
+
begin
|
334
|
+
#Update a filesystem exporter
|
335
|
+
result = api_instance.update(filesystem_exporter_href, filesystem_exporter)
|
336
|
+
p result
|
337
|
+
rescue PulpcoreClient::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
|
+
**filesystem_exporter_href** | **String**| |
|
348
|
+
**filesystem_exporter** | [**FilesystemExporter**](FilesystemExporter.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
|
+
|
@@ -0,0 +1,243 @@
|
|
1
|
+
# PulpcoreClient::ExportersFilesystemExportsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](ExportersFilesystemExportsApi.md#create) | **POST** {filesystem_exporter_href}exports/ | Create a filesystem export
|
8
|
+
[**delete**](ExportersFilesystemExportsApi.md#delete) | **DELETE** {filesystem_filesystem_export_href} | Delete a filesystem export
|
9
|
+
[**list**](ExportersFilesystemExportsApi.md#list) | **GET** {filesystem_exporter_href}exports/ | List filesystem exports
|
10
|
+
[**read**](ExportersFilesystemExportsApi.md#read) | **GET** {filesystem_filesystem_export_href} | Inspect a filesystem export
|
11
|
+
|
12
|
+
|
13
|
+
|
14
|
+
## create
|
15
|
+
|
16
|
+
> AsyncOperationResponse create(filesystem_exporter_href, filesystem_export)
|
17
|
+
|
18
|
+
Create a filesystem export
|
19
|
+
|
20
|
+
Trigger an asynchronous task to export files to the filesystem
|
21
|
+
|
22
|
+
### Example
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
# load the gem
|
26
|
+
require 'pulpcore_client'
|
27
|
+
# setup authorization
|
28
|
+
PulpcoreClient.configure do |config|
|
29
|
+
# Configure HTTP basic authorization: basicAuth
|
30
|
+
config.username = 'YOUR USERNAME'
|
31
|
+
config.password = 'YOUR PASSWORD'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = PulpcoreClient::ExportersFilesystemExportsApi.new
|
35
|
+
filesystem_exporter_href = 'filesystem_exporter_href_example' # String |
|
36
|
+
filesystem_export = PulpcoreClient::FilesystemExport.new # FilesystemExport |
|
37
|
+
|
38
|
+
begin
|
39
|
+
#Create a filesystem export
|
40
|
+
result = api_instance.create(filesystem_exporter_href, filesystem_export)
|
41
|
+
p result
|
42
|
+
rescue PulpcoreClient::ApiError => e
|
43
|
+
puts "Exception when calling ExportersFilesystemExportsApi->create: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
### Parameters
|
48
|
+
|
49
|
+
|
50
|
+
Name | Type | Description | Notes
|
51
|
+
------------- | ------------- | ------------- | -------------
|
52
|
+
**filesystem_exporter_href** | **String**| |
|
53
|
+
**filesystem_export** | [**FilesystemExport**](FilesystemExport.md)| |
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.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
|
+
> delete(filesystem_filesystem_export_href)
|
72
|
+
|
73
|
+
Delete a filesystem export
|
74
|
+
|
75
|
+
Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview.
|
76
|
+
|
77
|
+
### Example
|
78
|
+
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'pulpcore_client'
|
82
|
+
# setup authorization
|
83
|
+
PulpcoreClient.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 = PulpcoreClient::ExportersFilesystemExportsApi.new
|
90
|
+
filesystem_filesystem_export_href = 'filesystem_filesystem_export_href_example' # String |
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Delete a filesystem export
|
94
|
+
api_instance.delete(filesystem_filesystem_export_href)
|
95
|
+
rescue PulpcoreClient::ApiError => e
|
96
|
+
puts "Exception when calling ExportersFilesystemExportsApi->delete: #{e}"
|
97
|
+
end
|
98
|
+
```
|
99
|
+
|
100
|
+
### Parameters
|
101
|
+
|
102
|
+
|
103
|
+
Name | Type | Description | Notes
|
104
|
+
------------- | ------------- | ------------- | -------------
|
105
|
+
**filesystem_filesystem_export_href** | **String**| |
|
106
|
+
|
107
|
+
### Return type
|
108
|
+
|
109
|
+
nil (empty response body)
|
110
|
+
|
111
|
+
### Authorization
|
112
|
+
|
113
|
+
[basicAuth](../README.md#basicAuth)
|
114
|
+
|
115
|
+
### HTTP request headers
|
116
|
+
|
117
|
+
- **Content-Type**: Not defined
|
118
|
+
- **Accept**: Not defined
|
119
|
+
|
120
|
+
|
121
|
+
## list
|
122
|
+
|
123
|
+
> PaginatedFilesystemExportResponseList list(filesystem_exporter_href, opts)
|
124
|
+
|
125
|
+
List filesystem exports
|
126
|
+
|
127
|
+
Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview.
|
128
|
+
|
129
|
+
### Example
|
130
|
+
|
131
|
+
```ruby
|
132
|
+
# load the gem
|
133
|
+
require 'pulpcore_client'
|
134
|
+
# setup authorization
|
135
|
+
PulpcoreClient.configure do |config|
|
136
|
+
# Configure HTTP basic authorization: basicAuth
|
137
|
+
config.username = 'YOUR USERNAME'
|
138
|
+
config.password = 'YOUR PASSWORD'
|
139
|
+
end
|
140
|
+
|
141
|
+
api_instance = PulpcoreClient::ExportersFilesystemExportsApi.new
|
142
|
+
filesystem_exporter_href = 'filesystem_exporter_href_example' # String |
|
143
|
+
opts = {
|
144
|
+
limit: 56, # Integer | Number of results to return per page.
|
145
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
146
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
147
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
148
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
149
|
+
}
|
150
|
+
|
151
|
+
begin
|
152
|
+
#List filesystem exports
|
153
|
+
result = api_instance.list(filesystem_exporter_href, opts)
|
154
|
+
p result
|
155
|
+
rescue PulpcoreClient::ApiError => e
|
156
|
+
puts "Exception when calling ExportersFilesystemExportsApi->list: #{e}"
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
### Parameters
|
161
|
+
|
162
|
+
|
163
|
+
Name | Type | Description | Notes
|
164
|
+
------------- | ------------- | ------------- | -------------
|
165
|
+
**filesystem_exporter_href** | **String**| |
|
166
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
167
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
168
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
169
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
170
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
171
|
+
|
172
|
+
### Return type
|
173
|
+
|
174
|
+
[**PaginatedFilesystemExportResponseList**](PaginatedFilesystemExportResponseList.md)
|
175
|
+
|
176
|
+
### Authorization
|
177
|
+
|
178
|
+
[basicAuth](../README.md#basicAuth)
|
179
|
+
|
180
|
+
### HTTP request headers
|
181
|
+
|
182
|
+
- **Content-Type**: Not defined
|
183
|
+
- **Accept**: application/json
|
184
|
+
|
185
|
+
|
186
|
+
## read
|
187
|
+
|
188
|
+
> FilesystemExportResponse read(filesystem_filesystem_export_href, opts)
|
189
|
+
|
190
|
+
Inspect a filesystem export
|
191
|
+
|
192
|
+
Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview.
|
193
|
+
|
194
|
+
### Example
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
# load the gem
|
198
|
+
require 'pulpcore_client'
|
199
|
+
# setup authorization
|
200
|
+
PulpcoreClient.configure do |config|
|
201
|
+
# Configure HTTP basic authorization: basicAuth
|
202
|
+
config.username = 'YOUR USERNAME'
|
203
|
+
config.password = 'YOUR PASSWORD'
|
204
|
+
end
|
205
|
+
|
206
|
+
api_instance = PulpcoreClient::ExportersFilesystemExportsApi.new
|
207
|
+
filesystem_filesystem_export_href = 'filesystem_filesystem_export_href_example' # String |
|
208
|
+
opts = {
|
209
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
210
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
211
|
+
}
|
212
|
+
|
213
|
+
begin
|
214
|
+
#Inspect a filesystem export
|
215
|
+
result = api_instance.read(filesystem_filesystem_export_href, opts)
|
216
|
+
p result
|
217
|
+
rescue PulpcoreClient::ApiError => e
|
218
|
+
puts "Exception when calling ExportersFilesystemExportsApi->read: #{e}"
|
219
|
+
end
|
220
|
+
```
|
221
|
+
|
222
|
+
### Parameters
|
223
|
+
|
224
|
+
|
225
|
+
Name | Type | Description | Notes
|
226
|
+
------------- | ------------- | ------------- | -------------
|
227
|
+
**filesystem_filesystem_export_href** | **String**| |
|
228
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
229
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
230
|
+
|
231
|
+
### Return type
|
232
|
+
|
233
|
+
[**FilesystemExportResponse**](FilesystemExportResponse.md)
|
234
|
+
|
235
|
+
### Authorization
|
236
|
+
|
237
|
+
[basicAuth](../README.md#basicAuth)
|
238
|
+
|
239
|
+
### HTTP request headers
|
240
|
+
|
241
|
+
- **Content-Type**: Not defined
|
242
|
+
- **Accept**: application/json
|
243
|
+
|
data/docs/ExportersPulpApi.md
CHANGED
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpcoreClient::FilesystemExport
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**task** | **String** | A URI of the task that ran the Export. | [optional]
|
8
|
+
**publication** | **String** | A URI of the publication to be exported. | [optional]
|
9
|
+
**repository_version** | **String** | A URI of the repository version export. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpcoreClient'
|
15
|
+
|
16
|
+
instance = PulpcoreClient::FilesystemExport.new(task: null,
|
17
|
+
publication: null,
|
18
|
+
repository_version: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# PulpcoreClient::FilesystemExportResponse
|
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
|
+
**task** | **String** | A URI of the task that ran the Export. | [optional]
|
10
|
+
**exported_resources** | **Array<String>** | Resources that were exported. | [optional] [readonly]
|
11
|
+
**params** | [**Object**](.md) | Any additional parameters that were used to create the export. | [optional] [readonly]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'PulpcoreClient'
|
17
|
+
|
18
|
+
instance = PulpcoreClient::FilesystemExportResponse.new(pulp_href: null,
|
19
|
+
pulp_created: null,
|
20
|
+
task: null,
|
21
|
+
exported_resources: null,
|
22
|
+
params: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpcoreClient::FilesystemExporter
|
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
|
+
**method** | [**MethodEnum**](MethodEnum.md) | Method of exporting | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpcoreClient'
|
15
|
+
|
16
|
+
instance = PulpcoreClient::FilesystemExporter.new(name: null,
|
17
|
+
path: null,
|
18
|
+
method: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|