pulpcore_client 3.5.0 → 3.6.0
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 +88 -44
- data/docs/AccessPoliciesApi.md +244 -0
- data/docs/AccessPolicy.md +21 -0
- data/docs/AccessPolicyResponse.md +25 -0
- data/docs/Artifact.md +2 -6
- data/docs/ArtifactResponse.md +35 -0
- data/docs/ArtifactsApi.md +40 -34
- data/docs/{ContentAppStatus.md → ContentAppStatusResponse.md} +2 -2
- data/docs/{DatabaseConnection.md → DatabaseConnectionResponse.md} +2 -2
- data/docs/ExportersCoreExportsApi.md +33 -33
- data/docs/ExportersPulpApi.md +51 -51
- data/docs/Group.md +17 -0
- data/docs/{GroupProgressReport.md → GroupProgressReportResponse.md} +2 -2
- data/docs/GroupResponse.md +21 -0
- data/docs/GroupUser.md +17 -0
- data/docs/GroupUserResponse.md +19 -0
- data/docs/GroupsApi.md +351 -0
- data/docs/GroupsModelPermissionsApi.md +128 -0
- data/docs/GroupsObjectPermissionsApi.md +247 -0
- data/docs/GroupsUsersApi.md +183 -0
- data/docs/{Import.md → ImportResponse.md} +2 -2
- data/docs/ImportersCoreImportsApi.md +33 -33
- data/docs/ImportersPulpApi.md +51 -51
- data/docs/InlineResponse200.md +3 -3
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse20010.md +23 -0
- data/docs/InlineResponse20011.md +23 -0
- data/docs/InlineResponse20012.md +23 -0
- data/docs/InlineResponse20013.md +23 -0
- data/docs/InlineResponse20014.md +23 -0
- data/docs/InlineResponse2002.md +3 -3
- data/docs/InlineResponse2003.md +3 -3
- data/docs/InlineResponse2004.md +3 -3
- data/docs/InlineResponse2005.md +3 -3
- data/docs/InlineResponse2006.md +3 -3
- data/docs/InlineResponse2007.md +3 -3
- data/docs/InlineResponse2008.md +3 -3
- data/docs/InlineResponse2009.md +3 -3
- data/docs/OrphansApi.md +2 -2
- data/docs/PatchedAccessPolicy.md +21 -0
- data/docs/PatchedGroup.md +17 -0
- data/docs/PatchedPulpExporter.md +23 -0
- data/docs/PatchedPulpImporter.md +19 -0
- data/docs/{TaskCancel.md → PatchedTaskCancel.md} +3 -3
- data/docs/PermissionResponse.md +23 -0
- data/docs/{ProgressReport.md → ProgressReportResponse.md} +2 -2
- data/docs/PulpExport.md +11 -11
- data/docs/PulpExportResponse.md +27 -0
- data/docs/PulpExporter.md +1 -5
- data/docs/PulpExporterResponse.md +27 -0
- data/docs/PulpImport.md +4 -2
- data/docs/PulpImporter.md +2 -6
- data/docs/PulpImporterResponse.md +23 -0
- data/docs/{RedisConnection.md → RedisConnectionResponse.md} +2 -2
- data/docs/{SigningService.md → SigningServiceResponse.md} +2 -2
- data/docs/SigningServicesApi.md +14 -14
- data/docs/StatusApi.md +8 -22
- data/docs/StatusResponse.md +27 -0
- data/docs/{Storage.md → StorageResponse.md} +2 -2
- data/docs/{TaskGroup.md → TaskGroupResponse.md} +3 -3
- data/docs/TaskGroupsApi.md +16 -12
- data/docs/{Task.md → TaskResponse.md} +5 -7
- data/docs/TasksApi.md +144 -88
- data/docs/Upload.md +1 -7
- data/docs/UploadChunk.md +2 -6
- data/docs/UploadChunkResponse.md +19 -0
- data/docs/{UploadDetail.md → UploadDetailResponse.md} +3 -3
- data/docs/UploadResponse.md +23 -0
- data/docs/UploadsApi.md +42 -40
- data/docs/UserGroupResponse.md +19 -0
- data/docs/UserResponse.md +35 -0
- data/docs/UsersApi.md +191 -0
- data/docs/{Version.md → VersionResponse.md} +2 -2
- data/docs/{Worker.md → WorkerResponse.md} +2 -2
- data/docs/WorkersApi.md +36 -32
- data/lib/pulpcore_client/api/access_policies_api.rb +301 -0
- data/lib/pulpcore_client/api/artifacts_api.rb +47 -65
- data/lib/pulpcore_client/api/exporters_core_exports_api.rb +51 -51
- data/lib/pulpcore_client/api/exporters_pulp_api.rb +71 -71
- data/lib/pulpcore_client/api/groups_api.rb +425 -0
- data/lib/pulpcore_client/api/groups_model_permissions_api.rb +161 -0
- data/lib/pulpcore_client/api/groups_object_permissions_api.rb +295 -0
- data/lib/pulpcore_client/api/groups_users_api.rb +229 -0
- data/lib/pulpcore_client/api/importers_core_imports_api.rb +51 -51
- data/lib/pulpcore_client/api/importers_pulp_api.rb +71 -71
- data/lib/pulpcore_client/api/orphans_api.rb +3 -3
- data/lib/pulpcore_client/api/signing_services_api.rb +18 -18
- data/lib/pulpcore_client/api/status_api.rb +11 -17
- data/lib/pulpcore_client/api/task_groups_api.rb +19 -15
- data/lib/pulpcore_client/api/tasks_api.rb +203 -125
- data/lib/pulpcore_client/api/uploads_api.rb +60 -66
- data/lib/pulpcore_client/api/users_api.rb +227 -0
- data/lib/pulpcore_client/api/workers_api.rb +46 -42
- data/lib/pulpcore_client/api_client.rb +2 -2
- data/lib/pulpcore_client/api_error.rb +2 -2
- data/lib/pulpcore_client/configuration.rb +3 -3
- data/lib/pulpcore_client/models/access_policy.rb +247 -0
- data/lib/pulpcore_client/models/access_policy_response.rb +266 -0
- data/lib/pulpcore_client/models/artifact.rb +8 -111
- data/lib/pulpcore_client/models/artifact_response.rb +308 -0
- data/lib/pulpcore_client/models/async_operation_response.rb +3 -2
- data/lib/pulpcore_client/models/{content_app_status.rb → content_app_status_response.rb} +6 -21
- data/lib/pulpcore_client/models/{database_connection.rb → database_connection_response.rb} +6 -6
- data/lib/pulpcore_client/models/group.rb +232 -0
- data/lib/pulpcore_client/models/{group_progress_report.rb → group_progress_report_response.rb} +6 -50
- data/lib/pulpcore_client/models/group_response.rb +250 -0
- data/lib/pulpcore_client/models/group_user.rb +232 -0
- data/lib/pulpcore_client/models/group_user_response.rb +241 -0
- data/lib/pulpcore_client/models/{import.rb → import_response.rb} +6 -5
- data/lib/pulpcore_client/models/inline_response200.rb +3 -13
- data/lib/pulpcore_client/models/inline_response2001.rb +3 -13
- data/lib/pulpcore_client/models/inline_response20010.rb +237 -0
- data/lib/pulpcore_client/models/inline_response20011.rb +237 -0
- data/lib/pulpcore_client/models/inline_response20012.rb +237 -0
- data/lib/pulpcore_client/models/inline_response20013.rb +237 -0
- data/lib/pulpcore_client/models/inline_response20014.rb +237 -0
- data/lib/pulpcore_client/models/inline_response2002.rb +3 -13
- data/lib/pulpcore_client/models/inline_response2003.rb +3 -13
- data/lib/pulpcore_client/models/inline_response2004.rb +3 -13
- data/lib/pulpcore_client/models/inline_response2005.rb +3 -13
- data/lib/pulpcore_client/models/inline_response2006.rb +3 -13
- data/lib/pulpcore_client/models/inline_response2007.rb +3 -13
- data/lib/pulpcore_client/models/inline_response2008.rb +3 -13
- data/lib/pulpcore_client/models/inline_response2009.rb +3 -13
- data/lib/pulpcore_client/models/patched_access_policy.rb +232 -0
- data/lib/pulpcore_client/models/patched_group.rb +223 -0
- data/lib/pulpcore_client/models/patched_pulp_exporter.rb +240 -0
- data/lib/pulpcore_client/models/patched_pulp_importer.rb +218 -0
- data/lib/pulpcore_client/models/{task_cancel.rb → patched_task_cancel.rb} +6 -29
- data/lib/pulpcore_client/models/permission_response.rb +235 -0
- data/lib/pulpcore_client/models/{progress_report.rb → progress_report_response.rb} +6 -65
- data/lib/pulpcore_client/models/pulp_export.rb +50 -42
- data/lib/pulpcore_client/models/pulp_export_response.rb +260 -0
- data/lib/pulpcore_client/models/pulp_exporter.rb +4 -60
- data/lib/pulpcore_client/models/pulp_exporter_response.rb +274 -0
- data/lib/pulpcore_client/models/pulp_import.rb +17 -30
- data/lib/pulpcore_client/models/pulp_importer.rb +6 -45
- data/lib/pulpcore_client/models/pulp_importer_response.rb +242 -0
- data/lib/pulpcore_client/models/{redis_connection.rb → redis_connection_response.rb} +6 -6
- data/lib/pulpcore_client/models/{signing_service.rb → signing_service_response.rb} +6 -43
- data/lib/pulpcore_client/models/{status.rb → status_response.rb} +15 -11
- data/lib/pulpcore_client/models/{storage.rb → storage_response.rb} +6 -6
- data/lib/pulpcore_client/models/{task_group.rb → task_group_response.rb} +7 -25
- data/lib/pulpcore_client/models/{task.rb → task_response.rb} +13 -59
- data/lib/pulpcore_client/models/upload.rb +7 -35
- data/lib/pulpcore_client/models/upload_chunk.rb +11 -39
- data/lib/pulpcore_client/models/upload_chunk_response.rb +215 -0
- data/lib/pulpcore_client/models/upload_commit.rb +2 -21
- data/lib/pulpcore_client/models/{upload_detail.rb → upload_detail_response.rb} +7 -6
- data/lib/pulpcore_client/models/upload_response.rb +242 -0
- data/lib/pulpcore_client/models/user_group_response.rb +241 -0
- data/lib/pulpcore_client/models/user_response.rb +378 -0
- data/lib/pulpcore_client/models/{version.rb → version_response.rb} +6 -44
- data/lib/pulpcore_client/models/{worker.rb → worker_response.rb} +6 -21
- data/lib/pulpcore_client/version.rb +3 -3
- data/lib/pulpcore_client.rb +47 -17
- data/pulpcore_client.gemspec +4 -4
- data/spec/api/access_policies_api_spec.rb +91 -0
- data/spec/api/artifacts_api_spec.rb +18 -15
- data/spec/api/exporters_core_exports_api_spec.rb +10 -10
- data/spec/api/exporters_pulp_api_spec.rb +18 -18
- data/spec/api/groups_api_spec.rb +115 -0
- data/spec/api/groups_model_permissions_api_spec.rb +64 -0
- data/spec/api/groups_object_permissions_api_spec.rb +92 -0
- data/spec/api/groups_users_api_spec.rb +77 -0
- data/spec/api/importers_core_imports_api_spec.rb +10 -10
- data/spec/api/importers_pulp_api_spec.rb +18 -18
- data/spec/api/orphans_api_spec.rb +2 -2
- data/spec/api/signing_services_api_spec.rb +7 -7
- data/spec/api/status_api_spec.rb +5 -7
- data/spec/api/task_groups_api_spec.rb +8 -6
- data/spec/api/tasks_api_spec.rb +69 -42
- data/spec/api/uploads_api_spec.rb +14 -13
- data/spec/api/users_api_spec.rb +78 -0
- data/spec/api/workers_api_spec.rb +18 -16
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/access_policy_response_spec.rb +65 -0
- data/spec/models/access_policy_spec.rb +53 -0
- data/spec/models/artifact_response_spec.rb +95 -0
- data/spec/models/artifact_spec.rb +2 -14
- data/spec/models/async_operation_response_spec.rb +2 -2
- data/spec/models/{content_app_status_spec.rb → content_app_status_response_spec.rb} +8 -8
- data/spec/models/{database_connection_spec.rb → database_connection_response_spec.rb} +8 -8
- data/spec/models/{group_progress_report_spec.rb → group_progress_report_response_spec.rb} +8 -8
- data/spec/models/group_response_spec.rb +53 -0
- data/spec/models/group_spec.rb +41 -0
- data/spec/models/group_user_response_spec.rb +47 -0
- data/spec/models/group_user_spec.rb +41 -0
- data/spec/models/{import_spec.rb → import_response_spec.rb} +8 -8
- data/spec/models/inline_response20010_spec.rb +59 -0
- data/spec/models/inline_response20011_spec.rb +59 -0
- data/spec/models/inline_response20012_spec.rb +59 -0
- data/spec/models/inline_response20013_spec.rb +59 -0
- data/spec/models/inline_response20014_spec.rb +59 -0
- data/spec/models/inline_response2001_spec.rb +2 -2
- data/spec/models/inline_response2002_spec.rb +2 -2
- data/spec/models/inline_response2003_spec.rb +2 -2
- data/spec/models/inline_response2004_spec.rb +2 -2
- data/spec/models/inline_response2005_spec.rb +2 -2
- data/spec/models/inline_response2006_spec.rb +2 -2
- data/spec/models/inline_response2007_spec.rb +2 -2
- data/spec/models/inline_response2008_spec.rb +2 -2
- data/spec/models/inline_response2009_spec.rb +2 -2
- data/spec/models/inline_response200_spec.rb +2 -2
- data/spec/models/patched_access_policy_spec.rb +53 -0
- data/spec/models/patched_group_spec.rb +41 -0
- data/spec/models/patched_pulp_exporter_spec.rb +59 -0
- data/spec/models/patched_pulp_importer_spec.rb +47 -0
- data/spec/models/{task_cancel_spec.rb → patched_task_cancel_spec.rb} +8 -8
- data/spec/models/permission_response_spec.rb +59 -0
- data/spec/models/{progress_report_spec.rb → progress_report_response_spec.rb} +8 -8
- data/spec/models/pulp_export_response_spec.rb +71 -0
- data/spec/models/pulp_export_spec.rb +8 -8
- data/spec/models/pulp_exporter_response_spec.rb +71 -0
- data/spec/models/pulp_exporter_spec.rb +2 -14
- data/spec/models/pulp_import_spec.rb +8 -2
- data/spec/models/pulp_importer_response_spec.rb +59 -0
- data/spec/models/pulp_importer_spec.rb +2 -14
- data/spec/models/{redis_connection_spec.rb → redis_connection_response_spec.rb} +8 -8
- data/spec/models/{signing_service_spec.rb → signing_service_response_spec.rb} +8 -8
- data/spec/models/{status_spec.rb → status_response_spec.rb} +8 -8
- data/spec/models/{storage_spec.rb → storage_response_spec.rb} +8 -8
- data/spec/models/{task_group_spec.rb → task_group_response_spec.rb} +8 -8
- data/spec/models/{task_spec.rb → task_response_spec.rb} +8 -14
- data/spec/models/upload_chunk_response_spec.rb +47 -0
- data/spec/models/upload_chunk_spec.rb +2 -14
- data/spec/models/upload_commit_spec.rb +2 -2
- data/spec/models/{upload_detail_spec.rb → upload_detail_response_spec.rb} +8 -8
- data/spec/models/upload_response_spec.rb +59 -0
- data/spec/models/upload_spec.rb +2 -20
- data/spec/models/user_group_response_spec.rb +47 -0
- data/spec/models/user_response_spec.rb +95 -0
- data/spec/models/{version_spec.rb → version_response_spec.rb} +8 -8
- data/spec/models/{worker_spec.rb → worker_response_spec.rb} +8 -8
- data/spec/spec_helper.rb +2 -2
- metadata +204 -84
- data/docs/Status.md +0 -27
data/docs/TaskGroupsApi.md
CHANGED
|
@@ -11,10 +11,12 @@ Method | HTTP request | Description
|
|
|
11
11
|
|
|
12
12
|
## list
|
|
13
13
|
|
|
14
|
-
>
|
|
14
|
+
> InlineResponse20010 list(opts)
|
|
15
15
|
|
|
16
16
|
List task groups
|
|
17
17
|
|
|
18
|
+
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
|
|
19
|
+
|
|
18
20
|
### Example
|
|
19
21
|
|
|
20
22
|
```ruby
|
|
@@ -22,16 +24,16 @@ List task groups
|
|
|
22
24
|
require 'pulpcore_client'
|
|
23
25
|
# setup authorization
|
|
24
26
|
PulpcoreClient.configure do |config|
|
|
25
|
-
# Configure HTTP basic authorization:
|
|
27
|
+
# Configure HTTP basic authorization: basicAuth
|
|
26
28
|
config.username = 'YOUR USERNAME'
|
|
27
29
|
config.password = 'YOUR PASSWORD'
|
|
28
30
|
end
|
|
29
31
|
|
|
30
32
|
api_instance = PulpcoreClient::TaskGroupsApi.new
|
|
31
33
|
opts = {
|
|
32
|
-
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
|
33
34
|
limit: 56, # Integer | Number of results to return per page.
|
|
34
35
|
offset: 56, # Integer | The initial index from which to return the results.
|
|
36
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
|
35
37
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
|
36
38
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
|
37
39
|
}
|
|
@@ -50,19 +52,19 @@ end
|
|
|
50
52
|
|
|
51
53
|
Name | Type | Description | Notes
|
|
52
54
|
------------- | ------------- | ------------- | -------------
|
|
53
|
-
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
|
54
55
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
|
55
56
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
|
57
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
|
56
58
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
|
57
59
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
|
58
60
|
|
|
59
61
|
### Return type
|
|
60
62
|
|
|
61
|
-
[**
|
|
63
|
+
[**InlineResponse20010**](InlineResponse20010.md)
|
|
62
64
|
|
|
63
65
|
### Authorization
|
|
64
66
|
|
|
65
|
-
[
|
|
67
|
+
[basicAuth](../README.md#basicAuth)
|
|
66
68
|
|
|
67
69
|
### HTTP request headers
|
|
68
70
|
|
|
@@ -72,10 +74,12 @@ Name | Type | Description | Notes
|
|
|
72
74
|
|
|
73
75
|
## read
|
|
74
76
|
|
|
75
|
-
>
|
|
77
|
+
> TaskGroupResponse read(task_group_href, opts)
|
|
76
78
|
|
|
77
79
|
Inspect a task group
|
|
78
80
|
|
|
81
|
+
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
|
|
82
|
+
|
|
79
83
|
### Example
|
|
80
84
|
|
|
81
85
|
```ruby
|
|
@@ -83,13 +87,13 @@ Inspect a task group
|
|
|
83
87
|
require 'pulpcore_client'
|
|
84
88
|
# setup authorization
|
|
85
89
|
PulpcoreClient.configure do |config|
|
|
86
|
-
# Configure HTTP basic authorization:
|
|
90
|
+
# Configure HTTP basic authorization: basicAuth
|
|
87
91
|
config.username = 'YOUR USERNAME'
|
|
88
92
|
config.password = 'YOUR PASSWORD'
|
|
89
93
|
end
|
|
90
94
|
|
|
91
95
|
api_instance = PulpcoreClient::TaskGroupsApi.new
|
|
92
|
-
task_group_href = 'task_group_href_example' # String |
|
|
96
|
+
task_group_href = 'task_group_href_example' # String |
|
|
93
97
|
opts = {
|
|
94
98
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
|
95
99
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
|
@@ -109,17 +113,17 @@ end
|
|
|
109
113
|
|
|
110
114
|
Name | Type | Description | Notes
|
|
111
115
|
------------- | ------------- | ------------- | -------------
|
|
112
|
-
**task_group_href** | **String**|
|
|
116
|
+
**task_group_href** | **String**| |
|
|
113
117
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
|
114
118
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
|
115
119
|
|
|
116
120
|
### Return type
|
|
117
121
|
|
|
118
|
-
[**
|
|
122
|
+
[**TaskGroupResponse**](TaskGroupResponse.md)
|
|
119
123
|
|
|
120
124
|
### Authorization
|
|
121
125
|
|
|
122
|
-
[
|
|
126
|
+
[basicAuth](../README.md#basicAuth)
|
|
123
127
|
|
|
124
128
|
### HTTP request headers
|
|
125
129
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# PulpcoreClient::
|
|
1
|
+
# PulpcoreClient::TaskResponse
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -10,21 +10,20 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**name** | **String** | The name of task. |
|
|
11
11
|
**started_at** | **DateTime** | Timestamp of the when this task started execution. | [optional] [readonly]
|
|
12
12
|
**finished_at** | **DateTime** | Timestamp of the when this task stopped execution. | [optional] [readonly]
|
|
13
|
-
**error** | **
|
|
13
|
+
**error** | [**Object**](.md) | A JSON Object of a fatal error encountered during the execution of this task. | [optional] [readonly]
|
|
14
14
|
**worker** | **String** | The worker associated with this task. This field is empty if a worker is not yet assigned. | [optional] [readonly]
|
|
15
15
|
**parent_task** | **String** | The parent task that spawned this task. | [optional] [readonly]
|
|
16
16
|
**child_tasks** | **Array<String>** | Any tasks spawned by this task. | [optional] [readonly]
|
|
17
17
|
**task_group** | **String** | The task group that this task is a member of. | [optional] [readonly]
|
|
18
|
-
**progress_reports** | [**Array<
|
|
18
|
+
**progress_reports** | [**Array<ProgressReportResponse>**](ProgressReportResponse.md) | | [optional] [readonly]
|
|
19
19
|
**created_resources** | **Array<String>** | Resources created by this task. | [optional] [readonly]
|
|
20
|
-
**reserved_resources_record** | **Array<Object>** | | [optional] [readonly]
|
|
21
20
|
|
|
22
21
|
## Code Sample
|
|
23
22
|
|
|
24
23
|
```ruby
|
|
25
24
|
require 'PulpcoreClient'
|
|
26
25
|
|
|
27
|
-
instance = PulpcoreClient::
|
|
26
|
+
instance = PulpcoreClient::TaskResponse.new(pulp_href: null,
|
|
28
27
|
pulp_created: null,
|
|
29
28
|
state: null,
|
|
30
29
|
name: null,
|
|
@@ -36,8 +35,7 @@ instance = PulpcoreClient::Task.new(pulp_href: null,
|
|
|
36
35
|
child_tasks: null,
|
|
37
36
|
task_group: null,
|
|
38
37
|
progress_reports: null,
|
|
39
|
-
created_resources: null
|
|
40
|
-
reserved_resources_record: null)
|
|
38
|
+
created_resources: null)
|
|
41
39
|
```
|
|
42
40
|
|
|
43
41
|
|
data/docs/TasksApi.md
CHANGED
|
@@ -6,8 +6,8 @@ Method | HTTP request | Description
|
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**delete**](TasksApi.md#delete) | **DELETE** {task_href} | Delete a task
|
|
8
8
|
[**list**](TasksApi.md#list) | **GET** /pulp/api/v3/tasks/ | List tasks
|
|
9
|
+
[**partial_update**](TasksApi.md#partial_update) | **PATCH** {task_href} | Cancel a task
|
|
9
10
|
[**read**](TasksApi.md#read) | **GET** {task_href} | Inspect a task
|
|
10
|
-
[**tasks_cancel**](TasksApi.md#tasks_cancel) | **PATCH** {task_href} | Cancel a task
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
|
|
@@ -17,6 +17,8 @@ Method | HTTP request | Description
|
|
|
17
17
|
|
|
18
18
|
Delete a task
|
|
19
19
|
|
|
20
|
+
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
|
|
21
|
+
|
|
20
22
|
### Example
|
|
21
23
|
|
|
22
24
|
```ruby
|
|
@@ -24,13 +26,13 @@ Delete a task
|
|
|
24
26
|
require 'pulpcore_client'
|
|
25
27
|
# setup authorization
|
|
26
28
|
PulpcoreClient.configure do |config|
|
|
27
|
-
# Configure HTTP basic authorization:
|
|
29
|
+
# Configure HTTP basic authorization: basicAuth
|
|
28
30
|
config.username = 'YOUR USERNAME'
|
|
29
31
|
config.password = 'YOUR PASSWORD'
|
|
30
32
|
end
|
|
31
33
|
|
|
32
34
|
api_instance = PulpcoreClient::TasksApi.new
|
|
33
|
-
task_href = 'task_href_example' # String |
|
|
35
|
+
task_href = 'task_href_example' # String |
|
|
34
36
|
|
|
35
37
|
begin
|
|
36
38
|
#Delete a task
|
|
@@ -45,7 +47,7 @@ end
|
|
|
45
47
|
|
|
46
48
|
Name | Type | Description | Notes
|
|
47
49
|
------------- | ------------- | ------------- | -------------
|
|
48
|
-
**task_href** | **String**|
|
|
50
|
+
**task_href** | **String**| |
|
|
49
51
|
|
|
50
52
|
### Return type
|
|
51
53
|
|
|
@@ -53,7 +55,7 @@ nil (empty response body)
|
|
|
53
55
|
|
|
54
56
|
### Authorization
|
|
55
57
|
|
|
56
|
-
[
|
|
58
|
+
[basicAuth](../README.md#basicAuth)
|
|
57
59
|
|
|
58
60
|
### HTTP request headers
|
|
59
61
|
|
|
@@ -63,10 +65,12 @@ nil (empty response body)
|
|
|
63
65
|
|
|
64
66
|
## list
|
|
65
67
|
|
|
66
|
-
>
|
|
68
|
+
> InlineResponse20011 list(opts)
|
|
67
69
|
|
|
68
70
|
List tasks
|
|
69
71
|
|
|
72
|
+
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
|
|
73
|
+
|
|
70
74
|
### Example
|
|
71
75
|
|
|
72
76
|
```ruby
|
|
@@ -74,39 +78,39 @@ List tasks
|
|
|
74
78
|
require 'pulpcore_client'
|
|
75
79
|
# setup authorization
|
|
76
80
|
PulpcoreClient.configure do |config|
|
|
77
|
-
# Configure HTTP basic authorization:
|
|
81
|
+
# Configure HTTP basic authorization: basicAuth
|
|
78
82
|
config.username = 'YOUR USERNAME'
|
|
79
83
|
config.password = 'YOUR PASSWORD'
|
|
80
84
|
end
|
|
81
85
|
|
|
82
86
|
api_instance = PulpcoreClient::TasksApi.new
|
|
83
87
|
opts = {
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
started_at__gt: 'started_at__gt_example', # String | Filter results where started_at is greater than value
|
|
93
|
-
started_at__gte: 'started_at__gte_example', # String | Filter results where started_at is greater than or equal to value
|
|
94
|
-
started_at__range: 'started_at__range_example', # String | Filter results where started_at is between two comma separated values
|
|
95
|
-
finished_at__lt: 'finished_at__lt_example', # String | Filter results where finished_at is less than value
|
|
96
|
-
finished_at__lte: 'finished_at__lte_example', # String | Filter results where finished_at is less than or equal to value
|
|
97
|
-
finished_at__gt: 'finished_at__gt_example', # String | Filter results where finished_at is greater than value
|
|
98
|
-
finished_at__gte: 'finished_at__gte_example', # String | Filter results where finished_at is greater than or equal to value
|
|
99
|
-
finished_at__range: 'finished_at__range_example', # String | Filter results where finished_at is between two comma separated values
|
|
100
|
-
parent_task: 'parent_task_example', # String | Foreign Key referenced by HREF
|
|
101
|
-
child_tasks: 'child_tasks_example', # String | Foreign Key referenced by HREF
|
|
102
|
-
task_group: 'task_group_example', # String | Foreign Key referenced by HREF
|
|
103
|
-
reserved_resources_record: 'reserved_resources_record_example', # String |
|
|
104
|
-
created_resources: 'created_resources_example', # String |
|
|
105
|
-
name: 'name_example', # String |
|
|
106
|
-
started_at: 'started_at_example', # String | ISO 8601 formatted dates are supported
|
|
107
|
-
finished_at: 'finished_at_example', # String | ISO 8601 formatted dates are supported
|
|
88
|
+
child_tasks: 'child_tasks_example', # String | child_tasks
|
|
89
|
+
created_resources: 'created_resources_example', # String | created_resources
|
|
90
|
+
finished_at: 'finished_at_example', # String | finished_at
|
|
91
|
+
finished_at__gt: 'finished_at__gt_example', # String | finished_at__gt
|
|
92
|
+
finished_at__gte: 'finished_at__gte_example', # String | finished_at__gte
|
|
93
|
+
finished_at__lt: 'finished_at__lt_example', # String | finished_at__lt
|
|
94
|
+
finished_at__lte: 'finished_at__lte_example', # String | finished_at__lte
|
|
95
|
+
finished_at__range: 'finished_at__range_example', # String | finished_at__range
|
|
108
96
|
limit: 56, # Integer | Number of results to return per page.
|
|
97
|
+
name: 'name_example', # String | name
|
|
98
|
+
name__contains: 'name__contains_example', # String | name__contains
|
|
109
99
|
offset: 56, # Integer | The initial index from which to return the results.
|
|
100
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
|
101
|
+
parent_task: 'parent_task_example', # String | parent_task
|
|
102
|
+
reserved_resources_record: 'reserved_resources_record_example', # String | reserved_resources_record
|
|
103
|
+
started_at: 'started_at_example', # String | started_at
|
|
104
|
+
started_at__gt: 'started_at__gt_example', # String | started_at__gt
|
|
105
|
+
started_at__gte: 'started_at__gte_example', # String | started_at__gte
|
|
106
|
+
started_at__lt: 'started_at__lt_example', # String | started_at__lt
|
|
107
|
+
started_at__lte: 'started_at__lte_example', # String | started_at__lte
|
|
108
|
+
started_at__range: 'started_at__range_example', # String | started_at__range
|
|
109
|
+
state: 'state_example', # String | state
|
|
110
|
+
state__in: 'state__in_example', # String | state__in
|
|
111
|
+
task_group: 'task_group_example', # String | task_group
|
|
112
|
+
worker: 'worker_example', # String | worker
|
|
113
|
+
worker__in: 'worker__in_example', # String | worker__in
|
|
110
114
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
|
111
115
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
|
112
116
|
}
|
|
@@ -125,42 +129,42 @@ end
|
|
|
125
129
|
|
|
126
130
|
Name | Type | Description | Notes
|
|
127
131
|
------------- | ------------- | ------------- | -------------
|
|
128
|
-
**
|
|
129
|
-
**
|
|
130
|
-
**
|
|
131
|
-
**
|
|
132
|
-
**
|
|
133
|
-
**
|
|
134
|
-
**
|
|
135
|
-
**
|
|
136
|
-
**started_at__gt** | **String**| Filter results where started_at is greater than value | [optional]
|
|
137
|
-
**started_at__gte** | **String**| Filter results where started_at is greater than or equal to value | [optional]
|
|
138
|
-
**started_at__range** | **String**| Filter results where started_at is between two comma separated values | [optional]
|
|
139
|
-
**finished_at__lt** | **String**| Filter results where finished_at is less than value | [optional]
|
|
140
|
-
**finished_at__lte** | **String**| Filter results where finished_at is less than or equal to value | [optional]
|
|
141
|
-
**finished_at__gt** | **String**| Filter results where finished_at is greater than value | [optional]
|
|
142
|
-
**finished_at__gte** | **String**| Filter results where finished_at is greater than or equal to value | [optional]
|
|
143
|
-
**finished_at__range** | **String**| Filter results where finished_at is between two comma separated values | [optional]
|
|
144
|
-
**parent_task** | **String**| Foreign Key referenced by HREF | [optional]
|
|
145
|
-
**child_tasks** | **String**| Foreign Key referenced by HREF | [optional]
|
|
146
|
-
**task_group** | **String**| Foreign Key referenced by HREF | [optional]
|
|
147
|
-
**reserved_resources_record** | **String**| | [optional]
|
|
148
|
-
**created_resources** | **String**| | [optional]
|
|
149
|
-
**name** | **String**| | [optional]
|
|
150
|
-
**started_at** | **String**| ISO 8601 formatted dates are supported | [optional]
|
|
151
|
-
**finished_at** | **String**| ISO 8601 formatted dates are supported | [optional]
|
|
132
|
+
**child_tasks** | **String**| child_tasks | [optional]
|
|
133
|
+
**created_resources** | **String**| created_resources | [optional]
|
|
134
|
+
**finished_at** | **String**| finished_at | [optional]
|
|
135
|
+
**finished_at__gt** | **String**| finished_at__gt | [optional]
|
|
136
|
+
**finished_at__gte** | **String**| finished_at__gte | [optional]
|
|
137
|
+
**finished_at__lt** | **String**| finished_at__lt | [optional]
|
|
138
|
+
**finished_at__lte** | **String**| finished_at__lte | [optional]
|
|
139
|
+
**finished_at__range** | **String**| finished_at__range | [optional]
|
|
152
140
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
|
141
|
+
**name** | **String**| name | [optional]
|
|
142
|
+
**name__contains** | **String**| name__contains | [optional]
|
|
153
143
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
|
144
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
|
145
|
+
**parent_task** | **String**| parent_task | [optional]
|
|
146
|
+
**reserved_resources_record** | **String**| reserved_resources_record | [optional]
|
|
147
|
+
**started_at** | **String**| started_at | [optional]
|
|
148
|
+
**started_at__gt** | **String**| started_at__gt | [optional]
|
|
149
|
+
**started_at__gte** | **String**| started_at__gte | [optional]
|
|
150
|
+
**started_at__lt** | **String**| started_at__lt | [optional]
|
|
151
|
+
**started_at__lte** | **String**| started_at__lte | [optional]
|
|
152
|
+
**started_at__range** | **String**| started_at__range | [optional]
|
|
153
|
+
**state** | **String**| state | [optional]
|
|
154
|
+
**state__in** | **String**| state__in | [optional]
|
|
155
|
+
**task_group** | **String**| task_group | [optional]
|
|
156
|
+
**worker** | **String**| worker | [optional]
|
|
157
|
+
**worker__in** | **String**| worker__in | [optional]
|
|
154
158
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
|
155
159
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
|
156
160
|
|
|
157
161
|
### Return type
|
|
158
162
|
|
|
159
|
-
[**
|
|
163
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
|
160
164
|
|
|
161
165
|
### Authorization
|
|
162
166
|
|
|
163
|
-
[
|
|
167
|
+
[basicAuth](../README.md#basicAuth)
|
|
164
168
|
|
|
165
169
|
### HTTP request headers
|
|
166
170
|
|
|
@@ -168,11 +172,13 @@ Name | Type | Description | Notes
|
|
|
168
172
|
- **Accept**: application/json
|
|
169
173
|
|
|
170
174
|
|
|
171
|
-
##
|
|
175
|
+
## partial_update
|
|
172
176
|
|
|
173
|
-
>
|
|
177
|
+
> TaskResponse partial_update(task_href, patched_task_cancel, opts)
|
|
174
178
|
|
|
175
|
-
|
|
179
|
+
Cancel a task
|
|
180
|
+
|
|
181
|
+
This operation cancels a task.
|
|
176
182
|
|
|
177
183
|
### Example
|
|
178
184
|
|
|
@@ -181,24 +187,47 @@ Inspect a task
|
|
|
181
187
|
require 'pulpcore_client'
|
|
182
188
|
# setup authorization
|
|
183
189
|
PulpcoreClient.configure do |config|
|
|
184
|
-
# Configure HTTP basic authorization:
|
|
190
|
+
# Configure HTTP basic authorization: basicAuth
|
|
185
191
|
config.username = 'YOUR USERNAME'
|
|
186
192
|
config.password = 'YOUR PASSWORD'
|
|
187
193
|
end
|
|
188
194
|
|
|
189
195
|
api_instance = PulpcoreClient::TasksApi.new
|
|
190
|
-
task_href = 'task_href_example' # String |
|
|
196
|
+
task_href = 'task_href_example' # String |
|
|
197
|
+
patched_task_cancel = PulpcoreClient::PatchedTaskCancel.new # PatchedTaskCancel |
|
|
191
198
|
opts = {
|
|
192
|
-
|
|
193
|
-
|
|
199
|
+
child_tasks: 'child_tasks_example', # String | child_tasks
|
|
200
|
+
created_resources: 'created_resources_example', # String | created_resources
|
|
201
|
+
finished_at: 'finished_at_example', # String | finished_at
|
|
202
|
+
finished_at__gt: 'finished_at__gt_example', # String | finished_at__gt
|
|
203
|
+
finished_at__gte: 'finished_at__gte_example', # String | finished_at__gte
|
|
204
|
+
finished_at__lt: 'finished_at__lt_example', # String | finished_at__lt
|
|
205
|
+
finished_at__lte: 'finished_at__lte_example', # String | finished_at__lte
|
|
206
|
+
finished_at__range: 'finished_at__range_example', # String | finished_at__range
|
|
207
|
+
name: 'name_example', # String | name
|
|
208
|
+
name__contains: 'name__contains_example', # String | name__contains
|
|
209
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
|
210
|
+
parent_task: 'parent_task_example', # String | parent_task
|
|
211
|
+
reserved_resources_record: 'reserved_resources_record_example', # String | reserved_resources_record
|
|
212
|
+
started_at: 'started_at_example', # String | started_at
|
|
213
|
+
started_at__gt: 'started_at__gt_example', # String | started_at__gt
|
|
214
|
+
started_at__gte: 'started_at__gte_example', # String | started_at__gte
|
|
215
|
+
started_at__lt: 'started_at__lt_example', # String | started_at__lt
|
|
216
|
+
started_at__lte: 'started_at__lte_example', # String | started_at__lte
|
|
217
|
+
started_at__range: 'started_at__range_example', # String | started_at__range
|
|
218
|
+
state: 'state_example', # String | state
|
|
219
|
+
state__in: 'state__in_example', # String | state__in
|
|
220
|
+
task_group: 'task_group_example', # String | task_group
|
|
221
|
+
worker: 'worker_example', # String | worker
|
|
222
|
+
worker__in: 'worker__in_example' # String | worker__in
|
|
194
223
|
}
|
|
195
224
|
|
|
196
225
|
begin
|
|
197
|
-
#
|
|
198
|
-
result = api_instance.
|
|
226
|
+
#Cancel a task
|
|
227
|
+
result = api_instance.partial_update(task_href, patched_task_cancel, opts)
|
|
199
228
|
p result
|
|
200
229
|
rescue PulpcoreClient::ApiError => e
|
|
201
|
-
puts "Exception when calling TasksApi->
|
|
230
|
+
puts "Exception when calling TasksApi->partial_update: #{e}"
|
|
202
231
|
end
|
|
203
232
|
```
|
|
204
233
|
|
|
@@ -207,31 +236,54 @@ end
|
|
|
207
236
|
|
|
208
237
|
Name | Type | Description | Notes
|
|
209
238
|
------------- | ------------- | ------------- | -------------
|
|
210
|
-
**task_href** | **String**|
|
|
211
|
-
**
|
|
212
|
-
**
|
|
239
|
+
**task_href** | **String**| |
|
|
240
|
+
**patched_task_cancel** | [**PatchedTaskCancel**](PatchedTaskCancel.md)| |
|
|
241
|
+
**child_tasks** | **String**| child_tasks | [optional]
|
|
242
|
+
**created_resources** | **String**| created_resources | [optional]
|
|
243
|
+
**finished_at** | **String**| finished_at | [optional]
|
|
244
|
+
**finished_at__gt** | **String**| finished_at__gt | [optional]
|
|
245
|
+
**finished_at__gte** | **String**| finished_at__gte | [optional]
|
|
246
|
+
**finished_at__lt** | **String**| finished_at__lt | [optional]
|
|
247
|
+
**finished_at__lte** | **String**| finished_at__lte | [optional]
|
|
248
|
+
**finished_at__range** | **String**| finished_at__range | [optional]
|
|
249
|
+
**name** | **String**| name | [optional]
|
|
250
|
+
**name__contains** | **String**| name__contains | [optional]
|
|
251
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
|
252
|
+
**parent_task** | **String**| parent_task | [optional]
|
|
253
|
+
**reserved_resources_record** | **String**| reserved_resources_record | [optional]
|
|
254
|
+
**started_at** | **String**| started_at | [optional]
|
|
255
|
+
**started_at__gt** | **String**| started_at__gt | [optional]
|
|
256
|
+
**started_at__gte** | **String**| started_at__gte | [optional]
|
|
257
|
+
**started_at__lt** | **String**| started_at__lt | [optional]
|
|
258
|
+
**started_at__lte** | **String**| started_at__lte | [optional]
|
|
259
|
+
**started_at__range** | **String**| started_at__range | [optional]
|
|
260
|
+
**state** | **String**| state | [optional]
|
|
261
|
+
**state__in** | **String**| state__in | [optional]
|
|
262
|
+
**task_group** | **String**| task_group | [optional]
|
|
263
|
+
**worker** | **String**| worker | [optional]
|
|
264
|
+
**worker__in** | **String**| worker__in | [optional]
|
|
213
265
|
|
|
214
266
|
### Return type
|
|
215
267
|
|
|
216
|
-
[**
|
|
268
|
+
[**TaskResponse**](TaskResponse.md)
|
|
217
269
|
|
|
218
270
|
### Authorization
|
|
219
271
|
|
|
220
|
-
[
|
|
272
|
+
[basicAuth](../README.md#basicAuth)
|
|
221
273
|
|
|
222
274
|
### HTTP request headers
|
|
223
275
|
|
|
224
|
-
- **Content-Type**:
|
|
276
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
225
277
|
- **Accept**: application/json
|
|
226
278
|
|
|
227
279
|
|
|
228
|
-
##
|
|
280
|
+
## read
|
|
229
281
|
|
|
230
|
-
>
|
|
282
|
+
> TaskResponse read(task_href, opts)
|
|
231
283
|
|
|
232
|
-
|
|
284
|
+
Inspect a task
|
|
233
285
|
|
|
234
|
-
This
|
|
286
|
+
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
|
|
235
287
|
|
|
236
288
|
### Example
|
|
237
289
|
|
|
@@ -240,21 +292,24 @@ This operation cancels a task.
|
|
|
240
292
|
require 'pulpcore_client'
|
|
241
293
|
# setup authorization
|
|
242
294
|
PulpcoreClient.configure do |config|
|
|
243
|
-
# Configure HTTP basic authorization:
|
|
295
|
+
# Configure HTTP basic authorization: basicAuth
|
|
244
296
|
config.username = 'YOUR USERNAME'
|
|
245
297
|
config.password = 'YOUR PASSWORD'
|
|
246
298
|
end
|
|
247
299
|
|
|
248
300
|
api_instance = PulpcoreClient::TasksApi.new
|
|
249
|
-
task_href = 'task_href_example' # String |
|
|
250
|
-
|
|
301
|
+
task_href = 'task_href_example' # String |
|
|
302
|
+
opts = {
|
|
303
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
|
304
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
|
305
|
+
}
|
|
251
306
|
|
|
252
307
|
begin
|
|
253
|
-
#
|
|
254
|
-
result = api_instance.
|
|
308
|
+
#Inspect a task
|
|
309
|
+
result = api_instance.read(task_href, opts)
|
|
255
310
|
p result
|
|
256
311
|
rescue PulpcoreClient::ApiError => e
|
|
257
|
-
puts "Exception when calling TasksApi->
|
|
312
|
+
puts "Exception when calling TasksApi->read: #{e}"
|
|
258
313
|
end
|
|
259
314
|
```
|
|
260
315
|
|
|
@@ -263,19 +318,20 @@ end
|
|
|
263
318
|
|
|
264
319
|
Name | Type | Description | Notes
|
|
265
320
|
------------- | ------------- | ------------- | -------------
|
|
266
|
-
**task_href** | **String**|
|
|
267
|
-
**
|
|
321
|
+
**task_href** | **String**| |
|
|
322
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
|
323
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
|
268
324
|
|
|
269
325
|
### Return type
|
|
270
326
|
|
|
271
|
-
[**
|
|
327
|
+
[**TaskResponse**](TaskResponse.md)
|
|
272
328
|
|
|
273
329
|
### Authorization
|
|
274
330
|
|
|
275
|
-
[
|
|
331
|
+
[basicAuth](../README.md#basicAuth)
|
|
276
332
|
|
|
277
333
|
### HTTP request headers
|
|
278
334
|
|
|
279
|
-
- **Content-Type**:
|
|
335
|
+
- **Content-Type**: Not defined
|
|
280
336
|
- **Accept**: application/json
|
|
281
337
|
|
data/docs/Upload.md
CHANGED
|
@@ -4,20 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**pulp_href** | **String** | | [optional] [readonly]
|
|
8
|
-
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
|
9
7
|
**size** | **Integer** | The size of the upload in bytes. |
|
|
10
|
-
**completed** | **DateTime** | Timestamp when upload is committed. | [optional] [readonly]
|
|
11
8
|
|
|
12
9
|
## Code Sample
|
|
13
10
|
|
|
14
11
|
```ruby
|
|
15
12
|
require 'PulpcoreClient'
|
|
16
13
|
|
|
17
|
-
instance = PulpcoreClient::Upload.new(
|
|
18
|
-
pulp_created: null,
|
|
19
|
-
size: null,
|
|
20
|
-
completed: null)
|
|
14
|
+
instance = PulpcoreClient::Upload.new(size: null)
|
|
21
15
|
```
|
|
22
16
|
|
|
23
17
|
|
data/docs/UploadChunk.md
CHANGED
|
@@ -4,10 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**file** | **
|
|
7
|
+
**file** | **File** | A chunk of the uploaded file. |
|
|
8
8
|
**sha256** | **String** | The SHA-256 checksum of the chunk if available. | [optional]
|
|
9
|
-
**offset** | **Integer** | | [optional] [readonly]
|
|
10
|
-
**size** | **Integer** | | [optional] [readonly]
|
|
11
9
|
|
|
12
10
|
## Code Sample
|
|
13
11
|
|
|
@@ -15,9 +13,7 @@ Name | Type | Description | Notes
|
|
|
15
13
|
require 'PulpcoreClient'
|
|
16
14
|
|
|
17
15
|
instance = PulpcoreClient::UploadChunk.new(file: null,
|
|
18
|
-
sha256: null
|
|
19
|
-
offset: null,
|
|
20
|
-
size: null)
|
|
16
|
+
sha256: null)
|
|
21
17
|
```
|
|
22
18
|
|
|
23
19
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# PulpcoreClient::UploadChunkResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**offset** | **Integer** | | [optional] [readonly]
|
|
8
|
+
**size** | **Integer** | | [optional] [readonly]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'PulpcoreClient'
|
|
14
|
+
|
|
15
|
+
instance = PulpcoreClient::UploadChunkResponse.new(offset: null,
|
|
16
|
+
size: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# PulpcoreClient::
|
|
1
|
+
# PulpcoreClient::UploadDetailResponse
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
|
9
9
|
**size** | **Integer** | The size of the upload in bytes. |
|
|
10
10
|
**completed** | **DateTime** | Timestamp when upload is committed. | [optional] [readonly]
|
|
11
|
-
**chunks** | [**Array<
|
|
11
|
+
**chunks** | [**Array<UploadChunkResponse>**](UploadChunkResponse.md) | | [optional] [readonly]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
|
15
15
|
```ruby
|
|
16
16
|
require 'PulpcoreClient'
|
|
17
17
|
|
|
18
|
-
instance = PulpcoreClient::
|
|
18
|
+
instance = PulpcoreClient::UploadDetailResponse.new(pulp_href: null,
|
|
19
19
|
pulp_created: null,
|
|
20
20
|
size: null,
|
|
21
21
|
completed: null,
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PulpcoreClient::UploadResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
|
9
|
+
**size** | **Integer** | The size of the upload in bytes. |
|
|
10
|
+
**completed** | **DateTime** | Timestamp when upload is committed. | [optional] [readonly]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'PulpcoreClient'
|
|
16
|
+
|
|
17
|
+
instance = PulpcoreClient::UploadResponse.new(pulp_href: null,
|
|
18
|
+
pulp_created: null,
|
|
19
|
+
size: null,
|
|
20
|
+
completed: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|