pulpcore_client 3.2.1 → 3.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (79) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +37 -4
  3. data/docs/ArtifactsApi.md +2 -0
  4. data/docs/ExportersCoreExportsApi.md +243 -0
  5. data/docs/ExportersPulpApi.md +355 -0
  6. data/docs/Import.md +23 -0
  7. data/docs/ImportersCoreImportsApi.md +243 -0
  8. data/docs/ImportersPulpApi.md +355 -0
  9. data/docs/InlineResponse2001.md +1 -1
  10. data/docs/InlineResponse2002.md +1 -1
  11. data/docs/InlineResponse2003.md +1 -1
  12. data/docs/InlineResponse2004.md +1 -1
  13. data/docs/InlineResponse2005.md +23 -0
  14. data/docs/InlineResponse2006.md +23 -0
  15. data/docs/InlineResponse2007.md +23 -0
  16. data/docs/InlineResponse2008.md +23 -0
  17. data/docs/InlineResponse2009.md +23 -0
  18. data/docs/PulpExport.md +29 -0
  19. data/docs/PulpExporter.md +27 -0
  20. data/docs/PulpImport.md +17 -0
  21. data/docs/PulpImporter.md +23 -0
  22. data/docs/SigningServicesApi.md +6 -2
  23. data/docs/Task.md +6 -0
  24. data/docs/TaskGroup.md +29 -0
  25. data/docs/TaskGroupsApi.md +128 -0
  26. data/docs/TasksApi.md +10 -6
  27. data/docs/UploadsApi.md +4 -2
  28. data/docs/WorkersApi.md +4 -2
  29. data/lib/pulpcore_client/api/artifacts_api.rb +3 -0
  30. data/lib/pulpcore_client/api/exporters_core_exports_api.rb +297 -0
  31. data/lib/pulpcore_client/api/exporters_pulp_api.rb +431 -0
  32. data/lib/pulpcore_client/api/importers_core_imports_api.rb +297 -0
  33. data/lib/pulpcore_client/api/importers_pulp_api.rb +431 -0
  34. data/lib/pulpcore_client/api/signing_services_api.rb +9 -3
  35. data/lib/pulpcore_client/api/task_groups_api.rb +157 -0
  36. data/lib/pulpcore_client/api/tasks_api.rb +15 -9
  37. data/lib/pulpcore_client/api/uploads_api.rb +6 -3
  38. data/lib/pulpcore_client/api/workers_api.rb +6 -3
  39. data/lib/pulpcore_client/models/import.rb +246 -0
  40. data/lib/pulpcore_client/models/inline_response2001.rb +1 -1
  41. data/lib/pulpcore_client/models/inline_response2002.rb +1 -1
  42. data/lib/pulpcore_client/models/inline_response2003.rb +1 -1
  43. data/lib/pulpcore_client/models/inline_response2004.rb +1 -1
  44. data/lib/pulpcore_client/models/inline_response2005.rb +247 -0
  45. data/lib/pulpcore_client/models/inline_response2006.rb +247 -0
  46. data/lib/pulpcore_client/models/inline_response2007.rb +247 -0
  47. data/lib/pulpcore_client/models/inline_response2008.rb +247 -0
  48. data/lib/pulpcore_client/models/inline_response2009.rb +247 -0
  49. data/lib/pulpcore_client/models/pulp_export.rb +310 -0
  50. data/lib/pulpcore_client/models/pulp_exporter.rb +310 -0
  51. data/lib/pulpcore_client/models/pulp_import.rb +231 -0
  52. data/lib/pulpcore_client/models/pulp_importer.rb +262 -0
  53. data/lib/pulpcore_client/models/task.rb +33 -1
  54. data/lib/pulpcore_client/models/task_group.rb +291 -0
  55. data/lib/pulpcore_client/version.rb +1 -1
  56. data/lib/pulpcore_client.rb +16 -0
  57. data/spec/api/artifacts_api_spec.rb +1 -0
  58. data/spec/api/exporters_core_exports_api_spec.rb +91 -0
  59. data/spec/api/exporters_pulp_api_spec.rb +117 -0
  60. data/spec/api/importers_core_imports_api_spec.rb +91 -0
  61. data/spec/api/importers_pulp_api_spec.rb +117 -0
  62. data/spec/api/signing_services_api_spec.rb +3 -1
  63. data/spec/api/task_groups_api_spec.rb +63 -0
  64. data/spec/api/tasks_api_spec.rb +5 -3
  65. data/spec/api/uploads_api_spec.rb +2 -1
  66. data/spec/api/workers_api_spec.rb +2 -1
  67. data/spec/models/import_spec.rb +59 -0
  68. data/spec/models/inline_response2005_spec.rb +59 -0
  69. data/spec/models/inline_response2006_spec.rb +59 -0
  70. data/spec/models/inline_response2007_spec.rb +59 -0
  71. data/spec/models/inline_response2008_spec.rb +59 -0
  72. data/spec/models/inline_response2009_spec.rb +59 -0
  73. data/spec/models/pulp_export_spec.rb +77 -0
  74. data/spec/models/pulp_exporter_spec.rb +71 -0
  75. data/spec/models/pulp_import_spec.rb +41 -0
  76. data/spec/models/pulp_importer_spec.rb +59 -0
  77. data/spec/models/task_group_spec.rb +77 -0
  78. data/spec/models/task_spec.rb +18 -0
  79. metadata +66 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cda49bbf072905acec06ce07f92c4bde00da579ab0dd09add98708d4c8992a39
4
- data.tar.gz: eda3003db64974e17d7146c222fa56390f3a62e160970d59df8ac2f4c8437578
3
+ metadata.gz: b4e2ccb38c5285efaadc7b95f5d3cf72c8d98025727005eddf7a4144f13b85f8
4
+ data.tar.gz: 3188fc7ae75acb671987db77b8752cfab15119e8c6caec20b88b84ffebaa6452
5
5
  SHA512:
6
- metadata.gz: a4ca2d9a95e946b7aacfe2ff1e9212fd445a86e1c02540fd616926f6f3304f833152e306c7b8b1c4de74e435cef49f12725ef3d1d4f4fc92ec4c57d7ec8e79d5
7
- data.tar.gz: 55527c29ebd2b936cc98ce6c34497df6e4412d87ce361078a17e212c6e149098e57e4bf2231d8f14ff3c5cb4cec288892100a57da39f674096b671b4a910703d
6
+ metadata.gz: e1df956e5727b662c3b60bc3f7b9602eb76d282066a05fcd43eb1cbadba61d43958d4b96740c3461e45cc715d72844e040275cb7e883bc9202ad48ac6e2ede23
7
+ data.tar.gz: 4e3f02212cbfd7b0fd85f8a585a5359d4de198b3243aecaa0fc9f73fb72b0ab2ba221ed16fa8dac982e8c103a800fc586bb9db5412448628a99fb2ccd1a63394
data/README.md CHANGED
@@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: v3
10
- - Package version: 3.2.1
10
+ - Package version: 3.3.0
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,16 +23,16 @@ gem build pulpcore_client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./pulpcore_client-3.2.1.gem
26
+ gem install ./pulpcore_client-3.3.0.gem
27
27
  ```
28
28
 
29
- (for development, run `gem install --dev ./pulpcore_client-3.2.1.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./pulpcore_client-3.3.0.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'pulpcore_client', '~> 3.2.1'
35
+ gem 'pulpcore_client', '~> 3.3.0'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -95,10 +95,32 @@ Class | Method | HTTP request | Description
95
95
  *PulpcoreClient::ArtifactsApi* | [**delete**](docs/ArtifactsApi.md#delete) | **DELETE** {artifact_href} | Delete an artifact
96
96
  *PulpcoreClient::ArtifactsApi* | [**list**](docs/ArtifactsApi.md#list) | **GET** /pulp/api/v3/artifacts/ | List artifacts
97
97
  *PulpcoreClient::ArtifactsApi* | [**read**](docs/ArtifactsApi.md#read) | **GET** {artifact_href} | Inspect an artifact
98
+ *PulpcoreClient::ExportersCoreExportsApi* | [**create**](docs/ExportersCoreExportsApi.md#create) | **POST** /pulp/api/v3/exporters/core/pulp/{exporter_pk}/exports/ | Create a pulp export
99
+ *PulpcoreClient::ExportersCoreExportsApi* | [**delete**](docs/ExportersCoreExportsApi.md#delete) | **DELETE** {pulp_export_href} | Delete a pulp export
100
+ *PulpcoreClient::ExportersCoreExportsApi* | [**list**](docs/ExportersCoreExportsApi.md#list) | **GET** /pulp/api/v3/exporters/core/pulp/{exporter_pk}/exports/ | List pulp exports
101
+ *PulpcoreClient::ExportersCoreExportsApi* | [**read**](docs/ExportersCoreExportsApi.md#read) | **GET** {pulp_export_href} | Inspect a pulp export
102
+ *PulpcoreClient::ExportersPulpApi* | [**create**](docs/ExportersPulpApi.md#create) | **POST** /pulp/api/v3/exporters/core/pulp/ | Create a pulp exporter
103
+ *PulpcoreClient::ExportersPulpApi* | [**delete**](docs/ExportersPulpApi.md#delete) | **DELETE** {pulp_exporter_href} | Delete a pulp exporter
104
+ *PulpcoreClient::ExportersPulpApi* | [**list**](docs/ExportersPulpApi.md#list) | **GET** /pulp/api/v3/exporters/core/pulp/ | List pulp exporters
105
+ *PulpcoreClient::ExportersPulpApi* | [**partial_update**](docs/ExportersPulpApi.md#partial_update) | **PATCH** {pulp_exporter_href} | Partially update a pulp exporter
106
+ *PulpcoreClient::ExportersPulpApi* | [**read**](docs/ExportersPulpApi.md#read) | **GET** {pulp_exporter_href} | Inspect a pulp exporter
107
+ *PulpcoreClient::ExportersPulpApi* | [**update**](docs/ExportersPulpApi.md#update) | **PUT** {pulp_exporter_href} | Update a pulp exporter
108
+ *PulpcoreClient::ImportersCoreImportsApi* | [**create**](docs/ImportersCoreImportsApi.md#create) | **POST** /pulp/api/v3/importers/core/pulp/{importer_pk}/imports/ | Create a pulp import
109
+ *PulpcoreClient::ImportersCoreImportsApi* | [**delete**](docs/ImportersCoreImportsApi.md#delete) | **DELETE** {pulp_import_href} | Delete a pulp import
110
+ *PulpcoreClient::ImportersCoreImportsApi* | [**list**](docs/ImportersCoreImportsApi.md#list) | **GET** /pulp/api/v3/importers/core/pulp/{importer_pk}/imports/ | List pulp imports
111
+ *PulpcoreClient::ImportersCoreImportsApi* | [**read**](docs/ImportersCoreImportsApi.md#read) | **GET** {pulp_import_href} | Inspect a pulp import
112
+ *PulpcoreClient::ImportersPulpApi* | [**create**](docs/ImportersPulpApi.md#create) | **POST** /pulp/api/v3/importers/core/pulp/ | Create a pulp importer
113
+ *PulpcoreClient::ImportersPulpApi* | [**delete**](docs/ImportersPulpApi.md#delete) | **DELETE** {pulp_importer_href} | Delete a pulp importer
114
+ *PulpcoreClient::ImportersPulpApi* | [**list**](docs/ImportersPulpApi.md#list) | **GET** /pulp/api/v3/importers/core/pulp/ | List pulp importers
115
+ *PulpcoreClient::ImportersPulpApi* | [**partial_update**](docs/ImportersPulpApi.md#partial_update) | **PATCH** {pulp_importer_href} | Partially update a pulp importer
116
+ *PulpcoreClient::ImportersPulpApi* | [**read**](docs/ImportersPulpApi.md#read) | **GET** {pulp_importer_href} | Inspect a pulp importer
117
+ *PulpcoreClient::ImportersPulpApi* | [**update**](docs/ImportersPulpApi.md#update) | **PUT** {pulp_importer_href} | Update a pulp importer
98
118
  *PulpcoreClient::OrphansApi* | [**delete**](docs/OrphansApi.md#delete) | **DELETE** /pulp/api/v3/orphans/ | Delete orphans
99
119
  *PulpcoreClient::SigningServicesApi* | [**list**](docs/SigningServicesApi.md#list) | **GET** /pulp/api/v3/signing-services/ | List signing services
100
120
  *PulpcoreClient::SigningServicesApi* | [**read**](docs/SigningServicesApi.md#read) | **GET** {signing_service_href} | Inspect a signing service
101
121
  *PulpcoreClient::StatusApi* | [**status_read**](docs/StatusApi.md#status_read) | **GET** /pulp/api/v3/status/ | Inspect status of Pulp
122
+ *PulpcoreClient::TaskGroupsApi* | [**list**](docs/TaskGroupsApi.md#list) | **GET** /pulp/api/v3/task-groups/ | List task groups
123
+ *PulpcoreClient::TaskGroupsApi* | [**read**](docs/TaskGroupsApi.md#read) | **GET** {task_group_href} | Inspect a task group
102
124
  *PulpcoreClient::TasksApi* | [**delete**](docs/TasksApi.md#delete) | **DELETE** {task_href} | Delete a task
103
125
  *PulpcoreClient::TasksApi* | [**list**](docs/TasksApi.md#list) | **GET** /pulp/api/v3/tasks/ | List tasks
104
126
  *PulpcoreClient::TasksApi* | [**read**](docs/TasksApi.md#read) | **GET** {task_href} | Inspect a task
@@ -119,18 +141,29 @@ Class | Method | HTTP request | Description
119
141
  - [PulpcoreClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
120
142
  - [PulpcoreClient::ContentAppStatus](docs/ContentAppStatus.md)
121
143
  - [PulpcoreClient::DatabaseConnection](docs/DatabaseConnection.md)
144
+ - [PulpcoreClient::Import](docs/Import.md)
122
145
  - [PulpcoreClient::InlineResponse200](docs/InlineResponse200.md)
123
146
  - [PulpcoreClient::InlineResponse2001](docs/InlineResponse2001.md)
124
147
  - [PulpcoreClient::InlineResponse2002](docs/InlineResponse2002.md)
125
148
  - [PulpcoreClient::InlineResponse2003](docs/InlineResponse2003.md)
126
149
  - [PulpcoreClient::InlineResponse2004](docs/InlineResponse2004.md)
150
+ - [PulpcoreClient::InlineResponse2005](docs/InlineResponse2005.md)
151
+ - [PulpcoreClient::InlineResponse2006](docs/InlineResponse2006.md)
152
+ - [PulpcoreClient::InlineResponse2007](docs/InlineResponse2007.md)
153
+ - [PulpcoreClient::InlineResponse2008](docs/InlineResponse2008.md)
154
+ - [PulpcoreClient::InlineResponse2009](docs/InlineResponse2009.md)
127
155
  - [PulpcoreClient::ProgressReport](docs/ProgressReport.md)
156
+ - [PulpcoreClient::PulpExport](docs/PulpExport.md)
157
+ - [PulpcoreClient::PulpExporter](docs/PulpExporter.md)
158
+ - [PulpcoreClient::PulpImport](docs/PulpImport.md)
159
+ - [PulpcoreClient::PulpImporter](docs/PulpImporter.md)
128
160
  - [PulpcoreClient::RedisConnection](docs/RedisConnection.md)
129
161
  - [PulpcoreClient::SigningService](docs/SigningService.md)
130
162
  - [PulpcoreClient::Status](docs/Status.md)
131
163
  - [PulpcoreClient::Storage](docs/Storage.md)
132
164
  - [PulpcoreClient::Task](docs/Task.md)
133
165
  - [PulpcoreClient::TaskCancel](docs/TaskCancel.md)
166
+ - [PulpcoreClient::TaskGroup](docs/TaskGroup.md)
134
167
  - [PulpcoreClient::Upload](docs/Upload.md)
135
168
  - [PulpcoreClient::UploadChunk](docs/UploadChunk.md)
136
169
  - [PulpcoreClient::UploadCommit](docs/UploadCommit.md)
data/docs/ArtifactsApi.md CHANGED
@@ -150,6 +150,7 @@ end
150
150
 
151
151
  api_instance = PulpcoreClient::ArtifactsApi.new
152
152
  opts = {
153
+ ordering: 'ordering_example', # String | Which field to use when ordering the results.
153
154
  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
154
155
  md5: 'md5_example', # String | Filter results where md5 matches value
155
156
  sha1: 'sha1_example', # String | Filter results where sha1 matches value
@@ -177,6 +178,7 @@ end
177
178
 
178
179
  Name | Type | Description | Notes
179
180
  ------------- | ------------- | ------------- | -------------
181
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
180
182
  **repository_version** | **String**| Repository Version referenced by HREF | [optional]
181
183
  **md5** | **String**| Filter results where md5 matches value | [optional]
182
184
  **sha1** | **String**| Filter results where sha1 matches value | [optional]
@@ -0,0 +1,243 @@
1
+ # PulpcoreClient::ExportersCoreExportsApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](ExportersCoreExportsApi.md#create) | **POST** /pulp/api/v3/exporters/core/pulp/{exporter_pk}/exports/ | Create a pulp export
8
+ [**delete**](ExportersCoreExportsApi.md#delete) | **DELETE** {pulp_export_href} | Delete a pulp export
9
+ [**list**](ExportersCoreExportsApi.md#list) | **GET** /pulp/api/v3/exporters/core/pulp/{exporter_pk}/exports/ | List pulp exports
10
+ [**read**](ExportersCoreExportsApi.md#read) | **GET** {pulp_export_href} | Inspect a pulp export
11
+
12
+
13
+
14
+ ## create
15
+
16
+ > AsyncOperationResponse create(exporter_pk, data)
17
+
18
+ Create a pulp export
19
+
20
+ Trigger an asynchronous task to export a set of repositories
21
+
22
+ ### Example
23
+
24
+ ```ruby
25
+ # load the gem
26
+ require 'pulpcore_client'
27
+ # setup authorization
28
+ PulpcoreClient.configure do |config|
29
+ # Configure HTTP basic authorization: Basic
30
+ config.username = 'YOUR USERNAME'
31
+ config.password = 'YOUR PASSWORD'
32
+ end
33
+
34
+ api_instance = PulpcoreClient::ExportersCoreExportsApi.new
35
+ exporter_pk = 'exporter_pk_example' # String |
36
+ data = PulpcoreClient::PulpExport.new # PulpExport |
37
+
38
+ begin
39
+ #Create a pulp export
40
+ result = api_instance.create(exporter_pk, data)
41
+ p result
42
+ rescue PulpcoreClient::ApiError => e
43
+ puts "Exception when calling ExportersCoreExportsApi->create: #{e}"
44
+ end
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+
50
+ Name | Type | Description | Notes
51
+ ------------- | ------------- | ------------- | -------------
52
+ **exporter_pk** | **String**| |
53
+ **data** | [**PulpExport**](PulpExport.md)| |
54
+
55
+ ### Return type
56
+
57
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
58
+
59
+ ### Authorization
60
+
61
+ [Basic](../README.md#Basic)
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: application/json
66
+ - **Accept**: application/json
67
+
68
+
69
+ ## delete
70
+
71
+ > delete(pulp_export_href)
72
+
73
+ Delete a pulp export
74
+
75
+ ViewSet for viewing exports from a PulpExporter.
76
+
77
+ ### Example
78
+
79
+ ```ruby
80
+ # load the gem
81
+ require 'pulpcore_client'
82
+ # setup authorization
83
+ PulpcoreClient.configure do |config|
84
+ # Configure HTTP basic authorization: Basic
85
+ config.username = 'YOUR USERNAME'
86
+ config.password = 'YOUR PASSWORD'
87
+ end
88
+
89
+ api_instance = PulpcoreClient::ExportersCoreExportsApi.new
90
+ pulp_export_href = 'pulp_export_href_example' # String | URI of Pulp Export. e.g.: /pulp/api/v3/exporters/core/pulp/1/exports/1/
91
+
92
+ begin
93
+ #Delete a pulp export
94
+ api_instance.delete(pulp_export_href)
95
+ rescue PulpcoreClient::ApiError => e
96
+ puts "Exception when calling ExportersCoreExportsApi->delete: #{e}"
97
+ end
98
+ ```
99
+
100
+ ### Parameters
101
+
102
+
103
+ Name | Type | Description | Notes
104
+ ------------- | ------------- | ------------- | -------------
105
+ **pulp_export_href** | **String**| URI of Pulp Export. e.g.: /pulp/api/v3/exporters/core/pulp/1/exports/1/ |
106
+
107
+ ### Return type
108
+
109
+ nil (empty response body)
110
+
111
+ ### Authorization
112
+
113
+ [Basic](../README.md#Basic)
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: Not defined
118
+ - **Accept**: Not defined
119
+
120
+
121
+ ## list
122
+
123
+ > InlineResponse2002 list(exporter_pk, opts)
124
+
125
+ List pulp exports
126
+
127
+ ViewSet for viewing exports from a PulpExporter.
128
+
129
+ ### Example
130
+
131
+ ```ruby
132
+ # load the gem
133
+ require 'pulpcore_client'
134
+ # setup authorization
135
+ PulpcoreClient.configure do |config|
136
+ # Configure HTTP basic authorization: Basic
137
+ config.username = 'YOUR USERNAME'
138
+ config.password = 'YOUR PASSWORD'
139
+ end
140
+
141
+ api_instance = PulpcoreClient::ExportersCoreExportsApi.new
142
+ exporter_pk = 'exporter_pk_example' # String |
143
+ opts = {
144
+ ordering: 'ordering_example', # String | Which field to use when ordering the results.
145
+ limit: 56, # Integer | Number of results to return per page.
146
+ offset: 56, # Integer | The initial index from which to return the results.
147
+ fields: 'fields_example', # String | A list of fields to include in the response.
148
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
149
+ }
150
+
151
+ begin
152
+ #List pulp exports
153
+ result = api_instance.list(exporter_pk, opts)
154
+ p result
155
+ rescue PulpcoreClient::ApiError => e
156
+ puts "Exception when calling ExportersCoreExportsApi->list: #{e}"
157
+ end
158
+ ```
159
+
160
+ ### Parameters
161
+
162
+
163
+ Name | Type | Description | Notes
164
+ ------------- | ------------- | ------------- | -------------
165
+ **exporter_pk** | **String**| |
166
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
167
+ **limit** | **Integer**| Number of results to return per page. | [optional]
168
+ **offset** | **Integer**| The initial index from which to return the results. | [optional]
169
+ **fields** | **String**| A list of fields to include in the response. | [optional]
170
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
171
+
172
+ ### Return type
173
+
174
+ [**InlineResponse2002**](InlineResponse2002.md)
175
+
176
+ ### Authorization
177
+
178
+ [Basic](../README.md#Basic)
179
+
180
+ ### HTTP request headers
181
+
182
+ - **Content-Type**: Not defined
183
+ - **Accept**: application/json
184
+
185
+
186
+ ## read
187
+
188
+ > PulpExport read(pulp_export_href, opts)
189
+
190
+ Inspect a pulp export
191
+
192
+ ViewSet for viewing exports from a PulpExporter.
193
+
194
+ ### Example
195
+
196
+ ```ruby
197
+ # load the gem
198
+ require 'pulpcore_client'
199
+ # setup authorization
200
+ PulpcoreClient.configure do |config|
201
+ # Configure HTTP basic authorization: Basic
202
+ config.username = 'YOUR USERNAME'
203
+ config.password = 'YOUR PASSWORD'
204
+ end
205
+
206
+ api_instance = PulpcoreClient::ExportersCoreExportsApi.new
207
+ pulp_export_href = 'pulp_export_href_example' # String | URI of Pulp Export. e.g.: /pulp/api/v3/exporters/core/pulp/1/exports/1/
208
+ opts = {
209
+ fields: 'fields_example', # String | A list of fields to include in the response.
210
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
211
+ }
212
+
213
+ begin
214
+ #Inspect a pulp export
215
+ result = api_instance.read(pulp_export_href, opts)
216
+ p result
217
+ rescue PulpcoreClient::ApiError => e
218
+ puts "Exception when calling ExportersCoreExportsApi->read: #{e}"
219
+ end
220
+ ```
221
+
222
+ ### Parameters
223
+
224
+
225
+ Name | Type | Description | Notes
226
+ ------------- | ------------- | ------------- | -------------
227
+ **pulp_export_href** | **String**| URI of Pulp Export. e.g.: /pulp/api/v3/exporters/core/pulp/1/exports/1/ |
228
+ **fields** | **String**| A list of fields to include in the response. | [optional]
229
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
230
+
231
+ ### Return type
232
+
233
+ [**PulpExport**](PulpExport.md)
234
+
235
+ ### Authorization
236
+
237
+ [Basic](../README.md#Basic)
238
+
239
+ ### HTTP request headers
240
+
241
+ - **Content-Type**: Not defined
242
+ - **Accept**: application/json
243
+