pulp_maven_client 0.16.1 → 0.17.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.
Files changed (14) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -4
  3. data/docs/ContentMetadataApi.md +531 -0
  4. data/docs/MavenMavenMetadataResponse.md +40 -0
  5. data/docs/PaginatedmavenMavenMetadataResponseList.md +24 -0
  6. data/lib/pulp_maven_client/api/content_metadata_api.rb +574 -0
  7. data/lib/pulp_maven_client/models/maven_maven_metadata_response.rb +327 -0
  8. data/lib/pulp_maven_client/models/paginatedmaven_maven_metadata_response_list.rb +257 -0
  9. data/lib/pulp_maven_client/version.rb +1 -1
  10. data/lib/pulp_maven_client.rb +3 -0
  11. data/spec/api/content_metadata_api_spec.rb +150 -0
  12. data/spec/models/maven_maven_metadata_response_spec.rb +102 -0
  13. data/spec/models/paginatedmaven_maven_metadata_response_list_spec.rb +54 -0
  14. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c98971b6bf432c5d8b5774086ad7e0631b5ee2b38f516cf00e0f0f51357c82c6
4
- data.tar.gz: 28931ad7041bc85325177002a5c827305727eb3692d2d74e7beccd568ebc71c9
3
+ metadata.gz: 539e3bac4bd01bdf62aa9737aa6ba5e9b42bba1700b3926ca8da1f994060b019
4
+ data.tar.gz: e22d114b353603a3e9a544f2b12f03eb4b514851f878ec86f4297756dc0cbcef
5
5
  SHA512:
6
- metadata.gz: 9c1fd327debc603f9e97498f666b5086d620aa6e900ba71532b31709984610b4ca0390a1e62301342482235b42b2bae74e77bbc9894729d185cf0f45664aa298
7
- data.tar.gz: 3172cea7cdb617bd16338aae7c057f7023529d2cf572cec87dc96c16aa82c3dcf7b50bc61b02a4db81dcfd6a1e8a1c4c0622a3c6b6079b811d77d0af960a9d1f
6
+ metadata.gz: 20d4a229ad311e7e9dd77bc5ceebe94aaf5e6ebb2fbc0c399583d237c23f7ed7aafb70e9534ef62bb316459c03111b1b5fff39a41eba87a3424af58fbb21c456
7
+ data.tar.gz: '09c659fcb2dab212fccb790bfbd8d89fbb0fda56bbc29433b58e3d04b247423f23c7c70eda387d244d8e9de95529e3f06810faad56ced8fbaeb690f7d0846b6e'
data/README.md CHANGED
@@ -7,7 +7,7 @@ Fetch, Upload, Organize, and Distribute Software Packages
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: 0.16.1
10
+ - Package version: 0.17.0
11
11
  - Generator version: 7.10.0
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
  For more information, please visit [https://pulpproject.org](https://pulpproject.org)
@@ -25,16 +25,16 @@ gem build pulp_maven_client.gemspec
25
25
  Then either install the gem locally:
26
26
 
27
27
  ```shell
28
- gem install ./pulp_maven_client-0.16.1.gem
28
+ gem install ./pulp_maven_client-0.17.0.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./pulp_maven_client-0.16.1.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./pulp_maven_client-0.17.0.gem` to install the development dependencies)
32
32
 
33
33
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
34
34
 
35
35
  Finally add this to the Gemfile:
36
36
 
37
- gem 'pulp_maven_client', '~> 0.16.1'
37
+ gem 'pulp_maven_client', '~> 0.17.0'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -103,6 +103,12 @@ Class | Method | HTTP request | Description
103
103
  *PulpMavenClient::ContentArtifactApi* | [**set_label**](docs/ContentArtifactApi.md#set_label) | **POST** {maven_maven_artifact_href}set_label/ | Set a label
104
104
  *PulpMavenClient::ContentArtifactApi* | [**unset_label**](docs/ContentArtifactApi.md#unset_label) | **POST** {maven_maven_artifact_href}unset_label/ | Unset a label
105
105
  *PulpMavenClient::ContentArtifactApi* | [**upload**](docs/ContentArtifactApi.md#upload) | **POST** /pulp/api/v3/content/maven/artifact/upload/ | Upload a Maven artifact synchronously.
106
+ *PulpMavenClient::ContentMetadataApi* | [**create**](docs/ContentMetadataApi.md#create) | **POST** /pulp/api/v3/content/maven/metadata/ | Create a maven metadata
107
+ *PulpMavenClient::ContentMetadataApi* | [**list**](docs/ContentMetadataApi.md#list) | **GET** /pulp/api/v3/content/maven/metadata/ | List maven metadatas
108
+ *PulpMavenClient::ContentMetadataApi* | [**read**](docs/ContentMetadataApi.md#read) | **GET** {maven_maven_metadata_href} | Inspect a maven metadata
109
+ *PulpMavenClient::ContentMetadataApi* | [**set_label**](docs/ContentMetadataApi.md#set_label) | **POST** {maven_maven_metadata_href}set_label/ | Set a label
110
+ *PulpMavenClient::ContentMetadataApi* | [**unset_label**](docs/ContentMetadataApi.md#unset_label) | **POST** {maven_maven_metadata_href}unset_label/ | Unset a label
111
+ *PulpMavenClient::ContentMetadataApi* | [**upload**](docs/ContentMetadataApi.md#upload) | **POST** /pulp/api/v3/content/maven/metadata/upload/ | Upload a Maven metadata file synchronously.
106
112
  *PulpMavenClient::DistributionsMavenApi* | [**create**](docs/DistributionsMavenApi.md#create) | **POST** /pulp/api/v3/distributions/maven/maven/ | Create a maven distribution
107
113
  *PulpMavenClient::DistributionsMavenApi* | [**delete**](docs/DistributionsMavenApi.md#delete) | **DELETE** {maven_maven_distribution_href} | Delete a maven distribution
108
114
  *PulpMavenClient::DistributionsMavenApi* | [**list**](docs/DistributionsMavenApi.md#list) | **GET** /pulp/api/v3/distributions/maven/maven/ | List maven distributions
@@ -144,6 +150,7 @@ Class | Method | HTTP request | Description
144
150
  - [PulpMavenClient::MavenMavenArtifactResponse](docs/MavenMavenArtifactResponse.md)
145
151
  - [PulpMavenClient::MavenMavenDistribution](docs/MavenMavenDistribution.md)
146
152
  - [PulpMavenClient::MavenMavenDistributionResponse](docs/MavenMavenDistributionResponse.md)
153
+ - [PulpMavenClient::MavenMavenMetadataResponse](docs/MavenMavenMetadataResponse.md)
147
154
  - [PulpMavenClient::MavenMavenRemote](docs/MavenMavenRemote.md)
148
155
  - [PulpMavenClient::MavenMavenRemoteResponse](docs/MavenMavenRemoteResponse.md)
149
156
  - [PulpMavenClient::MavenMavenRemoteResponseHiddenFieldsInner](docs/MavenMavenRemoteResponseHiddenFieldsInner.md)
@@ -152,6 +159,7 @@ Class | Method | HTTP request | Description
152
159
  - [PulpMavenClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
153
160
  - [PulpMavenClient::PaginatedmavenMavenArtifactResponseList](docs/PaginatedmavenMavenArtifactResponseList.md)
154
161
  - [PulpMavenClient::PaginatedmavenMavenDistributionResponseList](docs/PaginatedmavenMavenDistributionResponseList.md)
162
+ - [PulpMavenClient::PaginatedmavenMavenMetadataResponseList](docs/PaginatedmavenMavenMetadataResponseList.md)
155
163
  - [PulpMavenClient::PaginatedmavenMavenRemoteResponseList](docs/PaginatedmavenMavenRemoteResponseList.md)
156
164
  - [PulpMavenClient::PaginatedmavenMavenRepositoryResponseList](docs/PaginatedmavenMavenRepositoryResponseList.md)
157
165
  - [PulpMavenClient::PatchedmavenMavenDistribution](docs/PatchedmavenMavenDistribution.md)
data/docs/ContentMetadataApi.md ADDED
@@ -0,0 +1,531 @@
1
+ # PulpMavenClient::ContentMetadataApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create**](ContentMetadataApi.md#create) | **POST** /pulp/api/v3/content/maven/metadata/ | Create a maven metadata |
8
+ | [**list**](ContentMetadataApi.md#list) | **GET** /pulp/api/v3/content/maven/metadata/ | List maven metadatas |
9
+ | [**read**](ContentMetadataApi.md#read) | **GET** {maven_maven_metadata_href} | Inspect a maven metadata |
10
+ | [**set_label**](ContentMetadataApi.md#set_label) | **POST** {maven_maven_metadata_href}set_label/ | Set a label |
11
+ | [**unset_label**](ContentMetadataApi.md#unset_label) | **POST** {maven_maven_metadata_href}unset_label/ | Unset a label |
12
+ | [**upload**](ContentMetadataApi.md#upload) | **POST** /pulp/api/v3/content/maven/metadata/upload/ | Upload a Maven metadata file synchronously. |
13
+
14
+
15
+ ## create
16
+
17
+ > <AsyncOperationResponse> create(relative_path, opts)
18
+
19
+ Create a maven metadata
20
+
21
+ Trigger an asynchronous task to create content,optionally create new repository version.
22
+
23
+ ### Examples
24
+
25
+ ```ruby
26
+ require 'time'
27
+ require 'pulp_maven_client'
28
+ # setup authorization
29
+ PulpMavenClient.configure do |config|
30
+ # Configure HTTP basic authorization: basicAuth
31
+ config.username = 'YOUR USERNAME'
32
+ config.password = 'YOUR PASSWORD'
33
+ end
34
+
35
+ api_instance = PulpMavenClient::ContentMetadataApi.new
36
+ relative_path = 'relative_path_example' # String | Path where the artifact is located relative to distributions base_path
37
+ opts = {
38
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
39
+ repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
40
+ overwrite: true, # Boolean | When set to true, existing content in the repository with the same unique key will be silently overwritten. When set to false, the task will fail if content would be overwritten. Only used when 'repository' is specified. Defaults to true.
41
+ pulp_labels: { key: 'inner_example'}, # Hash<String, String> | A dictionary of arbitrary key/value pairs used to describe a specific Content instance.
42
+ artifact: 'artifact_example', # String | Artifact file representing the physical content
43
+ file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
44
+ upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
45
+ file_url: 'file_url_example', # String | A url that Pulp can download and turn into the content unit.
46
+ downloader_config: PulpMavenClient::RemoteNetworkConfig.new # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.
47
+ }
48
+
49
+ begin
50
+ # Create a maven metadata
51
+ result = api_instance.create(relative_path, opts)
52
+ p result
53
+ rescue PulpMavenClient::ApiError => e
54
+ puts "Error when calling ContentMetadataApi->create: #{e}"
55
+ end
56
+ ```
57
+
58
+ #### Using the create_with_http_info variant
59
+
60
+ This returns an Array which contains the response data, status code and headers.
61
+
62
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(relative_path, opts)
63
+
64
+ ```ruby
65
+ begin
66
+ # Create a maven metadata
67
+ data, status_code, headers = api_instance.create_with_http_info(relative_path, opts)
68
+ p status_code # => 2xx
69
+ p headers # => { ... }
70
+ p data # => <AsyncOperationResponse>
71
+ rescue PulpMavenClient::ApiError => e
72
+ puts "Error when calling ContentMetadataApi->create_with_http_info: #{e}"
73
+ end
74
+ ```
75
+
76
+ ### Parameters
77
+
78
+ | Name | Type | Description | Notes |
79
+ | ---- | ---- | ----------- | ----- |
80
+ | **relative_path** | **String** | Path where the artifact is located relative to distributions base_path | |
81
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
82
+ | **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional] |
83
+ | **overwrite** | **Boolean** | When set to true, existing content in the repository with the same unique key will be silently overwritten. When set to false, the task will fail if content would be overwritten. Only used when &#39;repository&#39; is specified. Defaults to true. | [optional] |
84
+ | **pulp_labels** | [**Hash&lt;String, String&gt;**](Hash.md) | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
85
+ | **artifact** | **String** | Artifact file representing the physical content | [optional] |
86
+ | **file** | **File** | An uploaded file that may be turned into the content unit. | [optional] |
87
+ | **upload** | **String** | An uncommitted upload that may be turned into the content unit. | [optional] |
88
+ | **file_url** | **String** | A url that Pulp can download and turn into the content unit. | [optional] |
89
+ | **downloader_config** | [**RemoteNetworkConfig**](RemoteNetworkConfig.md) | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a &#39;file_url. | [optional] |
90
+
91
+ ### Return type
92
+
93
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
94
+
95
+ ### Authorization
96
+
97
+ [basicAuth](../README.md#basicAuth)
98
+
99
+ ### HTTP request headers
100
+
101
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
102
+ - **Accept**: application/json
103
+
104
+
105
+ ## list
106
+
107
+ > <PaginatedmavenMavenMetadataResponseList> list(opts)
108
+
109
+ List maven metadatas
110
+
111
+ A ViewSet for MavenMetadata.
112
+
113
+ ### Examples
114
+
115
+ ```ruby
116
+ require 'time'
117
+ require 'pulp_maven_client'
118
+ # setup authorization
119
+ PulpMavenClient.configure do |config|
120
+ # Configure HTTP basic authorization: basicAuth
121
+ config.username = 'YOUR USERNAME'
122
+ config.password = 'YOUR PASSWORD'
123
+ end
124
+
125
+ api_instance = PulpMavenClient::ContentMetadataApi.new
126
+ opts = {
127
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
128
+ artifact_id: 'artifact_id_example', # String | Filter results where artifact_id matches value
129
+ filename: 'filename_example', # String | Filter results where filename matches value
130
+ group_id: 'group_id_example', # String | Filter results where group_id matches value
131
+ limit: 56, # Integer | Number of results to return per page.
132
+ offset: 56, # Integer | The initial index from which to return the results.
133
+ ordering: ['-artifact_id'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `group_id` - Group id * `-group_id` - Group id (descending) * `artifact_id` - Artifact id * `-artifact_id` - Artifact id (descending) * `version` - Version * `-version` - Version (descending) * `filename` - Filename * `-filename` - Filename (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `pk` - Pk * `-pk` - Pk (descending)
134
+ orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
135
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
136
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
137
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
138
+ pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
139
+ q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
140
+ repository_version: 'repository_version_example', # String |
141
+ repository_version_added: 'repository_version_added_example', # String |
142
+ repository_version_removed: 'repository_version_removed_example', # String |
143
+ version: 'version_example', # String | Filter results where version matches value
144
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
145
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
146
+ }
147
+
148
+ begin
149
+ # List maven metadatas
150
+ result = api_instance.list(opts)
151
+ p result
152
+ rescue PulpMavenClient::ApiError => e
153
+ puts "Error when calling ContentMetadataApi->list: #{e}"
154
+ end
155
+ ```
156
+
157
+ #### Using the list_with_http_info variant
158
+
159
+ This returns an Array which contains the response data, status code and headers.
160
+
161
+ > <Array(<PaginatedmavenMavenMetadataResponseList>, Integer, Hash)> list_with_http_info(opts)
162
+
163
+ ```ruby
164
+ begin
165
+ # List maven metadatas
166
+ data, status_code, headers = api_instance.list_with_http_info(opts)
167
+ p status_code # => 2xx
168
+ p headers # => { ... }
169
+ p data # => <PaginatedmavenMavenMetadataResponseList>
170
+ rescue PulpMavenClient::ApiError => e
171
+ puts "Error when calling ContentMetadataApi->list_with_http_info: #{e}"
172
+ end
173
+ ```
174
+
175
+ ### Parameters
176
+
177
+ | Name | Type | Description | Notes |
178
+ | ---- | ---- | ----------- | ----- |
179
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
180
+ | **artifact_id** | **String** | Filter results where artifact_id matches value | [optional] |
181
+ | **filename** | **String** | Filter results where filename matches value | [optional] |
182
+ | **group_id** | **String** | Filter results where group_id matches value | [optional] |
183
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
184
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
185
+ | **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;group_id&#x60; - Group id * &#x60;-group_id&#x60; - Group id (descending) * &#x60;artifact_id&#x60; - Artifact id * &#x60;-artifact_id&#x60; - Artifact id (descending) * &#x60;version&#x60; - Version * &#x60;-version&#x60; - Version (descending) * &#x60;filename&#x60; - Filename * &#x60;-filename&#x60; - Filename (descending) * &#x60;sha256&#x60; - Sha256 * &#x60;-sha256&#x60; - Sha256 (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
186
+ | **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
187
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
188
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
189
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
190
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
191
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
192
+ | **repository_version** | **String** | | [optional] |
193
+ | **repository_version_added** | **String** | | [optional] |
194
+ | **repository_version_removed** | **String** | | [optional] |
195
+ | **version** | **String** | Filter results where version matches value | [optional] |
196
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
197
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
198
+
199
+ ### Return type
200
+
201
+ [**PaginatedmavenMavenMetadataResponseList**](PaginatedmavenMavenMetadataResponseList.md)
202
+
203
+ ### Authorization
204
+
205
+ [basicAuth](../README.md#basicAuth)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: Not defined
210
+ - **Accept**: application/json
211
+
212
+
213
+ ## read
214
+
215
+ > <MavenMavenMetadataResponse> read(maven_maven_metadata_href, opts)
216
+
217
+ Inspect a maven metadata
218
+
219
+ A ViewSet for MavenMetadata.
220
+
221
+ ### Examples
222
+
223
+ ```ruby
224
+ require 'time'
225
+ require 'pulp_maven_client'
226
+ # setup authorization
227
+ PulpMavenClient.configure do |config|
228
+ # Configure HTTP basic authorization: basicAuth
229
+ config.username = 'YOUR USERNAME'
230
+ config.password = 'YOUR PASSWORD'
231
+ end
232
+
233
+ api_instance = PulpMavenClient::ContentMetadataApi.new
234
+ maven_maven_metadata_href = 'maven_maven_metadata_href_example' # String |
235
+ opts = {
236
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
237
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
238
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
239
+ }
240
+
241
+ begin
242
+ # Inspect a maven metadata
243
+ result = api_instance.read(maven_maven_metadata_href, opts)
244
+ p result
245
+ rescue PulpMavenClient::ApiError => e
246
+ puts "Error when calling ContentMetadataApi->read: #{e}"
247
+ end
248
+ ```
249
+
250
+ #### Using the read_with_http_info variant
251
+
252
+ This returns an Array which contains the response data, status code and headers.
253
+
254
+ > <Array(<MavenMavenMetadataResponse>, Integer, Hash)> read_with_http_info(maven_maven_metadata_href, opts)
255
+
256
+ ```ruby
257
+ begin
258
+ # Inspect a maven metadata
259
+ data, status_code, headers = api_instance.read_with_http_info(maven_maven_metadata_href, opts)
260
+ p status_code # => 2xx
261
+ p headers # => { ... }
262
+ p data # => <MavenMavenMetadataResponse>
263
+ rescue PulpMavenClient::ApiError => e
264
+ puts "Error when calling ContentMetadataApi->read_with_http_info: #{e}"
265
+ end
266
+ ```
267
+
268
+ ### Parameters
269
+
270
+ | Name | Type | Description | Notes |
271
+ | ---- | ---- | ----------- | ----- |
272
+ | **maven_maven_metadata_href** | **String** | | |
273
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
274
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
275
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
276
+
277
+ ### Return type
278
+
279
+ [**MavenMavenMetadataResponse**](MavenMavenMetadataResponse.md)
280
+
281
+ ### Authorization
282
+
283
+ [basicAuth](../README.md#basicAuth)
284
+
285
+ ### HTTP request headers
286
+
287
+ - **Content-Type**: Not defined
288
+ - **Accept**: application/json
289
+
290
+
291
+ ## set_label
292
+
293
+ > <SetLabelResponse> set_label(maven_maven_metadata_href, set_label, opts)
294
+
295
+ Set a label
296
+
297
+ Set a single pulp_label on the object to a specific value or null.
298
+
299
+ ### Examples
300
+
301
+ ```ruby
302
+ require 'time'
303
+ require 'pulp_maven_client'
304
+ # setup authorization
305
+ PulpMavenClient.configure do |config|
306
+ # Configure HTTP basic authorization: basicAuth
307
+ config.username = 'YOUR USERNAME'
308
+ config.password = 'YOUR PASSWORD'
309
+ end
310
+
311
+ api_instance = PulpMavenClient::ContentMetadataApi.new
312
+ maven_maven_metadata_href = 'maven_maven_metadata_href_example' # String |
313
+ set_label = PulpMavenClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
314
+ opts = {
315
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
316
+ }
317
+
318
+ begin
319
+ # Set a label
320
+ result = api_instance.set_label(maven_maven_metadata_href, set_label, opts)
321
+ p result
322
+ rescue PulpMavenClient::ApiError => e
323
+ puts "Error when calling ContentMetadataApi->set_label: #{e}"
324
+ end
325
+ ```
326
+
327
+ #### Using the set_label_with_http_info variant
328
+
329
+ This returns an Array which contains the response data, status code and headers.
330
+
331
+ > <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(maven_maven_metadata_href, set_label, opts)
332
+
333
+ ```ruby
334
+ begin
335
+ # Set a label
336
+ data, status_code, headers = api_instance.set_label_with_http_info(maven_maven_metadata_href, set_label, opts)
337
+ p status_code # => 2xx
338
+ p headers # => { ... }
339
+ p data # => <SetLabelResponse>
340
+ rescue PulpMavenClient::ApiError => e
341
+ puts "Error when calling ContentMetadataApi->set_label_with_http_info: #{e}"
342
+ end
343
+ ```
344
+
345
+ ### Parameters
346
+
347
+ | Name | Type | Description | Notes |
348
+ | ---- | ---- | ----------- | ----- |
349
+ | **maven_maven_metadata_href** | **String** | | |
350
+ | **set_label** | [**SetLabel**](SetLabel.md) | | |
351
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
352
+
353
+ ### Return type
354
+
355
+ [**SetLabelResponse**](SetLabelResponse.md)
356
+
357
+ ### Authorization
358
+
359
+ [basicAuth](../README.md#basicAuth)
360
+
361
+ ### HTTP request headers
362
+
363
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
364
+ - **Accept**: application/json
365
+
366
+
367
+ ## unset_label
368
+
369
+ > <UnsetLabelResponse> unset_label(maven_maven_metadata_href, unset_label, opts)
370
+
371
+ Unset a label
372
+
373
+ Unset a single pulp_label on the object.
374
+
375
+ ### Examples
376
+
377
+ ```ruby
378
+ require 'time'
379
+ require 'pulp_maven_client'
380
+ # setup authorization
381
+ PulpMavenClient.configure do |config|
382
+ # Configure HTTP basic authorization: basicAuth
383
+ config.username = 'YOUR USERNAME'
384
+ config.password = 'YOUR PASSWORD'
385
+ end
386
+
387
+ api_instance = PulpMavenClient::ContentMetadataApi.new
388
+ maven_maven_metadata_href = 'maven_maven_metadata_href_example' # String |
389
+ unset_label = PulpMavenClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
390
+ opts = {
391
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
392
+ }
393
+
394
+ begin
395
+ # Unset a label
396
+ result = api_instance.unset_label(maven_maven_metadata_href, unset_label, opts)
397
+ p result
398
+ rescue PulpMavenClient::ApiError => e
399
+ puts "Error when calling ContentMetadataApi->unset_label: #{e}"
400
+ end
401
+ ```
402
+
403
+ #### Using the unset_label_with_http_info variant
404
+
405
+ This returns an Array which contains the response data, status code and headers.
406
+
407
+ > <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(maven_maven_metadata_href, unset_label, opts)
408
+
409
+ ```ruby
410
+ begin
411
+ # Unset a label
412
+ data, status_code, headers = api_instance.unset_label_with_http_info(maven_maven_metadata_href, unset_label, opts)
413
+ p status_code # => 2xx
414
+ p headers # => { ... }
415
+ p data # => <UnsetLabelResponse>
416
+ rescue PulpMavenClient::ApiError => e
417
+ puts "Error when calling ContentMetadataApi->unset_label_with_http_info: #{e}"
418
+ end
419
+ ```
420
+
421
+ ### Parameters
422
+
423
+ | Name | Type | Description | Notes |
424
+ | ---- | ---- | ----------- | ----- |
425
+ | **maven_maven_metadata_href** | **String** | | |
426
+ | **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
427
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
428
+
429
+ ### Return type
430
+
431
+ [**UnsetLabelResponse**](UnsetLabelResponse.md)
432
+
433
+ ### Authorization
434
+
435
+ [basicAuth](../README.md#basicAuth)
436
+
437
+ ### HTTP request headers
438
+
439
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
440
+ - **Accept**: application/json
441
+
442
+
443
+ ## upload
444
+
445
+ > <MavenMavenMetadataResponse> upload(relative_path, opts)
446
+
447
+ Upload a Maven metadata file synchronously.
448
+
449
+ Synchronously upload a Maven metadata file.
450
+
451
+ ### Examples
452
+
453
+ ```ruby
454
+ require 'time'
455
+ require 'pulp_maven_client'
456
+ # setup authorization
457
+ PulpMavenClient.configure do |config|
458
+ # Configure HTTP basic authorization: basicAuth
459
+ config.username = 'YOUR USERNAME'
460
+ config.password = 'YOUR PASSWORD'
461
+ end
462
+
463
+ api_instance = PulpMavenClient::ContentMetadataApi.new
464
+ relative_path = 'relative_path_example' # String | Path where the artifact is located relative to distributions base_path
465
+ opts = {
466
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
467
+ repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
468
+ overwrite: true, # Boolean | When set to true, existing content in the repository with the same unique key will be silently overwritten. When set to false, the task will fail if content would be overwritten. Only used when 'repository' is specified. Defaults to true.
469
+ pulp_labels: { key: 'inner_example'}, # Hash<String, String> | A dictionary of arbitrary key/value pairs used to describe a specific Content instance.
470
+ artifact: 'artifact_example', # String | Artifact file representing the physical content
471
+ file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
472
+ upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
473
+ file_url: 'file_url_example', # String | A url that Pulp can download and turn into the content unit.
474
+ downloader_config: PulpMavenClient::RemoteNetworkConfig.new # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.
475
+ }
476
+
477
+ begin
478
+ # Upload a Maven metadata file synchronously.
479
+ result = api_instance.upload(relative_path, opts)
480
+ p result
481
+ rescue PulpMavenClient::ApiError => e
482
+ puts "Error when calling ContentMetadataApi->upload: #{e}"
483
+ end
484
+ ```
485
+
486
+ #### Using the upload_with_http_info variant
487
+
488
+ This returns an Array which contains the response data, status code and headers.
489
+
490
+ > <Array(<MavenMavenMetadataResponse>, Integer, Hash)> upload_with_http_info(relative_path, opts)
491
+
492
+ ```ruby
493
+ begin
494
+ # Upload a Maven metadata file synchronously.
495
+ data, status_code, headers = api_instance.upload_with_http_info(relative_path, opts)
496
+ p status_code # => 2xx
497
+ p headers # => { ... }
498
+ p data # => <MavenMavenMetadataResponse>
499
+ rescue PulpMavenClient::ApiError => e
500
+ puts "Error when calling ContentMetadataApi->upload_with_http_info: #{e}"
501
+ end
502
+ ```
503
+
504
+ ### Parameters
505
+
506
+ | Name | Type | Description | Notes |
507
+ | ---- | ---- | ----------- | ----- |
508
+ | **relative_path** | **String** | Path where the artifact is located relative to distributions base_path | |
509
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
510
+ | **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional] |
511
+ | **overwrite** | **Boolean** | When set to true, existing content in the repository with the same unique key will be silently overwritten. When set to false, the task will fail if content would be overwritten. Only used when &#39;repository&#39; is specified. Defaults to true. | [optional] |
512
+ | **pulp_labels** | [**Hash&lt;String, String&gt;**](Hash.md) | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
513
+ | **artifact** | **String** | Artifact file representing the physical content | [optional] |
514
+ | **file** | **File** | An uploaded file that may be turned into the content unit. | [optional] |
515
+ | **upload** | **String** | An uncommitted upload that may be turned into the content unit. | [optional] |
516
+ | **file_url** | **String** | A url that Pulp can download and turn into the content unit. | [optional] |
517
+ | **downloader_config** | [**RemoteNetworkConfig**](RemoteNetworkConfig.md) | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a &#39;file_url. | [optional] |
518
+
519
+ ### Return type
520
+
521
+ [**MavenMavenMetadataResponse**](MavenMavenMetadataResponse.md)
522
+
523
+ ### Authorization
524
+
525
+ [basicAuth](../README.md#basicAuth)
526
+
527
+ ### HTTP request headers
528
+
529
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
530
+ - **Accept**: application/json
531
+
data/docs/MavenMavenMetadataResponse.md ADDED
@@ -0,0 +1,40 @@
1
+ # PulpMavenClient::MavenMavenMetadataResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **pulp_href** | **String** | | [optional][readonly] |
8
+ | **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
9
+ | **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
10
+ | **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
11
+ | **pulp_labels** | **Hash&lt;String, String&gt;** | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
12
+ | **vuln_report** | **String** | | [optional][readonly] |
13
+ | **artifact** | **String** | Artifact file representing the physical content | [optional] |
14
+ | **group_id** | **String** | Group Id of the metadata&#39;s package. | [optional][readonly] |
15
+ | **artifact_id** | **String** | Artifact Id of the metadata&#39;s package. | [optional][readonly] |
16
+ | **version** | **String** | Version of the metadata&#39;s package. | [optional][readonly] |
17
+ | **filename** | **String** | Filename of the metadata. | [optional][readonly] |
18
+ | **sha256** | **String** | SHA256 digest of the metadata. | [optional][readonly] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'pulp_maven_client'
24
+
25
+ instance = PulpMavenClient::MavenMavenMetadataResponse.new(
26
+ pulp_href: null,
27
+ prn: null,
28
+ pulp_created: null,
29
+ pulp_last_updated: null,
30
+ pulp_labels: null,
31
+ vuln_report: null,
32
+ artifact: null,
33
+ group_id: null,
34
+ artifact_id: null,
35
+ version: null,
36
+ filename: null,
37
+ sha256: null
38
+ )
39
+ ```
40
+
data/docs/PaginatedmavenMavenMetadataResponseList.md ADDED
@@ -0,0 +1,24 @@
1
+ # PulpMavenClient::PaginatedmavenMavenMetadataResponseList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | | |
8
+ | **_next** | **String** | | [optional] |
9
+ | **previous** | **String** | | [optional] |
10
+ | **results** | [**Array&lt;MavenMavenMetadataResponse&gt;**](MavenMavenMetadataResponse.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pulp_maven_client'
16
+
17
+ instance = PulpMavenClient::PaginatedmavenMavenMetadataResponseList.new(
18
+ count: 123,
19
+ _next: http://api.example.org/accounts/?offset&#x3D;400&amp;limit&#x3D;100,
20
+ previous: http://api.example.org/accounts/?offset&#x3D;200&amp;limit&#x3D;100,
21
+ results: null
22
+ )
23
+ ```
24
+