pulpcore_client 3.21.31 → 3.21.32
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.
- checksums.yaml +4 -4
- data/README.md +142 -140
- data/docs/AccessPoliciesApi.md +26 -26
- data/docs/ArtifactsApi.md +21 -21
- data/docs/ContentApi.md +6 -6
- data/docs/ContentguardsApi.md +6 -6
- data/docs/ContentguardsContentRedirectApi.md +51 -51
- data/docs/ContentguardsRbacApi.md +51 -51
- data/docs/DistributionsApi.md +6 -6
- data/docs/DocsApiJsonApi.md +61 -0
- data/docs/DocsApiYamlApi.md +61 -0
- data/docs/ExportersFilesystemApi.md +31 -31
- data/docs/ExportersFilesystemExportsApi.md +21 -21
- data/docs/ExportersPulpApi.md +31 -31
- data/docs/ExportersPulpExportsApi.md +21 -21
- data/docs/GroupsApi.md +51 -51
- data/docs/GroupsRolesApi.md +21 -21
- data/docs/GroupsUsersApi.md +16 -16
- data/docs/ImportersPulpApi.md +31 -31
- data/docs/ImportersPulpImportCheckApi.md +1 -1
- data/docs/ImportersPulpImportsApi.md +21 -21
- data/docs/OrphansApi.md +6 -6
- data/docs/OrphansCleanupApi.md +6 -6
- data/docs/PublicationsApi.md +6 -6
- data/docs/RemotesApi.md +6 -6
- data/docs/RepairApi.md +6 -6
- data/docs/RepositoriesApi.md +6 -6
- data/docs/RepositoriesReclaimSpaceApi.md +6 -6
- data/docs/RepositoryVersionsApi.md +6 -6
- data/docs/RolesApi.md +31 -31
- data/docs/SigningServicesApi.md +11 -11
- data/docs/StatusApi.md +1 -1
- data/docs/TaskGroupsApi.md +11 -11
- data/docs/TaskSchedulesApi.md +31 -31
- data/docs/TasksApi.md +96 -96
- data/docs/UploadsApi.md +51 -51
- data/docs/UsersApi.md +31 -31
- data/docs/UsersRolesApi.md +21 -21
- data/docs/WorkersApi.md +11 -11
- data/lib/pulpcore_client/api/access_policies_api.rb +31 -31
- data/lib/pulpcore_client/api/artifacts_api.rb +29 -29
- data/lib/pulpcore_client/api/content_api.rb +5 -5
- data/lib/pulpcore_client/api/contentguards_api.rb +6 -6
- data/lib/pulpcore_client/api/contentguards_content_redirect_api.rb +64 -64
- data/lib/pulpcore_client/api/contentguards_rbac_api.rb +64 -64
- data/lib/pulpcore_client/api/distributions_api.rb +6 -6
- data/lib/pulpcore_client/api/docs_api_json_api.rb +89 -0
- data/lib/pulpcore_client/api/docs_api_yaml_api.rb +89 -0
- data/lib/pulpcore_client/api/exporters_filesystem_api.rb +37 -37
- data/lib/pulpcore_client/api/exporters_filesystem_exports_api.rb +25 -25
- data/lib/pulpcore_client/api/exporters_pulp_api.rb +37 -37
- data/lib/pulpcore_client/api/exporters_pulp_exports_api.rb +25 -25
- data/lib/pulpcore_client/api/groups_api.rb +63 -63
- data/lib/pulpcore_client/api/groups_roles_api.rb +25 -25
- data/lib/pulpcore_client/api/groups_users_api.rb +19 -19
- data/lib/pulpcore_client/api/importers_pulp_api.rb +37 -37
- data/lib/pulpcore_client/api/importers_pulp_imports_api.rb +25 -25
- data/lib/pulpcore_client/api/orphans_api.rb +5 -5
- data/lib/pulpcore_client/api/orphans_cleanup_api.rb +6 -6
- data/lib/pulpcore_client/api/publications_api.rb +6 -6
- data/lib/pulpcore_client/api/remotes_api.rb +6 -6
- data/lib/pulpcore_client/api/repair_api.rb +6 -6
- data/lib/pulpcore_client/api/repositories_api.rb +6 -6
- data/lib/pulpcore_client/api/repositories_reclaim_space_api.rb +6 -6
- data/lib/pulpcore_client/api/repository_versions_api.rb +5 -5
- data/lib/pulpcore_client/api/roles_api.rb +37 -37
- data/lib/pulpcore_client/api/signing_services_api.rb +11 -11
- data/lib/pulpcore_client/api/task_groups_api.rb +11 -11
- data/lib/pulpcore_client/api/task_schedules_api.rb +37 -37
- data/lib/pulpcore_client/api/tasks_api.rb +119 -119
- data/lib/pulpcore_client/api/uploads_api.rb +65 -65
- data/lib/pulpcore_client/api/users_api.rb +37 -37
- data/lib/pulpcore_client/api/users_roles_api.rb +25 -25
- data/lib/pulpcore_client/api/workers_api.rb +11 -11
- data/lib/pulpcore_client/configuration.rb +3 -3
- data/lib/pulpcore_client/models/remote_response.rb +20 -20
- data/lib/pulpcore_client/version.rb +1 -1
- data/lib/pulpcore_client.rb +2 -0
- data/spec/api/access_policies_api_spec.rb +10 -10
- data/spec/api/artifacts_api_spec.rb +8 -8
- data/spec/api/content_api_spec.rb +2 -2
- data/spec/api/contentguards_api_spec.rb +2 -2
- data/spec/api/contentguards_content_redirect_api_spec.rb +20 -20
- data/spec/api/contentguards_rbac_api_spec.rb +20 -20
- data/spec/api/distributions_api_spec.rb +2 -2
- data/spec/api/docs_api_json_api_spec.rb +48 -0
- data/spec/api/docs_api_yaml_api_spec.rb +48 -0
- data/spec/api/exporters_filesystem_api_spec.rb +12 -12
- data/spec/api/exporters_filesystem_exports_api_spec.rb +8 -8
- data/spec/api/exporters_pulp_api_spec.rb +12 -12
- data/spec/api/exporters_pulp_exports_api_spec.rb +8 -8
- data/spec/api/groups_api_spec.rb +20 -20
- data/spec/api/groups_roles_api_spec.rb +8 -8
- data/spec/api/groups_users_api_spec.rb +6 -6
- data/spec/api/importers_pulp_api_spec.rb +12 -12
- data/spec/api/importers_pulp_imports_api_spec.rb +8 -8
- data/spec/api/orphans_api_spec.rb +2 -2
- data/spec/api/orphans_cleanup_api_spec.rb +2 -2
- data/spec/api/publications_api_spec.rb +2 -2
- data/spec/api/remotes_api_spec.rb +2 -2
- data/spec/api/repair_api_spec.rb +2 -2
- data/spec/api/repositories_api_spec.rb +2 -2
- data/spec/api/repositories_reclaim_space_api_spec.rb +2 -2
- data/spec/api/repository_versions_api_spec.rb +2 -2
- data/spec/api/roles_api_spec.rb +12 -12
- data/spec/api/signing_services_api_spec.rb +4 -4
- data/spec/api/task_groups_api_spec.rb +4 -4
- data/spec/api/task_schedules_api_spec.rb +12 -12
- data/spec/api/tasks_api_spec.rb +29 -29
- data/spec/api/uploads_api_spec.rb +20 -20
- data/spec/api/users_api_spec.rb +12 -12
- data/spec/api/users_roles_api_spec.rb +8 -8
- data/spec/api/workers_api_spec.rb +4 -4
- data/spec/configuration_spec.rb +3 -3
- metadata +147 -139
data/docs/TasksApi.md
CHANGED
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
# PulpcoreClient::TasksApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
8
|
-
[**delete**](TasksApi.md#delete) | **DELETE** {task_href} | Delete a task
|
|
9
|
-
[**list**](TasksApi.md#list) | **GET** /pulp/api/v3/tasks/ | List tasks
|
|
10
|
-
[**list_roles**](TasksApi.md#list_roles) | **GET** {task_href}list_roles/ |
|
|
11
|
-
[**my_permissions**](TasksApi.md#my_permissions) | **GET** {task_href}my_permissions/ |
|
|
12
|
-
[**purge**](TasksApi.md#purge) | **POST** /pulp/api/v3/tasks/purge/ | Purge Completed Tasks
|
|
13
|
-
[**read**](TasksApi.md#read) | **GET** {task_href} | Inspect a task
|
|
14
|
-
[**remove_role**](TasksApi.md#remove_role) | **POST** {task_href}remove_role/ |
|
|
7
|
+
[**tasks_add_role**](TasksApi.md#tasks_add_role) | **POST** {task_href}add_role/ |
|
|
15
8
|
[**tasks_cancel**](TasksApi.md#tasks_cancel) | **PATCH** {task_href} | Cancel a task
|
|
9
|
+
[**tasks_delete**](TasksApi.md#tasks_delete) | **DELETE** {task_href} | Delete a task
|
|
10
|
+
[**tasks_list**](TasksApi.md#tasks_list) | **GET** /pulp/api/v3/tasks/ | List tasks
|
|
11
|
+
[**tasks_list_roles**](TasksApi.md#tasks_list_roles) | **GET** {task_href}list_roles/ |
|
|
12
|
+
[**tasks_my_permissions**](TasksApi.md#tasks_my_permissions) | **GET** {task_href}my_permissions/ |
|
|
13
|
+
[**tasks_purge**](TasksApi.md#tasks_purge) | **POST** /pulp/api/v3/tasks/purge/ | Purge Completed Tasks
|
|
14
|
+
[**tasks_read**](TasksApi.md#tasks_read) | **GET** {task_href} | Inspect a task
|
|
15
|
+
[**tasks_remove_role**](TasksApi.md#tasks_remove_role) | **POST** {task_href}remove_role/ |
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## tasks_add_role
|
|
20
20
|
|
|
21
|
-
> NestedRoleResponse
|
|
21
|
+
> NestedRoleResponse tasks_add_role(task_href, nested_role)
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
@@ -41,10 +41,10 @@ task_href = 'task_href_example' # String |
|
|
|
41
41
|
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
|
42
42
|
|
|
43
43
|
begin
|
|
44
|
-
result = api_instance.
|
|
44
|
+
result = api_instance.tasks_add_role(task_href, nested_role)
|
|
45
45
|
p result
|
|
46
46
|
rescue PulpcoreClient::ApiError => e
|
|
47
|
-
puts "Exception when calling TasksApi->
|
|
47
|
+
puts "Exception when calling TasksApi->tasks_add_role: #{e}"
|
|
48
48
|
end
|
|
49
49
|
```
|
|
50
50
|
|
|
@@ -70,9 +70,64 @@ Name | Type | Description | Notes
|
|
|
70
70
|
- **Accept**: application/json
|
|
71
71
|
|
|
72
72
|
|
|
73
|
-
##
|
|
73
|
+
## tasks_cancel
|
|
74
|
+
|
|
75
|
+
> TaskResponse tasks_cancel(task_href, patched_task_cancel)
|
|
76
|
+
|
|
77
|
+
Cancel a task
|
|
78
|
+
|
|
79
|
+
This operation cancels a task.
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
|
|
83
|
+
```ruby
|
|
84
|
+
# load the gem
|
|
85
|
+
require 'pulpcore_client'
|
|
86
|
+
# setup authorization
|
|
87
|
+
PulpcoreClient.configure do |config|
|
|
88
|
+
# Configure HTTP basic authorization: basicAuth
|
|
89
|
+
config.username = 'YOUR USERNAME'
|
|
90
|
+
config.password = 'YOUR PASSWORD'
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
api_instance = PulpcoreClient::TasksApi.new
|
|
94
|
+
task_href = 'task_href_example' # String |
|
|
95
|
+
patched_task_cancel = PulpcoreClient::PatchedTaskCancel.new # PatchedTaskCancel |
|
|
96
|
+
|
|
97
|
+
begin
|
|
98
|
+
#Cancel a task
|
|
99
|
+
result = api_instance.tasks_cancel(task_href, patched_task_cancel)
|
|
100
|
+
p result
|
|
101
|
+
rescue PulpcoreClient::ApiError => e
|
|
102
|
+
puts "Exception when calling TasksApi->tasks_cancel: #{e}"
|
|
103
|
+
end
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Parameters
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
Name | Type | Description | Notes
|
|
110
|
+
------------- | ------------- | ------------- | -------------
|
|
111
|
+
**task_href** | **String**| |
|
|
112
|
+
**patched_task_cancel** | [**PatchedTaskCancel**](PatchedTaskCancel.md)| |
|
|
113
|
+
|
|
114
|
+
### Return type
|
|
115
|
+
|
|
116
|
+
[**TaskResponse**](TaskResponse.md)
|
|
117
|
+
|
|
118
|
+
### Authorization
|
|
119
|
+
|
|
120
|
+
[basicAuth](../README.md#basicAuth)
|
|
121
|
+
|
|
122
|
+
### HTTP request headers
|
|
123
|
+
|
|
124
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
125
|
+
- **Accept**: application/json
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
## tasks_delete
|
|
74
129
|
|
|
75
|
-
>
|
|
130
|
+
> tasks_delete(task_href)
|
|
76
131
|
|
|
77
132
|
Delete a task
|
|
78
133
|
|
|
@@ -95,9 +150,9 @@ task_href = 'task_href_example' # String |
|
|
|
95
150
|
|
|
96
151
|
begin
|
|
97
152
|
#Delete a task
|
|
98
|
-
api_instance.
|
|
153
|
+
api_instance.tasks_delete(task_href)
|
|
99
154
|
rescue PulpcoreClient::ApiError => e
|
|
100
|
-
puts "Exception when calling TasksApi->
|
|
155
|
+
puts "Exception when calling TasksApi->tasks_delete: #{e}"
|
|
101
156
|
end
|
|
102
157
|
```
|
|
103
158
|
|
|
@@ -122,9 +177,9 @@ nil (empty response body)
|
|
|
122
177
|
- **Accept**: Not defined
|
|
123
178
|
|
|
124
179
|
|
|
125
|
-
##
|
|
180
|
+
## tasks_list
|
|
126
181
|
|
|
127
|
-
> PaginatedTaskResponseList
|
|
182
|
+
> PaginatedTaskResponseList tasks_list(opts)
|
|
128
183
|
|
|
129
184
|
List tasks
|
|
130
185
|
|
|
@@ -178,10 +233,10 @@ opts = {
|
|
|
178
233
|
|
|
179
234
|
begin
|
|
180
235
|
#List tasks
|
|
181
|
-
result = api_instance.
|
|
236
|
+
result = api_instance.tasks_list(opts)
|
|
182
237
|
p result
|
|
183
238
|
rescue PulpcoreClient::ApiError => e
|
|
184
|
-
puts "Exception when calling TasksApi->
|
|
239
|
+
puts "Exception when calling TasksApi->tasks_list: #{e}"
|
|
185
240
|
end
|
|
186
241
|
```
|
|
187
242
|
|
|
@@ -235,9 +290,9 @@ Name | Type | Description | Notes
|
|
|
235
290
|
- **Accept**: application/json
|
|
236
291
|
|
|
237
292
|
|
|
238
|
-
##
|
|
293
|
+
## tasks_list_roles
|
|
239
294
|
|
|
240
|
-
> ObjectRolesResponse
|
|
295
|
+
> ObjectRolesResponse tasks_list_roles(task_href, opts)
|
|
241
296
|
|
|
242
297
|
|
|
243
298
|
|
|
@@ -263,10 +318,10 @@ opts = {
|
|
|
263
318
|
}
|
|
264
319
|
|
|
265
320
|
begin
|
|
266
|
-
result = api_instance.
|
|
321
|
+
result = api_instance.tasks_list_roles(task_href, opts)
|
|
267
322
|
p result
|
|
268
323
|
rescue PulpcoreClient::ApiError => e
|
|
269
|
-
puts "Exception when calling TasksApi->
|
|
324
|
+
puts "Exception when calling TasksApi->tasks_list_roles: #{e}"
|
|
270
325
|
end
|
|
271
326
|
```
|
|
272
327
|
|
|
@@ -293,9 +348,9 @@ Name | Type | Description | Notes
|
|
|
293
348
|
- **Accept**: application/json
|
|
294
349
|
|
|
295
350
|
|
|
296
|
-
##
|
|
351
|
+
## tasks_my_permissions
|
|
297
352
|
|
|
298
|
-
> MyPermissionsResponse
|
|
353
|
+
> MyPermissionsResponse tasks_my_permissions(task_href, opts)
|
|
299
354
|
|
|
300
355
|
|
|
301
356
|
|
|
@@ -321,10 +376,10 @@ opts = {
|
|
|
321
376
|
}
|
|
322
377
|
|
|
323
378
|
begin
|
|
324
|
-
result = api_instance.
|
|
379
|
+
result = api_instance.tasks_my_permissions(task_href, opts)
|
|
325
380
|
p result
|
|
326
381
|
rescue PulpcoreClient::ApiError => e
|
|
327
|
-
puts "Exception when calling TasksApi->
|
|
382
|
+
puts "Exception when calling TasksApi->tasks_my_permissions: #{e}"
|
|
328
383
|
end
|
|
329
384
|
```
|
|
330
385
|
|
|
@@ -351,9 +406,9 @@ Name | Type | Description | Notes
|
|
|
351
406
|
- **Accept**: application/json
|
|
352
407
|
|
|
353
408
|
|
|
354
|
-
##
|
|
409
|
+
## tasks_purge
|
|
355
410
|
|
|
356
|
-
> AsyncOperationResponse
|
|
411
|
+
> AsyncOperationResponse tasks_purge(purge)
|
|
357
412
|
|
|
358
413
|
Purge Completed Tasks
|
|
359
414
|
|
|
@@ -376,10 +431,10 @@ purge = PulpcoreClient::Purge.new # Purge |
|
|
|
376
431
|
|
|
377
432
|
begin
|
|
378
433
|
#Purge Completed Tasks
|
|
379
|
-
result = api_instance.
|
|
434
|
+
result = api_instance.tasks_purge(purge)
|
|
380
435
|
p result
|
|
381
436
|
rescue PulpcoreClient::ApiError => e
|
|
382
|
-
puts "Exception when calling TasksApi->
|
|
437
|
+
puts "Exception when calling TasksApi->tasks_purge: #{e}"
|
|
383
438
|
end
|
|
384
439
|
```
|
|
385
440
|
|
|
@@ -404,9 +459,9 @@ Name | Type | Description | Notes
|
|
|
404
459
|
- **Accept**: application/json
|
|
405
460
|
|
|
406
461
|
|
|
407
|
-
##
|
|
462
|
+
## tasks_read
|
|
408
463
|
|
|
409
|
-
> TaskResponse
|
|
464
|
+
> TaskResponse tasks_read(task_href, opts)
|
|
410
465
|
|
|
411
466
|
Inspect a task
|
|
412
467
|
|
|
@@ -433,10 +488,10 @@ opts = {
|
|
|
433
488
|
|
|
434
489
|
begin
|
|
435
490
|
#Inspect a task
|
|
436
|
-
result = api_instance.
|
|
491
|
+
result = api_instance.tasks_read(task_href, opts)
|
|
437
492
|
p result
|
|
438
493
|
rescue PulpcoreClient::ApiError => e
|
|
439
|
-
puts "Exception when calling TasksApi->
|
|
494
|
+
puts "Exception when calling TasksApi->tasks_read: #{e}"
|
|
440
495
|
end
|
|
441
496
|
```
|
|
442
497
|
|
|
@@ -463,9 +518,9 @@ Name | Type | Description | Notes
|
|
|
463
518
|
- **Accept**: application/json
|
|
464
519
|
|
|
465
520
|
|
|
466
|
-
##
|
|
521
|
+
## tasks_remove_role
|
|
467
522
|
|
|
468
|
-
> NestedRoleResponse
|
|
523
|
+
> NestedRoleResponse tasks_remove_role(task_href, nested_role)
|
|
469
524
|
|
|
470
525
|
|
|
471
526
|
|
|
@@ -488,10 +543,10 @@ task_href = 'task_href_example' # String |
|
|
|
488
543
|
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
|
489
544
|
|
|
490
545
|
begin
|
|
491
|
-
result = api_instance.
|
|
546
|
+
result = api_instance.tasks_remove_role(task_href, nested_role)
|
|
492
547
|
p result
|
|
493
548
|
rescue PulpcoreClient::ApiError => e
|
|
494
|
-
puts "Exception when calling TasksApi->
|
|
549
|
+
puts "Exception when calling TasksApi->tasks_remove_role: #{e}"
|
|
495
550
|
end
|
|
496
551
|
```
|
|
497
552
|
|
|
@@ -516,58 +571,3 @@ Name | Type | Description | Notes
|
|
|
516
571
|
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
517
572
|
- **Accept**: application/json
|
|
518
573
|
|
|
519
|
-
|
|
520
|
-
## tasks_cancel
|
|
521
|
-
|
|
522
|
-
> TaskResponse tasks_cancel(task_href, patched_task_cancel)
|
|
523
|
-
|
|
524
|
-
Cancel a task
|
|
525
|
-
|
|
526
|
-
This operation cancels a task.
|
|
527
|
-
|
|
528
|
-
### Example
|
|
529
|
-
|
|
530
|
-
```ruby
|
|
531
|
-
# load the gem
|
|
532
|
-
require 'pulpcore_client'
|
|
533
|
-
# setup authorization
|
|
534
|
-
PulpcoreClient.configure do |config|
|
|
535
|
-
# Configure HTTP basic authorization: basicAuth
|
|
536
|
-
config.username = 'YOUR USERNAME'
|
|
537
|
-
config.password = 'YOUR PASSWORD'
|
|
538
|
-
end
|
|
539
|
-
|
|
540
|
-
api_instance = PulpcoreClient::TasksApi.new
|
|
541
|
-
task_href = 'task_href_example' # String |
|
|
542
|
-
patched_task_cancel = PulpcoreClient::PatchedTaskCancel.new # PatchedTaskCancel |
|
|
543
|
-
|
|
544
|
-
begin
|
|
545
|
-
#Cancel a task
|
|
546
|
-
result = api_instance.tasks_cancel(task_href, patched_task_cancel)
|
|
547
|
-
p result
|
|
548
|
-
rescue PulpcoreClient::ApiError => e
|
|
549
|
-
puts "Exception when calling TasksApi->tasks_cancel: #{e}"
|
|
550
|
-
end
|
|
551
|
-
```
|
|
552
|
-
|
|
553
|
-
### Parameters
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
Name | Type | Description | Notes
|
|
557
|
-
------------- | ------------- | ------------- | -------------
|
|
558
|
-
**task_href** | **String**| |
|
|
559
|
-
**patched_task_cancel** | [**PatchedTaskCancel**](PatchedTaskCancel.md)| |
|
|
560
|
-
|
|
561
|
-
### Return type
|
|
562
|
-
|
|
563
|
-
[**TaskResponse**](TaskResponse.md)
|
|
564
|
-
|
|
565
|
-
### Authorization
|
|
566
|
-
|
|
567
|
-
[basicAuth](../README.md#basicAuth)
|
|
568
|
-
|
|
569
|
-
### HTTP request headers
|
|
570
|
-
|
|
571
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
572
|
-
- **Accept**: application/json
|
|
573
|
-
|
data/docs/UploadsApi.md
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
# PulpcoreClient::UploadsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
8
|
-
[**
|
|
9
|
-
[**
|
|
10
|
-
[**
|
|
11
|
-
[**
|
|
12
|
-
[**
|
|
13
|
-
[**
|
|
14
|
-
[**
|
|
15
|
-
[**
|
|
16
|
-
[**
|
|
7
|
+
[**uploads_add_role**](UploadsApi.md#uploads_add_role) | **POST** {upload_href}add_role/ |
|
|
8
|
+
[**uploads_commit**](UploadsApi.md#uploads_commit) | **POST** {upload_href}commit/ | Finish an Upload
|
|
9
|
+
[**uploads_create**](UploadsApi.md#uploads_create) | **POST** /pulp/api/v3/uploads/ | Create an upload
|
|
10
|
+
[**uploads_delete**](UploadsApi.md#uploads_delete) | **DELETE** {upload_href} | Delete an upload
|
|
11
|
+
[**uploads_list**](UploadsApi.md#uploads_list) | **GET** /pulp/api/v3/uploads/ | List uploads
|
|
12
|
+
[**uploads_list_roles**](UploadsApi.md#uploads_list_roles) | **GET** {upload_href}list_roles/ |
|
|
13
|
+
[**uploads_my_permissions**](UploadsApi.md#uploads_my_permissions) | **GET** {upload_href}my_permissions/ |
|
|
14
|
+
[**uploads_read**](UploadsApi.md#uploads_read) | **GET** {upload_href} | Inspect an upload
|
|
15
|
+
[**uploads_remove_role**](UploadsApi.md#uploads_remove_role) | **POST** {upload_href}remove_role/ |
|
|
16
|
+
[**uploads_update**](UploadsApi.md#uploads_update) | **PUT** {upload_href} | Upload a file chunk
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## uploads_add_role
|
|
21
21
|
|
|
22
|
-
> NestedRoleResponse
|
|
22
|
+
> NestedRoleResponse uploads_add_role(upload_href, upload)
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -42,10 +42,10 @@ upload_href = 'upload_href_example' # String |
|
|
|
42
42
|
upload = PulpcoreClient::Upload.new # Upload |
|
|
43
43
|
|
|
44
44
|
begin
|
|
45
|
-
result = api_instance.
|
|
45
|
+
result = api_instance.uploads_add_role(upload_href, upload)
|
|
46
46
|
p result
|
|
47
47
|
rescue PulpcoreClient::ApiError => e
|
|
48
|
-
puts "Exception when calling UploadsApi->
|
|
48
|
+
puts "Exception when calling UploadsApi->uploads_add_role: #{e}"
|
|
49
49
|
end
|
|
50
50
|
```
|
|
51
51
|
|
|
@@ -71,9 +71,9 @@ Name | Type | Description | Notes
|
|
|
71
71
|
- **Accept**: application/json
|
|
72
72
|
|
|
73
73
|
|
|
74
|
-
##
|
|
74
|
+
## uploads_commit
|
|
75
75
|
|
|
76
|
-
> AsyncOperationResponse
|
|
76
|
+
> AsyncOperationResponse uploads_commit(upload_href, upload_commit)
|
|
77
77
|
|
|
78
78
|
Finish an Upload
|
|
79
79
|
|
|
@@ -97,10 +97,10 @@ upload_commit = PulpcoreClient::UploadCommit.new # UploadCommit |
|
|
|
97
97
|
|
|
98
98
|
begin
|
|
99
99
|
#Finish an Upload
|
|
100
|
-
result = api_instance.
|
|
100
|
+
result = api_instance.uploads_commit(upload_href, upload_commit)
|
|
101
101
|
p result
|
|
102
102
|
rescue PulpcoreClient::ApiError => e
|
|
103
|
-
puts "Exception when calling UploadsApi->
|
|
103
|
+
puts "Exception when calling UploadsApi->uploads_commit: #{e}"
|
|
104
104
|
end
|
|
105
105
|
```
|
|
106
106
|
|
|
@@ -126,9 +126,9 @@ Name | Type | Description | Notes
|
|
|
126
126
|
- **Accept**: application/json
|
|
127
127
|
|
|
128
128
|
|
|
129
|
-
##
|
|
129
|
+
## uploads_create
|
|
130
130
|
|
|
131
|
-
> UploadResponse
|
|
131
|
+
> UploadResponse uploads_create(upload)
|
|
132
132
|
|
|
133
133
|
Create an upload
|
|
134
134
|
|
|
@@ -151,10 +151,10 @@ upload = PulpcoreClient::Upload.new # Upload |
|
|
|
151
151
|
|
|
152
152
|
begin
|
|
153
153
|
#Create an upload
|
|
154
|
-
result = api_instance.
|
|
154
|
+
result = api_instance.uploads_create(upload)
|
|
155
155
|
p result
|
|
156
156
|
rescue PulpcoreClient::ApiError => e
|
|
157
|
-
puts "Exception when calling UploadsApi->
|
|
157
|
+
puts "Exception when calling UploadsApi->uploads_create: #{e}"
|
|
158
158
|
end
|
|
159
159
|
```
|
|
160
160
|
|
|
@@ -179,9 +179,9 @@ Name | Type | Description | Notes
|
|
|
179
179
|
- **Accept**: application/json
|
|
180
180
|
|
|
181
181
|
|
|
182
|
-
##
|
|
182
|
+
## uploads_delete
|
|
183
183
|
|
|
184
|
-
>
|
|
184
|
+
> uploads_delete(upload_href)
|
|
185
185
|
|
|
186
186
|
Delete an upload
|
|
187
187
|
|
|
@@ -204,9 +204,9 @@ upload_href = 'upload_href_example' # String |
|
|
|
204
204
|
|
|
205
205
|
begin
|
|
206
206
|
#Delete an upload
|
|
207
|
-
api_instance.
|
|
207
|
+
api_instance.uploads_delete(upload_href)
|
|
208
208
|
rescue PulpcoreClient::ApiError => e
|
|
209
|
-
puts "Exception when calling UploadsApi->
|
|
209
|
+
puts "Exception when calling UploadsApi->uploads_delete: #{e}"
|
|
210
210
|
end
|
|
211
211
|
```
|
|
212
212
|
|
|
@@ -231,9 +231,9 @@ nil (empty response body)
|
|
|
231
231
|
- **Accept**: Not defined
|
|
232
232
|
|
|
233
233
|
|
|
234
|
-
##
|
|
234
|
+
## uploads_list
|
|
235
235
|
|
|
236
|
-
> PaginatedUploadResponseList
|
|
236
|
+
> PaginatedUploadResponseList uploads_list(opts)
|
|
237
237
|
|
|
238
238
|
List uploads
|
|
239
239
|
|
|
@@ -261,10 +261,10 @@ opts = {
|
|
|
261
261
|
|
|
262
262
|
begin
|
|
263
263
|
#List uploads
|
|
264
|
-
result = api_instance.
|
|
264
|
+
result = api_instance.uploads_list(opts)
|
|
265
265
|
p result
|
|
266
266
|
rescue PulpcoreClient::ApiError => e
|
|
267
|
-
puts "Exception when calling UploadsApi->
|
|
267
|
+
puts "Exception when calling UploadsApi->uploads_list: #{e}"
|
|
268
268
|
end
|
|
269
269
|
```
|
|
270
270
|
|
|
@@ -292,9 +292,9 @@ Name | Type | Description | Notes
|
|
|
292
292
|
- **Accept**: application/json
|
|
293
293
|
|
|
294
294
|
|
|
295
|
-
##
|
|
295
|
+
## uploads_list_roles
|
|
296
296
|
|
|
297
|
-
> ObjectRolesResponse
|
|
297
|
+
> ObjectRolesResponse uploads_list_roles(upload_href, opts)
|
|
298
298
|
|
|
299
299
|
|
|
300
300
|
|
|
@@ -320,10 +320,10 @@ opts = {
|
|
|
320
320
|
}
|
|
321
321
|
|
|
322
322
|
begin
|
|
323
|
-
result = api_instance.
|
|
323
|
+
result = api_instance.uploads_list_roles(upload_href, opts)
|
|
324
324
|
p result
|
|
325
325
|
rescue PulpcoreClient::ApiError => e
|
|
326
|
-
puts "Exception when calling UploadsApi->
|
|
326
|
+
puts "Exception when calling UploadsApi->uploads_list_roles: #{e}"
|
|
327
327
|
end
|
|
328
328
|
```
|
|
329
329
|
|
|
@@ -350,9 +350,9 @@ Name | Type | Description | Notes
|
|
|
350
350
|
- **Accept**: application/json
|
|
351
351
|
|
|
352
352
|
|
|
353
|
-
##
|
|
353
|
+
## uploads_my_permissions
|
|
354
354
|
|
|
355
|
-
> MyPermissionsResponse
|
|
355
|
+
> MyPermissionsResponse uploads_my_permissions(upload_href, opts)
|
|
356
356
|
|
|
357
357
|
|
|
358
358
|
|
|
@@ -378,10 +378,10 @@ opts = {
|
|
|
378
378
|
}
|
|
379
379
|
|
|
380
380
|
begin
|
|
381
|
-
result = api_instance.
|
|
381
|
+
result = api_instance.uploads_my_permissions(upload_href, opts)
|
|
382
382
|
p result
|
|
383
383
|
rescue PulpcoreClient::ApiError => e
|
|
384
|
-
puts "Exception when calling UploadsApi->
|
|
384
|
+
puts "Exception when calling UploadsApi->uploads_my_permissions: #{e}"
|
|
385
385
|
end
|
|
386
386
|
```
|
|
387
387
|
|
|
@@ -408,9 +408,9 @@ Name | Type | Description | Notes
|
|
|
408
408
|
- **Accept**: application/json
|
|
409
409
|
|
|
410
410
|
|
|
411
|
-
##
|
|
411
|
+
## uploads_read
|
|
412
412
|
|
|
413
|
-
> UploadDetailResponse
|
|
413
|
+
> UploadDetailResponse uploads_read(upload_href, opts)
|
|
414
414
|
|
|
415
415
|
Inspect an upload
|
|
416
416
|
|
|
@@ -437,10 +437,10 @@ opts = {
|
|
|
437
437
|
|
|
438
438
|
begin
|
|
439
439
|
#Inspect an upload
|
|
440
|
-
result = api_instance.
|
|
440
|
+
result = api_instance.uploads_read(upload_href, opts)
|
|
441
441
|
p result
|
|
442
442
|
rescue PulpcoreClient::ApiError => e
|
|
443
|
-
puts "Exception when calling UploadsApi->
|
|
443
|
+
puts "Exception when calling UploadsApi->uploads_read: #{e}"
|
|
444
444
|
end
|
|
445
445
|
```
|
|
446
446
|
|
|
@@ -467,9 +467,9 @@ Name | Type | Description | Notes
|
|
|
467
467
|
- **Accept**: application/json
|
|
468
468
|
|
|
469
469
|
|
|
470
|
-
##
|
|
470
|
+
## uploads_remove_role
|
|
471
471
|
|
|
472
|
-
> NestedRoleResponse
|
|
472
|
+
> NestedRoleResponse uploads_remove_role(upload_href, upload)
|
|
473
473
|
|
|
474
474
|
|
|
475
475
|
|
|
@@ -492,10 +492,10 @@ upload_href = 'upload_href_example' # String |
|
|
|
492
492
|
upload = PulpcoreClient::Upload.new # Upload |
|
|
493
493
|
|
|
494
494
|
begin
|
|
495
|
-
result = api_instance.
|
|
495
|
+
result = api_instance.uploads_remove_role(upload_href, upload)
|
|
496
496
|
p result
|
|
497
497
|
rescue PulpcoreClient::ApiError => e
|
|
498
|
-
puts "Exception when calling UploadsApi->
|
|
498
|
+
puts "Exception when calling UploadsApi->uploads_remove_role: #{e}"
|
|
499
499
|
end
|
|
500
500
|
```
|
|
501
501
|
|
|
@@ -521,9 +521,9 @@ Name | Type | Description | Notes
|
|
|
521
521
|
- **Accept**: application/json
|
|
522
522
|
|
|
523
523
|
|
|
524
|
-
##
|
|
524
|
+
## uploads_update
|
|
525
525
|
|
|
526
|
-
> UploadResponse
|
|
526
|
+
> UploadResponse uploads_update(content_range, upload_href, file, opts)
|
|
527
527
|
|
|
528
528
|
Upload a file chunk
|
|
529
529
|
|
|
@@ -551,10 +551,10 @@ opts = {
|
|
|
551
551
|
|
|
552
552
|
begin
|
|
553
553
|
#Upload a file chunk
|
|
554
|
-
result = api_instance.
|
|
554
|
+
result = api_instance.uploads_update(content_range, upload_href, file, opts)
|
|
555
555
|
p result
|
|
556
556
|
rescue PulpcoreClient::ApiError => e
|
|
557
|
-
puts "Exception when calling UploadsApi->
|
|
557
|
+
puts "Exception when calling UploadsApi->uploads_update: #{e}"
|
|
558
558
|
end
|
|
559
559
|
```
|
|
560
560
|
|