pulpcore_client 3.28.28 → 3.28.30
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 +157 -155
- data/docs/AccessPoliciesApi.md +26 -26
- data/docs/ArtifactDistributionResponse.md +12 -12
- data/docs/ArtifactsApi.md +21 -21
- data/docs/ContentApi.md +8 -8
- data/docs/ContentguardsApi.md +8 -8
- data/docs/ContentguardsContentRedirectApi.md +51 -51
- data/docs/ContentguardsRbacApi.md +51 -51
- data/docs/DistributionsApi.md +8 -8
- data/docs/DistributionsArtifactsApi.md +11 -11
- data/docs/DocsApiJsonApi.md +61 -0
- data/docs/DocsApiYamlApi.md +61 -0
- data/docs/DomainsApi.md +31 -31
- 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 +8 -8
- data/docs/RemoteResponseHiddenFields.md +2 -2
- data/docs/RemotesApi.md +8 -8
- data/docs/RepairApi.md +6 -6
- data/docs/RepositoriesApi.md +8 -8
- 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/UpstreamPulpsApi.md +36 -36
- 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 +8 -8
- data/lib/pulpcore_client/api/contentguards_api.rb +8 -8
- data/lib/pulpcore_client/api/contentguards_content_redirect_api.rb +63 -63
- data/lib/pulpcore_client/api/contentguards_rbac_api.rb +63 -63
- data/lib/pulpcore_client/api/distributions_api.rb +8 -8
- data/lib/pulpcore_client/api/distributions_artifacts_api.rb +11 -11
- 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/domains_api.rb +37 -37
- 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 +7 -11
- data/lib/pulpcore_client/api/remotes_api.rb +7 -11
- data/lib/pulpcore_client/api/repair_api.rb +6 -6
- data/lib/pulpcore_client/api/repositories_api.rb +7 -11
- 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/upstream_pulps_api.rb +43 -43
- 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/artifact_distribution_response.rb +50 -50
- data/lib/pulpcore_client/models/remote_response.rb +20 -20
- data/lib/pulpcore_client/models/remote_response_hidden_fields.rb +10 -0
- 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 +3 -3
- data/spec/api/contentguards_api_spec.rb +3 -3
- 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 +3 -3
- data/spec/api/distributions_artifacts_api_spec.rb +4 -4
- 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/domains_api_spec.rb +12 -12
- 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 +3 -3
- data/spec/api/remotes_api_spec.rb +3 -3
- data/spec/api/repair_api_spec.rb +2 -2
- data/spec/api/repositories_api_spec.rb +3 -3
- 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/upstream_pulps_api_spec.rb +14 -14
- 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
- data/spec/models/artifact_distribution_response_spec.rb +8 -8
- metadata +164 -156
data/docs/SigningServicesApi.md
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
# PulpcoreClient::SigningServicesApi
|
|
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
|
-
[**
|
|
7
|
+
[**signing_services_list**](SigningServicesApi.md#signing_services_list) | **GET** /pulp/api/v3/signing-services/ | List signing services
|
|
8
|
+
[**signing_services_read**](SigningServicesApi.md#signing_services_read) | **GET** {signing_service_href} | Inspect a signing service
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## signing_services_list
|
|
13
13
|
|
|
14
|
-
> PaginatedSigningServiceResponseList
|
|
14
|
+
> PaginatedSigningServiceResponseList signing_services_list(opts)
|
|
15
15
|
|
|
16
16
|
List signing services
|
|
17
17
|
|
|
@@ -43,10 +43,10 @@ opts = {
|
|
|
43
43
|
|
|
44
44
|
begin
|
|
45
45
|
#List signing services
|
|
46
|
-
result = api_instance.
|
|
46
|
+
result = api_instance.signing_services_list(opts)
|
|
47
47
|
p result
|
|
48
48
|
rescue PulpcoreClient::ApiError => e
|
|
49
|
-
puts "Exception when calling SigningServicesApi->
|
|
49
|
+
puts "Exception when calling SigningServicesApi->signing_services_list: #{e}"
|
|
50
50
|
end
|
|
51
51
|
```
|
|
52
52
|
|
|
@@ -78,9 +78,9 @@ Name | Type | Description | Notes
|
|
|
78
78
|
- **Accept**: application/json
|
|
79
79
|
|
|
80
80
|
|
|
81
|
-
##
|
|
81
|
+
## signing_services_read
|
|
82
82
|
|
|
83
|
-
> SigningServiceResponse
|
|
83
|
+
> SigningServiceResponse signing_services_read(signing_service_href, opts)
|
|
84
84
|
|
|
85
85
|
Inspect a signing service
|
|
86
86
|
|
|
@@ -107,10 +107,10 @@ opts = {
|
|
|
107
107
|
|
|
108
108
|
begin
|
|
109
109
|
#Inspect a signing service
|
|
110
|
-
result = api_instance.
|
|
110
|
+
result = api_instance.signing_services_read(signing_service_href, opts)
|
|
111
111
|
p result
|
|
112
112
|
rescue PulpcoreClient::ApiError => e
|
|
113
|
-
puts "Exception when calling SigningServicesApi->
|
|
113
|
+
puts "Exception when calling SigningServicesApi->signing_services_read: #{e}"
|
|
114
114
|
end
|
|
115
115
|
```
|
|
116
116
|
|
data/docs/StatusApi.md
CHANGED
data/docs/TaskGroupsApi.md
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
# PulpcoreClient::TaskGroupsApi
|
|
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
|
-
[**
|
|
7
|
+
[**task_groups_list**](TaskGroupsApi.md#task_groups_list) | **GET** /pulp/api/v3/task-groups/ | List task groups
|
|
8
|
+
[**task_groups_read**](TaskGroupsApi.md#task_groups_read) | **GET** {task_group_href} | Inspect a task group
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## task_groups_list
|
|
13
13
|
|
|
14
|
-
> PaginatedTaskGroupResponseList
|
|
14
|
+
> PaginatedTaskGroupResponseList task_groups_list(opts)
|
|
15
15
|
|
|
16
16
|
List task groups
|
|
17
17
|
|
|
@@ -39,10 +39,10 @@ opts = {
|
|
|
39
39
|
|
|
40
40
|
begin
|
|
41
41
|
#List task groups
|
|
42
|
-
result = api_instance.
|
|
42
|
+
result = api_instance.task_groups_list(opts)
|
|
43
43
|
p result
|
|
44
44
|
rescue PulpcoreClient::ApiError => e
|
|
45
|
-
puts "Exception when calling TaskGroupsApi->
|
|
45
|
+
puts "Exception when calling TaskGroupsApi->task_groups_list: #{e}"
|
|
46
46
|
end
|
|
47
47
|
```
|
|
48
48
|
|
|
@@ -70,9 +70,9 @@ Name | Type | Description | Notes
|
|
|
70
70
|
- **Accept**: application/json
|
|
71
71
|
|
|
72
72
|
|
|
73
|
-
##
|
|
73
|
+
## task_groups_read
|
|
74
74
|
|
|
75
|
-
> TaskGroupResponse
|
|
75
|
+
> TaskGroupResponse task_groups_read(task_group_href, opts)
|
|
76
76
|
|
|
77
77
|
Inspect a task group
|
|
78
78
|
|
|
@@ -99,10 +99,10 @@ opts = {
|
|
|
99
99
|
|
|
100
100
|
begin
|
|
101
101
|
#Inspect a task group
|
|
102
|
-
result = api_instance.
|
|
102
|
+
result = api_instance.task_groups_read(task_group_href, opts)
|
|
103
103
|
p result
|
|
104
104
|
rescue PulpcoreClient::ApiError => e
|
|
105
|
-
puts "Exception when calling TaskGroupsApi->
|
|
105
|
+
puts "Exception when calling TaskGroupsApi->task_groups_read: #{e}"
|
|
106
106
|
end
|
|
107
107
|
```
|
|
108
108
|
|
data/docs/TaskSchedulesApi.md
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
# PulpcoreClient::TaskSchedulesApi
|
|
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
|
-
[**
|
|
7
|
+
[**task_schedules_add_role**](TaskSchedulesApi.md#task_schedules_add_role) | **POST** {task_schedule_href}add_role/ |
|
|
8
|
+
[**task_schedules_list**](TaskSchedulesApi.md#task_schedules_list) | **GET** /pulp/api/v3/task-schedules/ | List task schedules
|
|
9
|
+
[**task_schedules_list_roles**](TaskSchedulesApi.md#task_schedules_list_roles) | **GET** {task_schedule_href}list_roles/ |
|
|
10
|
+
[**task_schedules_my_permissions**](TaskSchedulesApi.md#task_schedules_my_permissions) | **GET** {task_schedule_href}my_permissions/ |
|
|
11
|
+
[**task_schedules_read**](TaskSchedulesApi.md#task_schedules_read) | **GET** {task_schedule_href} | Inspect a task schedule
|
|
12
|
+
[**task_schedules_remove_role**](TaskSchedulesApi.md#task_schedules_remove_role) | **POST** {task_schedule_href}remove_role/ |
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## task_schedules_add_role
|
|
17
17
|
|
|
18
|
-
> NestedRoleResponse
|
|
18
|
+
> NestedRoleResponse task_schedules_add_role(task_schedule_href, nested_role)
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
|
|
@@ -38,10 +38,10 @@ task_schedule_href = 'task_schedule_href_example' # String |
|
|
|
38
38
|
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
|
39
39
|
|
|
40
40
|
begin
|
|
41
|
-
result = api_instance.
|
|
41
|
+
result = api_instance.task_schedules_add_role(task_schedule_href, nested_role)
|
|
42
42
|
p result
|
|
43
43
|
rescue PulpcoreClient::ApiError => e
|
|
44
|
-
puts "Exception when calling TaskSchedulesApi->
|
|
44
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_add_role: #{e}"
|
|
45
45
|
end
|
|
46
46
|
```
|
|
47
47
|
|
|
@@ -67,9 +67,9 @@ Name | Type | Description | Notes
|
|
|
67
67
|
- **Accept**: application/json
|
|
68
68
|
|
|
69
69
|
|
|
70
|
-
##
|
|
70
|
+
## task_schedules_list
|
|
71
71
|
|
|
72
|
-
> PaginatedTaskScheduleResponseList
|
|
72
|
+
> PaginatedTaskScheduleResponseList task_schedules_list(opts)
|
|
73
73
|
|
|
74
74
|
List task schedules
|
|
75
75
|
|
|
@@ -104,10 +104,10 @@ opts = {
|
|
|
104
104
|
|
|
105
105
|
begin
|
|
106
106
|
#List task schedules
|
|
107
|
-
result = api_instance.
|
|
107
|
+
result = api_instance.task_schedules_list(opts)
|
|
108
108
|
p result
|
|
109
109
|
rescue PulpcoreClient::ApiError => e
|
|
110
|
-
puts "Exception when calling TaskSchedulesApi->
|
|
110
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_list: #{e}"
|
|
111
111
|
end
|
|
112
112
|
```
|
|
113
113
|
|
|
@@ -142,9 +142,9 @@ Name | Type | Description | Notes
|
|
|
142
142
|
- **Accept**: application/json
|
|
143
143
|
|
|
144
144
|
|
|
145
|
-
##
|
|
145
|
+
## task_schedules_list_roles
|
|
146
146
|
|
|
147
|
-
> ObjectRolesResponse
|
|
147
|
+
> ObjectRolesResponse task_schedules_list_roles(task_schedule_href, opts)
|
|
148
148
|
|
|
149
149
|
|
|
150
150
|
|
|
@@ -170,10 +170,10 @@ opts = {
|
|
|
170
170
|
}
|
|
171
171
|
|
|
172
172
|
begin
|
|
173
|
-
result = api_instance.
|
|
173
|
+
result = api_instance.task_schedules_list_roles(task_schedule_href, opts)
|
|
174
174
|
p result
|
|
175
175
|
rescue PulpcoreClient::ApiError => e
|
|
176
|
-
puts "Exception when calling TaskSchedulesApi->
|
|
176
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_list_roles: #{e}"
|
|
177
177
|
end
|
|
178
178
|
```
|
|
179
179
|
|
|
@@ -200,9 +200,9 @@ Name | Type | Description | Notes
|
|
|
200
200
|
- **Accept**: application/json
|
|
201
201
|
|
|
202
202
|
|
|
203
|
-
##
|
|
203
|
+
## task_schedules_my_permissions
|
|
204
204
|
|
|
205
|
-
> MyPermissionsResponse
|
|
205
|
+
> MyPermissionsResponse task_schedules_my_permissions(task_schedule_href, opts)
|
|
206
206
|
|
|
207
207
|
|
|
208
208
|
|
|
@@ -228,10 +228,10 @@ opts = {
|
|
|
228
228
|
}
|
|
229
229
|
|
|
230
230
|
begin
|
|
231
|
-
result = api_instance.
|
|
231
|
+
result = api_instance.task_schedules_my_permissions(task_schedule_href, opts)
|
|
232
232
|
p result
|
|
233
233
|
rescue PulpcoreClient::ApiError => e
|
|
234
|
-
puts "Exception when calling TaskSchedulesApi->
|
|
234
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_my_permissions: #{e}"
|
|
235
235
|
end
|
|
236
236
|
```
|
|
237
237
|
|
|
@@ -258,9 +258,9 @@ Name | Type | Description | Notes
|
|
|
258
258
|
- **Accept**: application/json
|
|
259
259
|
|
|
260
260
|
|
|
261
|
-
##
|
|
261
|
+
## task_schedules_read
|
|
262
262
|
|
|
263
|
-
> TaskScheduleResponse
|
|
263
|
+
> TaskScheduleResponse task_schedules_read(task_schedule_href, opts)
|
|
264
264
|
|
|
265
265
|
Inspect a task schedule
|
|
266
266
|
|
|
@@ -287,10 +287,10 @@ opts = {
|
|
|
287
287
|
|
|
288
288
|
begin
|
|
289
289
|
#Inspect a task schedule
|
|
290
|
-
result = api_instance.
|
|
290
|
+
result = api_instance.task_schedules_read(task_schedule_href, opts)
|
|
291
291
|
p result
|
|
292
292
|
rescue PulpcoreClient::ApiError => e
|
|
293
|
-
puts "Exception when calling TaskSchedulesApi->
|
|
293
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_read: #{e}"
|
|
294
294
|
end
|
|
295
295
|
```
|
|
296
296
|
|
|
@@ -317,9 +317,9 @@ Name | Type | Description | Notes
|
|
|
317
317
|
- **Accept**: application/json
|
|
318
318
|
|
|
319
319
|
|
|
320
|
-
##
|
|
320
|
+
## task_schedules_remove_role
|
|
321
321
|
|
|
322
|
-
> NestedRoleResponse
|
|
322
|
+
> NestedRoleResponse task_schedules_remove_role(task_schedule_href, nested_role)
|
|
323
323
|
|
|
324
324
|
|
|
325
325
|
|
|
@@ -342,10 +342,10 @@ task_schedule_href = 'task_schedule_href_example' # String |
|
|
|
342
342
|
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
|
343
343
|
|
|
344
344
|
begin
|
|
345
|
-
result = api_instance.
|
|
345
|
+
result = api_instance.task_schedules_remove_role(task_schedule_href, nested_role)
|
|
346
346
|
p result
|
|
347
347
|
rescue PulpcoreClient::ApiError => e
|
|
348
|
-
puts "Exception when calling TaskSchedulesApi->
|
|
348
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_remove_role: #{e}"
|
|
349
349
|
end
|
|
350
350
|
```
|
|
351
351
|
|
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
|
|
|
@@ -187,10 +242,10 @@ opts = {
|
|
|
187
242
|
|
|
188
243
|
begin
|
|
189
244
|
#List tasks
|
|
190
|
-
result = api_instance.
|
|
245
|
+
result = api_instance.tasks_list(opts)
|
|
191
246
|
p result
|
|
192
247
|
rescue PulpcoreClient::ApiError => e
|
|
193
|
-
puts "Exception when calling TasksApi->
|
|
248
|
+
puts "Exception when calling TasksApi->tasks_list: #{e}"
|
|
194
249
|
end
|
|
195
250
|
```
|
|
196
251
|
|
|
@@ -253,9 +308,9 @@ Name | Type | Description | Notes
|
|
|
253
308
|
- **Accept**: application/json
|
|
254
309
|
|
|
255
310
|
|
|
256
|
-
##
|
|
311
|
+
## tasks_list_roles
|
|
257
312
|
|
|
258
|
-
> ObjectRolesResponse
|
|
313
|
+
> ObjectRolesResponse tasks_list_roles(task_href, opts)
|
|
259
314
|
|
|
260
315
|
|
|
261
316
|
|
|
@@ -281,10 +336,10 @@ opts = {
|
|
|
281
336
|
}
|
|
282
337
|
|
|
283
338
|
begin
|
|
284
|
-
result = api_instance.
|
|
339
|
+
result = api_instance.tasks_list_roles(task_href, opts)
|
|
285
340
|
p result
|
|
286
341
|
rescue PulpcoreClient::ApiError => e
|
|
287
|
-
puts "Exception when calling TasksApi->
|
|
342
|
+
puts "Exception when calling TasksApi->tasks_list_roles: #{e}"
|
|
288
343
|
end
|
|
289
344
|
```
|
|
290
345
|
|
|
@@ -311,9 +366,9 @@ Name | Type | Description | Notes
|
|
|
311
366
|
- **Accept**: application/json
|
|
312
367
|
|
|
313
368
|
|
|
314
|
-
##
|
|
369
|
+
## tasks_my_permissions
|
|
315
370
|
|
|
316
|
-
> MyPermissionsResponse
|
|
371
|
+
> MyPermissionsResponse tasks_my_permissions(task_href, opts)
|
|
317
372
|
|
|
318
373
|
|
|
319
374
|
|
|
@@ -339,10 +394,10 @@ opts = {
|
|
|
339
394
|
}
|
|
340
395
|
|
|
341
396
|
begin
|
|
342
|
-
result = api_instance.
|
|
397
|
+
result = api_instance.tasks_my_permissions(task_href, opts)
|
|
343
398
|
p result
|
|
344
399
|
rescue PulpcoreClient::ApiError => e
|
|
345
|
-
puts "Exception when calling TasksApi->
|
|
400
|
+
puts "Exception when calling TasksApi->tasks_my_permissions: #{e}"
|
|
346
401
|
end
|
|
347
402
|
```
|
|
348
403
|
|
|
@@ -369,9 +424,9 @@ Name | Type | Description | Notes
|
|
|
369
424
|
- **Accept**: application/json
|
|
370
425
|
|
|
371
426
|
|
|
372
|
-
##
|
|
427
|
+
## tasks_purge
|
|
373
428
|
|
|
374
|
-
> AsyncOperationResponse
|
|
429
|
+
> AsyncOperationResponse tasks_purge(purge)
|
|
375
430
|
|
|
376
431
|
Purge Completed Tasks
|
|
377
432
|
|
|
@@ -394,10 +449,10 @@ purge = PulpcoreClient::Purge.new # Purge |
|
|
|
394
449
|
|
|
395
450
|
begin
|
|
396
451
|
#Purge Completed Tasks
|
|
397
|
-
result = api_instance.
|
|
452
|
+
result = api_instance.tasks_purge(purge)
|
|
398
453
|
p result
|
|
399
454
|
rescue PulpcoreClient::ApiError => e
|
|
400
|
-
puts "Exception when calling TasksApi->
|
|
455
|
+
puts "Exception when calling TasksApi->tasks_purge: #{e}"
|
|
401
456
|
end
|
|
402
457
|
```
|
|
403
458
|
|
|
@@ -422,9 +477,9 @@ Name | Type | Description | Notes
|
|
|
422
477
|
- **Accept**: application/json
|
|
423
478
|
|
|
424
479
|
|
|
425
|
-
##
|
|
480
|
+
## tasks_read
|
|
426
481
|
|
|
427
|
-
> TaskResponse
|
|
482
|
+
> TaskResponse tasks_read(task_href, opts)
|
|
428
483
|
|
|
429
484
|
Inspect a task
|
|
430
485
|
|
|
@@ -451,10 +506,10 @@ opts = {
|
|
|
451
506
|
|
|
452
507
|
begin
|
|
453
508
|
#Inspect a task
|
|
454
|
-
result = api_instance.
|
|
509
|
+
result = api_instance.tasks_read(task_href, opts)
|
|
455
510
|
p result
|
|
456
511
|
rescue PulpcoreClient::ApiError => e
|
|
457
|
-
puts "Exception when calling TasksApi->
|
|
512
|
+
puts "Exception when calling TasksApi->tasks_read: #{e}"
|
|
458
513
|
end
|
|
459
514
|
```
|
|
460
515
|
|
|
@@ -481,9 +536,9 @@ Name | Type | Description | Notes
|
|
|
481
536
|
- **Accept**: application/json
|
|
482
537
|
|
|
483
538
|
|
|
484
|
-
##
|
|
539
|
+
## tasks_remove_role
|
|
485
540
|
|
|
486
|
-
> NestedRoleResponse
|
|
541
|
+
> NestedRoleResponse tasks_remove_role(task_href, nested_role)
|
|
487
542
|
|
|
488
543
|
|
|
489
544
|
|
|
@@ -506,10 +561,10 @@ task_href = 'task_href_example' # String |
|
|
|
506
561
|
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
|
507
562
|
|
|
508
563
|
begin
|
|
509
|
-
result = api_instance.
|
|
564
|
+
result = api_instance.tasks_remove_role(task_href, nested_role)
|
|
510
565
|
p result
|
|
511
566
|
rescue PulpcoreClient::ApiError => e
|
|
512
|
-
puts "Exception when calling TasksApi->
|
|
567
|
+
puts "Exception when calling TasksApi->tasks_remove_role: #{e}"
|
|
513
568
|
end
|
|
514
569
|
```
|
|
515
570
|
|
|
@@ -534,58 +589,3 @@ Name | Type | Description | Notes
|
|
|
534
589
|
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
535
590
|
- **Accept**: application/json
|
|
536
591
|
|
|
537
|
-
|
|
538
|
-
## tasks_cancel
|
|
539
|
-
|
|
540
|
-
> TaskResponse tasks_cancel(task_href, patched_task_cancel)
|
|
541
|
-
|
|
542
|
-
Cancel a task
|
|
543
|
-
|
|
544
|
-
This operation cancels a task.
|
|
545
|
-
|
|
546
|
-
### Example
|
|
547
|
-
|
|
548
|
-
```ruby
|
|
549
|
-
# load the gem
|
|
550
|
-
require 'pulpcore_client'
|
|
551
|
-
# setup authorization
|
|
552
|
-
PulpcoreClient.configure do |config|
|
|
553
|
-
# Configure HTTP basic authorization: basicAuth
|
|
554
|
-
config.username = 'YOUR USERNAME'
|
|
555
|
-
config.password = 'YOUR PASSWORD'
|
|
556
|
-
end
|
|
557
|
-
|
|
558
|
-
api_instance = PulpcoreClient::TasksApi.new
|
|
559
|
-
task_href = 'task_href_example' # String |
|
|
560
|
-
patched_task_cancel = PulpcoreClient::PatchedTaskCancel.new # PatchedTaskCancel |
|
|
561
|
-
|
|
562
|
-
begin
|
|
563
|
-
#Cancel a task
|
|
564
|
-
result = api_instance.tasks_cancel(task_href, patched_task_cancel)
|
|
565
|
-
p result
|
|
566
|
-
rescue PulpcoreClient::ApiError => e
|
|
567
|
-
puts "Exception when calling TasksApi->tasks_cancel: #{e}"
|
|
568
|
-
end
|
|
569
|
-
```
|
|
570
|
-
|
|
571
|
-
### Parameters
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
Name | Type | Description | Notes
|
|
575
|
-
------------- | ------------- | ------------- | -------------
|
|
576
|
-
**task_href** | **String**| |
|
|
577
|
-
**patched_task_cancel** | [**PatchedTaskCancel**](PatchedTaskCancel.md)| |
|
|
578
|
-
|
|
579
|
-
### Return type
|
|
580
|
-
|
|
581
|
-
[**TaskResponse**](TaskResponse.md)
|
|
582
|
-
|
|
583
|
-
### Authorization
|
|
584
|
-
|
|
585
|
-
[basicAuth](../README.md#basicAuth)
|
|
586
|
-
|
|
587
|
-
### HTTP request headers
|
|
588
|
-
|
|
589
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
590
|
-
- **Accept**: application/json
|
|
591
|
-
|