pulp_container_client 2.14.14 → 2.14.16
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +222 -246
- data/docs/AccessPoliciesApi.md +28 -32
- data/docs/ArtifactDistributionResponse.md +7 -7
- data/docs/ArtifactsApi.md +23 -27
- data/docs/ContainerContainerDistribution.md +5 -5
- data/docs/ContainerContainerDistributionResponse.md +8 -8
- data/docs/ContainerContainerPushRepository.md +5 -5
- data/docs/ContainerContainerPushRepositoryResponse.md +8 -8
- data/docs/ContainerContainerRemote.md +1 -1
- data/docs/ContainerContainerRemoteResponse.md +1 -1
- data/docs/ContainerContainerRepository.md +1 -1
- data/docs/ContainerContainerRepositoryResponse.md +1 -1
- data/docs/ContentApi.md +8 -14
- data/docs/ContentBlobsApi.md +13 -17
- data/docs/ContentManifestsApi.md +15 -19
- data/docs/ContentSignaturesApi.md +13 -17
- data/docs/ContentTagsApi.md +15 -19
- data/docs/ContentguardsApi.md +8 -14
- data/docs/ContentguardsContentRedirectApi.md +53 -57
- data/docs/ContentguardsRbacApi.md +53 -57
- data/docs/DistributionsApi.md +8 -18
- data/docs/DistributionsArtifactsApi.md +13 -21
- data/docs/DistributionsContainerApi.md +53 -61
- data/docs/DocsApiJsonApi.md +6 -6
- data/docs/DocsApiYamlApi.md +6 -6
- data/docs/ExportersFilesystemApi.md +36 -40
- data/docs/ExportersFilesystemExportsApi.md +24 -24
- data/docs/ExportersPulpApi.md +33 -37
- data/docs/ExportersPulpExportsApi.md +21 -21
- data/docs/FilesystemExporter.md +1 -1
- data/docs/FilesystemExporterResponse.md +1 -1
- data/docs/GroupRole.md +1 -3
- data/docs/GroupRoleResponse.md +1 -3
- data/docs/GroupsApi.md +59 -63
- data/docs/GroupsRolesApi.md +27 -33
- data/docs/GroupsUsersApi.md +16 -16
- data/docs/ImportersPulpApi.md +33 -37
- 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/PatchedFilesystemExporter.md +1 -1
- data/docs/PatchedcontainerContainerDistribution.md +5 -5
- data/docs/PatchedcontainerContainerPushRepository.md +5 -5
- data/docs/PatchedcontainerContainerRemote.md +1 -1
- data/docs/PatchedcontainerContainerRepository.md +1 -1
- data/docs/PublicationsApi.md +9 -15
- data/docs/PulpContainerNamespacesApi.md +43 -47
- data/docs/RemoteResponse.md +1 -1
- data/docs/RemoteResponseHiddenFields.md +2 -2
- data/docs/RemotesApi.md +8 -14
- data/docs/RemotesContainerApi.md +53 -57
- data/docs/RepairApi.md +6 -6
- data/docs/RepositoriesApi.md +8 -30
- data/docs/RepositoriesContainerApi.md +102 -122
- data/docs/RepositoriesContainerPushApi.md +68 -88
- data/docs/RepositoriesContainerPushVersionsApi.md +23 -25
- data/docs/RepositoriesContainerVersionsApi.md +23 -25
- data/docs/RepositoriesReclaimSpaceApi.md +6 -6
- data/docs/RepositoryResponse.md +1 -1
- data/docs/RepositoryVersionsApi.md +8 -12
- data/docs/RolesApi.md +39 -43
- data/docs/SigningServicesApi.md +13 -17
- data/docs/StatusApi.md +1 -1
- data/docs/StatusResponse.md +1 -3
- data/docs/TaskGroupsApi.md +11 -11
- data/docs/TaskSchedulesApi.md +35 -39
- data/docs/TasksApi.md +101 -105
- data/docs/TokenApi.md +6 -6
- data/docs/UploadsApi.md +53 -57
- data/docs/UserRole.md +2 -4
- data/docs/UserRoleResponse.md +2 -4
- data/docs/UsersApi.md +39 -43
- data/docs/UsersRolesApi.md +27 -33
- data/docs/VersionResponse.md +1 -3
- data/docs/WorkersApi.md +13 -17
- data/lib/pulp_container_client/api/access_policies_api.rb +33 -39
- data/lib/pulp_container_client/api/artifacts_api.rb +31 -37
- data/lib/pulp_container_client/api/content_api.rb +7 -20
- data/lib/pulp_container_client/api/content_blobs_api.rb +13 -19
- data/lib/pulp_container_client/api/content_manifests_api.rb +15 -21
- data/lib/pulp_container_client/api/content_signatures_api.rb +13 -19
- data/lib/pulp_container_client/api/content_tags_api.rb +15 -21
- data/lib/pulp_container_client/api/contentguards_api.rb +7 -20
- data/lib/pulp_container_client/api/contentguards_content_redirect_api.rb +65 -71
- data/lib/pulp_container_client/api/contentguards_rbac_api.rb +65 -71
- data/lib/pulp_container_client/api/distributions_api.rb +7 -26
- data/lib/pulp_container_client/api/distributions_artifacts_api.rb +13 -25
- data/lib/pulp_container_client/api/distributions_container_api.rb +65 -77
- data/lib/pulp_container_client/api/docs_api_json_api.rb +5 -5
- data/lib/pulp_container_client/api/docs_api_yaml_api.rb +5 -5
- data/lib/pulp_container_client/api/exporters_filesystem_api.rb +45 -51
- data/lib/pulp_container_client/api/exporters_filesystem_exports_api.rb +31 -31
- data/lib/pulp_container_client/api/exporters_pulp_api.rb +39 -45
- data/lib/pulp_container_client/api/exporters_pulp_exports_api.rb +25 -25
- data/lib/pulp_container_client/api/groups_api.rb +77 -83
- data/lib/pulp_container_client/api/groups_roles_api.rb +35 -44
- data/lib/pulp_container_client/api/groups_users_api.rb +19 -19
- data/lib/pulp_container_client/api/importers_pulp_api.rb +39 -45
- data/lib/pulp_container_client/api/importers_pulp_imports_api.rb +25 -25
- data/lib/pulp_container_client/api/orphans_api.rb +5 -5
- data/lib/pulp_container_client/api/orphans_cleanup_api.rb +6 -6
- data/lib/pulp_container_client/api/publications_api.rb +9 -18
- data/lib/pulp_container_client/api/pulp_container_namespaces_api.rb +51 -57
- data/lib/pulp_container_client/api/remotes_api.rb +7 -20
- data/lib/pulp_container_client/api/remotes_container_api.rb +65 -71
- data/lib/pulp_container_client/api/repair_api.rb +6 -6
- data/lib/pulp_container_client/api/repositories_api.rb +7 -44
- data/lib/pulp_container_client/api/repositories_container_api.rb +128 -158
- data/lib/pulp_container_client/api/repositories_container_push_api.rb +88 -118
- data/lib/pulp_container_client/api/repositories_container_push_versions_api.rb +27 -30
- data/lib/pulp_container_client/api/repositories_container_versions_api.rb +27 -30
- data/lib/pulp_container_client/api/repositories_reclaim_space_api.rb +6 -6
- data/lib/pulp_container_client/api/repository_versions_api.rb +7 -12
- data/lib/pulp_container_client/api/roles_api.rb +51 -57
- data/lib/pulp_container_client/api/signing_services_api.rb +13 -19
- data/lib/pulp_container_client/api/task_groups_api.rb +11 -11
- data/lib/pulp_container_client/api/task_schedules_api.rb +43 -49
- data/lib/pulp_container_client/api/tasks_api.rb +125 -131
- data/lib/pulp_container_client/api/token_api.rb +5 -5
- data/lib/pulp_container_client/api/uploads_api.rb +67 -73
- data/lib/pulp_container_client/api/users_api.rb +51 -57
- data/lib/pulp_container_client/api/users_roles_api.rb +35 -44
- data/lib/pulp_container_client/api/workers_api.rb +14 -20
- data/lib/pulp_container_client/configuration.rb +3 -3
- data/lib/pulp_container_client/models/artifact_distribution_response.rb +35 -35
- data/lib/pulp_container_client/models/container_container_distribution.rb +45 -45
- data/lib/pulp_container_client/models/container_container_distribution_response.rb +39 -39
- data/lib/pulp_container_client/models/container_container_push_repository.rb +37 -37
- data/lib/pulp_container_client/models/container_container_push_repository_response.rb +33 -33
- data/lib/pulp_container_client/models/container_container_remote.rb +21 -21
- data/lib/pulp_container_client/models/container_container_remote_response.rb +21 -21
- data/lib/pulp_container_client/models/container_container_repository.rb +1 -1
- data/lib/pulp_container_client/models/container_container_repository_response.rb +1 -1
- data/lib/pulp_container_client/models/filesystem_exporter.rb +1 -1
- data/lib/pulp_container_client/models/filesystem_exporter_response.rb +1 -1
- data/lib/pulp_container_client/models/group_role.rb +5 -16
- data/lib/pulp_container_client/models/group_role_response.rb +4 -15
- data/lib/pulp_container_client/models/nested_role.rb +0 -19
- data/lib/pulp_container_client/models/patched_filesystem_exporter.rb +1 -1
- data/lib/pulp_container_client/models/patchedcontainer_container_distribution.rb +36 -36
- data/lib/pulp_container_client/models/patchedcontainer_container_push_repository.rb +37 -37
- data/lib/pulp_container_client/models/patchedcontainer_container_remote.rb +21 -21
- data/lib/pulp_container_client/models/patchedcontainer_container_repository.rb +1 -1
- data/lib/pulp_container_client/models/remote_response.rb +21 -21
- data/lib/pulp_container_client/models/remote_response_hidden_fields.rb +10 -0
- data/lib/pulp_container_client/models/repository_response.rb +1 -1
- data/lib/pulp_container_client/models/status_response.rb +4 -19
- data/lib/pulp_container_client/models/user_role.rb +6 -17
- data/lib/pulp_container_client/models/user_role_response.rb +5 -16
- data/lib/pulp_container_client/models/version_response.rb +4 -19
- data/lib/pulp_container_client/version.rb +1 -1
- data/lib/pulp_container_client.rb +0 -11
- data/spec/api/access_policies_api_spec.rb +11 -13
- data/spec/api/artifacts_api_spec.rb +9 -11
- data/spec/api/content_api_spec.rb +3 -6
- data/spec/api/content_blobs_api_spec.rb +5 -7
- data/spec/api/content_manifests_api_spec.rb +6 -8
- data/spec/api/content_signatures_api_spec.rb +5 -7
- data/spec/api/content_tags_api_spec.rb +6 -8
- data/spec/api/contentguards_api_spec.rb +3 -6
- data/spec/api/contentguards_content_redirect_api_spec.rb +21 -23
- data/spec/api/contentguards_rbac_api_spec.rb +21 -23
- data/spec/api/distributions_api_spec.rb +3 -8
- data/spec/api/distributions_artifacts_api_spec.rb +5 -9
- data/spec/api/distributions_container_api_spec.rb +21 -25
- data/spec/api/docs_api_json_api_spec.rb +2 -2
- data/spec/api/docs_api_yaml_api_spec.rb +2 -2
- data/spec/api/exporters_filesystem_api_spec.rb +16 -18
- data/spec/api/exporters_filesystem_exports_api_spec.rb +11 -11
- data/spec/api/exporters_pulp_api_spec.rb +13 -15
- data/spec/api/exporters_pulp_exports_api_spec.rb +8 -8
- data/spec/api/groups_api_spec.rb +27 -29
- data/spec/api/groups_roles_api_spec.rb +13 -16
- data/spec/api/groups_users_api_spec.rb +6 -6
- data/spec/api/importers_pulp_api_spec.rb +13 -15
- 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 +4 -7
- data/spec/api/pulp_container_namespaces_api_spec.rb +17 -19
- data/spec/api/remotes_api_spec.rb +3 -6
- data/spec/api/remotes_container_api_spec.rb +21 -23
- data/spec/api/repair_api_spec.rb +2 -2
- data/spec/api/repositories_api_spec.rb +3 -14
- data/spec/api/repositories_container_api_spec.rb +39 -49
- data/spec/api/repositories_container_push_api_spec.rb +27 -37
- data/spec/api/repositories_container_push_versions_api_spec.rb +9 -10
- data/spec/api/repositories_container_versions_api_spec.rb +9 -10
- data/spec/api/repositories_reclaim_space_api_spec.rb +2 -2
- data/spec/api/repository_versions_api_spec.rb +3 -5
- data/spec/api/roles_api_spec.rb +19 -21
- data/spec/api/signing_services_api_spec.rb +5 -7
- data/spec/api/task_groups_api_spec.rb +4 -4
- data/spec/api/task_schedules_api_spec.rb +15 -17
- data/spec/api/tasks_api_spec.rb +32 -34
- data/spec/api/token_api_spec.rb +2 -2
- data/spec/api/uploads_api_spec.rb +21 -23
- data/spec/api/users_api_spec.rb +19 -21
- data/spec/api/users_roles_api_spec.rb +13 -16
- data/spec/api/workers_api_spec.rb +5 -7
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/artifact_distribution_response_spec.rb +7 -7
- data/spec/models/container_container_distribution_response_spec.rb +6 -6
- data/spec/models/container_container_distribution_spec.rb +4 -4
- data/spec/models/container_container_push_repository_response_spec.rb +6 -6
- data/spec/models/container_container_push_repository_spec.rb +4 -4
- data/spec/models/group_role_response_spec.rb +0 -6
- data/spec/models/group_role_spec.rb +0 -6
- data/spec/models/patchedcontainer_container_distribution_spec.rb +4 -4
- data/spec/models/patchedcontainer_container_push_repository_spec.rb +4 -4
- data/spec/models/status_response_spec.rb +0 -6
- data/spec/models/user_role_response_spec.rb +0 -6
- data/spec/models/user_role_spec.rb +0 -6
- data/spec/models/version_response_spec.rb +0 -6
- metadata +196 -240
- data/docs/Domain.md +0 -27
- data/docs/DomainResponse.md +0 -31
- data/docs/DomainsApi.md +0 -366
- data/docs/PaginatedDomainResponseList.md +0 -23
- data/docs/PaginatedUpstreamPulpResponseList.md +0 -23
- data/docs/PatchedDomain.md +0 -27
- data/docs/PatchedUpstreamPulp.md +0 -37
- data/docs/StorageClassEnum.md +0 -16
- data/docs/UpstreamPulp.md +0 -37
- data/docs/UpstreamPulpResponse.md +0 -39
- data/docs/UpstreamPulpsApi.md +0 -405
- data/lib/pulp_container_client/api/domains_api.rb +0 -452
- data/lib/pulp_container_client/api/upstream_pulps_api.rb +0 -492
- data/lib/pulp_container_client/models/domain.rb +0 -323
- data/lib/pulp_container_client/models/domain_response.rb +0 -318
- data/lib/pulp_container_client/models/paginated_domain_response_list.rb +0 -237
- data/lib/pulp_container_client/models/paginated_upstream_pulp_response_list.rb +0 -237
- data/lib/pulp_container_client/models/patched_domain.rb +0 -304
- data/lib/pulp_container_client/models/patched_upstream_pulp.rb +0 -450
- data/lib/pulp_container_client/models/storage_class_enum.rb +0 -37
- data/lib/pulp_container_client/models/upstream_pulp.rb +0 -477
- data/lib/pulp_container_client/models/upstream_pulp_response.rb +0 -338
- data/spec/api/domains_api_spec.rb +0 -122
- data/spec/api/upstream_pulps_api_spec.rb +0 -127
- data/spec/models/domain_response_spec.rb +0 -83
- data/spec/models/domain_spec.rb +0 -71
- data/spec/models/paginated_domain_response_list_spec.rb +0 -59
- data/spec/models/paginated_upstream_pulp_response_list_spec.rb +0 -59
- data/spec/models/patched_domain_spec.rb +0 -71
- data/spec/models/patched_upstream_pulp_spec.rb +0 -101
- data/spec/models/storage_class_enum_spec.rb +0 -35
- data/spec/models/upstream_pulp_response_spec.rb +0 -107
- data/spec/models/upstream_pulp_spec.rb +0 -101
data/docs/TaskSchedulesApi.md
CHANGED
@@ -1,21 +1,21 @@
|
|
1
1
|
# PulpContainerClient::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 = PulpContainerClient::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 PulpContainerClient::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,13 +67,13 @@ 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
|
|
76
|
-
ViewSet to monitor task schedules.
|
76
|
+
ViewSet to monitor task schedules. NOTE: This feature is in tech-preview and may change in backwards incompatible ways.
|
77
77
|
|
78
78
|
### Example
|
79
79
|
|
@@ -93,9 +93,7 @@ opts = {
|
|
93
93
|
name: 'name_example', # String | Filter results where name matches value
|
94
94
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
95
95
|
offset: 56, # Integer | The initial index from which to return the results.
|
96
|
-
ordering: ['ordering_example'], # Array<String> | Ordering
|
97
|
-
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
98
|
-
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
96
|
+
ordering: ['ordering_example'], # Array<String> | Ordering
|
99
97
|
task_name: 'task_name_example', # String | Filter results where task_name matches value
|
100
98
|
task_name__contains: 'task_name__contains_example', # String | Filter results where task_name contains value
|
101
99
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
@@ -104,10 +102,10 @@ opts = {
|
|
104
102
|
|
105
103
|
begin
|
106
104
|
#List task schedules
|
107
|
-
result = api_instance.
|
105
|
+
result = api_instance.task_schedules_list(opts)
|
108
106
|
p result
|
109
107
|
rescue PulpContainerClient::ApiError => e
|
110
|
-
puts "Exception when calling TaskSchedulesApi->
|
108
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_list: #{e}"
|
111
109
|
end
|
112
110
|
```
|
113
111
|
|
@@ -120,9 +118,7 @@ Name | Type | Description | Notes
|
|
120
118
|
**name** | **String**| Filter results where name matches value | [optional]
|
121
119
|
**name__contains** | **String**| Filter results where name contains value | [optional]
|
122
120
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
123
|
-
**ordering** | [**Array<String>**](String.md)| Ordering
|
124
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
125
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
121
|
+
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
126
122
|
**task_name** | **String**| Filter results where task_name matches value | [optional]
|
127
123
|
**task_name__contains** | **String**| Filter results where task_name contains value | [optional]
|
128
124
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
@@ -142,9 +138,9 @@ Name | Type | Description | Notes
|
|
142
138
|
- **Accept**: application/json
|
143
139
|
|
144
140
|
|
145
|
-
##
|
141
|
+
## task_schedules_list_roles
|
146
142
|
|
147
|
-
> ObjectRolesResponse
|
143
|
+
> ObjectRolesResponse task_schedules_list_roles(task_schedule_href, opts)
|
148
144
|
|
149
145
|
|
150
146
|
|
@@ -170,10 +166,10 @@ opts = {
|
|
170
166
|
}
|
171
167
|
|
172
168
|
begin
|
173
|
-
result = api_instance.
|
169
|
+
result = api_instance.task_schedules_list_roles(task_schedule_href, opts)
|
174
170
|
p result
|
175
171
|
rescue PulpContainerClient::ApiError => e
|
176
|
-
puts "Exception when calling TaskSchedulesApi->
|
172
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_list_roles: #{e}"
|
177
173
|
end
|
178
174
|
```
|
179
175
|
|
@@ -200,9 +196,9 @@ Name | Type | Description | Notes
|
|
200
196
|
- **Accept**: application/json
|
201
197
|
|
202
198
|
|
203
|
-
##
|
199
|
+
## task_schedules_my_permissions
|
204
200
|
|
205
|
-
> MyPermissionsResponse
|
201
|
+
> MyPermissionsResponse task_schedules_my_permissions(task_schedule_href, opts)
|
206
202
|
|
207
203
|
|
208
204
|
|
@@ -228,10 +224,10 @@ opts = {
|
|
228
224
|
}
|
229
225
|
|
230
226
|
begin
|
231
|
-
result = api_instance.
|
227
|
+
result = api_instance.task_schedules_my_permissions(task_schedule_href, opts)
|
232
228
|
p result
|
233
229
|
rescue PulpContainerClient::ApiError => e
|
234
|
-
puts "Exception when calling TaskSchedulesApi->
|
230
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_my_permissions: #{e}"
|
235
231
|
end
|
236
232
|
```
|
237
233
|
|
@@ -258,13 +254,13 @@ Name | Type | Description | Notes
|
|
258
254
|
- **Accept**: application/json
|
259
255
|
|
260
256
|
|
261
|
-
##
|
257
|
+
## task_schedules_read
|
262
258
|
|
263
|
-
> TaskScheduleResponse
|
259
|
+
> TaskScheduleResponse task_schedules_read(task_schedule_href, opts)
|
264
260
|
|
265
261
|
Inspect a task schedule
|
266
262
|
|
267
|
-
ViewSet to monitor task schedules.
|
263
|
+
ViewSet to monitor task schedules. NOTE: This feature is in tech-preview and may change in backwards incompatible ways.
|
268
264
|
|
269
265
|
### Example
|
270
266
|
|
@@ -287,10 +283,10 @@ opts = {
|
|
287
283
|
|
288
284
|
begin
|
289
285
|
#Inspect a task schedule
|
290
|
-
result = api_instance.
|
286
|
+
result = api_instance.task_schedules_read(task_schedule_href, opts)
|
291
287
|
p result
|
292
288
|
rescue PulpContainerClient::ApiError => e
|
293
|
-
puts "Exception when calling TaskSchedulesApi->
|
289
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_read: #{e}"
|
294
290
|
end
|
295
291
|
```
|
296
292
|
|
@@ -317,9 +313,9 @@ Name | Type | Description | Notes
|
|
317
313
|
- **Accept**: application/json
|
318
314
|
|
319
315
|
|
320
|
-
##
|
316
|
+
## task_schedules_remove_role
|
321
317
|
|
322
|
-
> NestedRoleResponse
|
318
|
+
> NestedRoleResponse task_schedules_remove_role(task_schedule_href, nested_role)
|
323
319
|
|
324
320
|
|
325
321
|
|
@@ -342,10 +338,10 @@ task_schedule_href = 'task_schedule_href_example' # String |
|
|
342
338
|
nested_role = PulpContainerClient::NestedRole.new # NestedRole |
|
343
339
|
|
344
340
|
begin
|
345
|
-
result = api_instance.
|
341
|
+
result = api_instance.task_schedules_remove_role(task_schedule_href, nested_role)
|
346
342
|
p result
|
347
343
|
rescue PulpContainerClient::ApiError => e
|
348
|
-
puts "Exception when calling TaskSchedulesApi->
|
344
|
+
puts "Exception when calling TaskSchedulesApi->task_schedules_remove_role: #{e}"
|
349
345
|
end
|
350
346
|
```
|
351
347
|
|
data/docs/TasksApi.md
CHANGED
@@ -1,24 +1,24 @@
|
|
1
1
|
# PulpContainerClient::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 = PulpContainerClient::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 PulpContainerClient::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 'pulp_container_client'
|
86
|
+
# setup authorization
|
87
|
+
PulpContainerClient.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 = PulpContainerClient::TasksApi.new
|
94
|
+
task_href = 'task_href_example' # String |
|
95
|
+
patched_task_cancel = PulpContainerClient::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 PulpContainerClient::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 PulpContainerClient::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
|
|
@@ -161,10 +216,8 @@ opts = {
|
|
161
216
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
162
217
|
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
163
218
|
offset: 56, # Integer | The initial index from which to return the results.
|
164
|
-
ordering: ['ordering_example'], # Array<String> | Ordering
|
219
|
+
ordering: ['ordering_example'], # Array<String> | Ordering
|
165
220
|
parent_task: 'parent_task_example', # String | Filter results where parent_task matches value
|
166
|
-
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
167
|
-
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
168
221
|
reserved_resources: 'reserved_resources_example', # String |
|
169
222
|
reserved_resources__in: ['reserved_resources__in_example'], # Array<String> | Multiple values may be separated by commas.
|
170
223
|
reserved_resources_record: ['reserved_resources_record_example'], # Array<String> |
|
@@ -176,7 +229,7 @@ opts = {
|
|
176
229
|
started_at__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where started_at is less than value
|
177
230
|
started_at__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where started_at is less than or equal to value
|
178
231
|
started_at__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where started_at is between two comma separated values
|
179
|
-
state: 'state_example', # String | Filter results where state matches value
|
232
|
+
state: 'state_example', # String | Filter results where state matches value
|
180
233
|
state__in: ['state__in_example'], # Array<String> | Filter results where state is in a comma-separated list of values
|
181
234
|
task_group: 'task_group_example', # String | Filter results where task_group matches value
|
182
235
|
worker: 'worker_example', # String | Filter results where worker matches value
|
@@ -187,10 +240,10 @@ opts = {
|
|
187
240
|
|
188
241
|
begin
|
189
242
|
#List tasks
|
190
|
-
result = api_instance.
|
243
|
+
result = api_instance.tasks_list(opts)
|
191
244
|
p result
|
192
245
|
rescue PulpContainerClient::ApiError => e
|
193
|
-
puts "Exception when calling TasksApi->
|
246
|
+
puts "Exception when calling TasksApi->tasks_list: #{e}"
|
194
247
|
end
|
195
248
|
```
|
196
249
|
|
@@ -216,10 +269,8 @@ Name | Type | Description | Notes
|
|
216
269
|
**name__contains** | **String**| Filter results where name contains value | [optional]
|
217
270
|
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
218
271
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
219
|
-
**ordering** | [**Array<String>**](String.md)| Ordering
|
272
|
+
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
220
273
|
**parent_task** | **String**| Filter results where parent_task matches value | [optional]
|
221
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
222
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
223
274
|
**reserved_resources** | **String**| | [optional]
|
224
275
|
**reserved_resources__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
225
276
|
**reserved_resources_record** | [**Array<String>**](String.md)| | [optional]
|
@@ -231,7 +282,7 @@ Name | Type | Description | Notes
|
|
231
282
|
**started_at__lt** | **DateTime**| Filter results where started_at is less than value | [optional]
|
232
283
|
**started_at__lte** | **DateTime**| Filter results where started_at is less than or equal to value | [optional]
|
233
284
|
**started_at__range** | [**Array<DateTime>**](DateTime.md)| Filter results where started_at is between two comma separated values | [optional]
|
234
|
-
**state** | **String**| Filter results where state matches value
|
285
|
+
**state** | **String**| Filter results where state matches value | [optional]
|
235
286
|
**state__in** | [**Array<String>**](String.md)| Filter results where state is in a comma-separated list of values | [optional]
|
236
287
|
**task_group** | **String**| Filter results where task_group matches value | [optional]
|
237
288
|
**worker** | **String**| Filter results where worker matches value | [optional]
|
@@ -253,9 +304,9 @@ Name | Type | Description | Notes
|
|
253
304
|
- **Accept**: application/json
|
254
305
|
|
255
306
|
|
256
|
-
##
|
307
|
+
## tasks_list_roles
|
257
308
|
|
258
|
-
> ObjectRolesResponse
|
309
|
+
> ObjectRolesResponse tasks_list_roles(task_href, opts)
|
259
310
|
|
260
311
|
|
261
312
|
|
@@ -281,10 +332,10 @@ opts = {
|
|
281
332
|
}
|
282
333
|
|
283
334
|
begin
|
284
|
-
result = api_instance.
|
335
|
+
result = api_instance.tasks_list_roles(task_href, opts)
|
285
336
|
p result
|
286
337
|
rescue PulpContainerClient::ApiError => e
|
287
|
-
puts "Exception when calling TasksApi->
|
338
|
+
puts "Exception when calling TasksApi->tasks_list_roles: #{e}"
|
288
339
|
end
|
289
340
|
```
|
290
341
|
|
@@ -311,9 +362,9 @@ Name | Type | Description | Notes
|
|
311
362
|
- **Accept**: application/json
|
312
363
|
|
313
364
|
|
314
|
-
##
|
365
|
+
## tasks_my_permissions
|
315
366
|
|
316
|
-
> MyPermissionsResponse
|
367
|
+
> MyPermissionsResponse tasks_my_permissions(task_href, opts)
|
317
368
|
|
318
369
|
|
319
370
|
|
@@ -339,10 +390,10 @@ opts = {
|
|
339
390
|
}
|
340
391
|
|
341
392
|
begin
|
342
|
-
result = api_instance.
|
393
|
+
result = api_instance.tasks_my_permissions(task_href, opts)
|
343
394
|
p result
|
344
395
|
rescue PulpContainerClient::ApiError => e
|
345
|
-
puts "Exception when calling TasksApi->
|
396
|
+
puts "Exception when calling TasksApi->tasks_my_permissions: #{e}"
|
346
397
|
end
|
347
398
|
```
|
348
399
|
|
@@ -369,13 +420,13 @@ Name | Type | Description | Notes
|
|
369
420
|
- **Accept**: application/json
|
370
421
|
|
371
422
|
|
372
|
-
##
|
423
|
+
## tasks_purge
|
373
424
|
|
374
|
-
> AsyncOperationResponse
|
425
|
+
> AsyncOperationResponse tasks_purge(purge)
|
375
426
|
|
376
427
|
Purge Completed Tasks
|
377
428
|
|
378
|
-
Trigger an asynchronous task that deletes completed tasks that finished prior to a specified timestamp.
|
429
|
+
Trigger an asynchronous task that deletes completed tasks that finished prior to a specified timestamp (tech-preview, may change in the future).
|
379
430
|
|
380
431
|
### Example
|
381
432
|
|
@@ -394,10 +445,10 @@ purge = PulpContainerClient::Purge.new # Purge |
|
|
394
445
|
|
395
446
|
begin
|
396
447
|
#Purge Completed Tasks
|
397
|
-
result = api_instance.
|
448
|
+
result = api_instance.tasks_purge(purge)
|
398
449
|
p result
|
399
450
|
rescue PulpContainerClient::ApiError => e
|
400
|
-
puts "Exception when calling TasksApi->
|
451
|
+
puts "Exception when calling TasksApi->tasks_purge: #{e}"
|
401
452
|
end
|
402
453
|
```
|
403
454
|
|
@@ -422,9 +473,9 @@ Name | Type | Description | Notes
|
|
422
473
|
- **Accept**: application/json
|
423
474
|
|
424
475
|
|
425
|
-
##
|
476
|
+
## tasks_read
|
426
477
|
|
427
|
-
> TaskResponse
|
478
|
+
> TaskResponse tasks_read(task_href, opts)
|
428
479
|
|
429
480
|
Inspect a task
|
430
481
|
|
@@ -451,10 +502,10 @@ opts = {
|
|
451
502
|
|
452
503
|
begin
|
453
504
|
#Inspect a task
|
454
|
-
result = api_instance.
|
505
|
+
result = api_instance.tasks_read(task_href, opts)
|
455
506
|
p result
|
456
507
|
rescue PulpContainerClient::ApiError => e
|
457
|
-
puts "Exception when calling TasksApi->
|
508
|
+
puts "Exception when calling TasksApi->tasks_read: #{e}"
|
458
509
|
end
|
459
510
|
```
|
460
511
|
|
@@ -481,9 +532,9 @@ Name | Type | Description | Notes
|
|
481
532
|
- **Accept**: application/json
|
482
533
|
|
483
534
|
|
484
|
-
##
|
535
|
+
## tasks_remove_role
|
485
536
|
|
486
|
-
> NestedRoleResponse
|
537
|
+
> NestedRoleResponse tasks_remove_role(task_href, nested_role)
|
487
538
|
|
488
539
|
|
489
540
|
|
@@ -506,10 +557,10 @@ task_href = 'task_href_example' # String |
|
|
506
557
|
nested_role = PulpContainerClient::NestedRole.new # NestedRole |
|
507
558
|
|
508
559
|
begin
|
509
|
-
result = api_instance.
|
560
|
+
result = api_instance.tasks_remove_role(task_href, nested_role)
|
510
561
|
p result
|
511
562
|
rescue PulpContainerClient::ApiError => e
|
512
|
-
puts "Exception when calling TasksApi->
|
563
|
+
puts "Exception when calling TasksApi->tasks_remove_role: #{e}"
|
513
564
|
end
|
514
565
|
```
|
515
566
|
|
@@ -534,58 +585,3 @@ Name | Type | Description | Notes
|
|
534
585
|
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
535
586
|
- **Accept**: application/json
|
536
587
|
|
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 'pulp_container_client'
|
551
|
-
# setup authorization
|
552
|
-
PulpContainerClient.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 = PulpContainerClient::TasksApi.new
|
559
|
-
task_href = 'task_href_example' # String |
|
560
|
-
patched_task_cancel = PulpContainerClient::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 PulpContainerClient::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
|
-
|
data/docs/TokenApi.md
CHANGED
@@ -1,16 +1,16 @@
|
|
1
1
|
# PulpContainerClient::TokenApi
|
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
|
-
[**
|
7
|
+
[**token_get**](TokenApi.md#token_get) | **GET** /token/ |
|
8
8
|
|
9
9
|
|
10
10
|
|
11
|
-
##
|
11
|
+
## token_get
|
12
12
|
|
13
|
-
>
|
13
|
+
> token_get
|
14
14
|
|
15
15
|
|
16
16
|
|
@@ -31,9 +31,9 @@ end
|
|
31
31
|
api_instance = PulpContainerClient::TokenApi.new
|
32
32
|
|
33
33
|
begin
|
34
|
-
api_instance.
|
34
|
+
api_instance.token_get
|
35
35
|
rescue PulpContainerClient::ApiError => e
|
36
|
-
puts "Exception when calling TokenApi->
|
36
|
+
puts "Exception when calling TokenApi->token_get: #{e}"
|
37
37
|
end
|
38
38
|
```
|
39
39
|
|