pulpcore_client 3.71.2 → 3.72.1
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 +6 -4
- data/docs/ArtifactDistributionResponse.md +15 -15
- data/docs/Domain.md +2 -0
- data/docs/DomainResponse.md +2 -0
- data/docs/DomainsApi.md +150 -2
- data/docs/PatchedDomain.md +2 -0
- data/lib/pulpcore_client/api/domains_api.rb +154 -3
- data/lib/pulpcore_client/models/artifact_distribution_response.rb +67 -67
- data/lib/pulpcore_client/models/domain.rb +12 -1
- data/lib/pulpcore_client/models/domain_response.rb +12 -1
- data/lib/pulpcore_client/models/patched_domain.rb +12 -1
- data/lib/pulpcore_client/version.rb +1 -1
- data/spec/api/domains_api_spec.rb +28 -1
- data/spec/models/artifact_distribution_response_spec.rb +9 -9
- data/spec/models/domain_response_spec.rb +6 -0
- data/spec/models/domain_spec.rb +6 -0
- data/spec/models/patched_domain_spec.rb +6 -0
- metadata +187 -187
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b6028ed37250f6055cd210be4ba77c8d8916075650dacd9fc5dd97c9587a32fa
|
|
4
|
+
data.tar.gz: '096b713241c5da21f8f09cb53d3602849d4b1562047a34a48f0c041e50bfcaab'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 70a0a621fc5b24e774968a6ef2a0fe68ad89e1e42525987eb40055b97407eb043bd0532e2ba501acc6952958f24767fd81fb0c92efa902543eb7702068f49402
|
|
7
|
+
data.tar.gz: ea10cd14a160aa1757ea227f23a8e4587448abb7d9748142d53fef7e65a58da3b7cd9da0c43449d73f4bd6b4cc6c0b88a1dfb17c147bf5a10241ebdc256fd593
|
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: 3.
|
|
10
|
+
- Package version: 3.72.1
|
|
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 pulpcore_client.gemspec
|
|
|
25
25
|
Then either install the gem locally:
|
|
26
26
|
|
|
27
27
|
```shell
|
|
28
|
-
gem install ./pulpcore_client-3.
|
|
28
|
+
gem install ./pulpcore_client-3.72.1.gem
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
(for development, run `gem install --dev ./pulpcore_client-3.
|
|
31
|
+
(for development, run `gem install --dev ./pulpcore_client-3.72.1.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 'pulpcore_client', '~> 3.
|
|
37
|
+
gem 'pulpcore_client', '~> 3.72.1'
|
|
38
38
|
|
|
39
39
|
### Install from Git
|
|
40
40
|
|
|
@@ -185,6 +185,8 @@ Class | Method | HTTP request | Description
|
|
|
185
185
|
*PulpcoreClient::DomainsApi* | [**migrate**](docs/DomainsApi.md#migrate) | **POST** /pulp/api/v3/domains/migrate/ | Migrate storage backend
|
|
186
186
|
*PulpcoreClient::DomainsApi* | [**partial_update**](docs/DomainsApi.md#partial_update) | **PATCH** {domain_href} | Update a domain
|
|
187
187
|
*PulpcoreClient::DomainsApi* | [**read**](docs/DomainsApi.md#read) | **GET** {domain_href} | Inspect a domain
|
|
188
|
+
*PulpcoreClient::DomainsApi* | [**set_label**](docs/DomainsApi.md#set_label) | **POST** {domain_href}set_label/ | Set a label
|
|
189
|
+
*PulpcoreClient::DomainsApi* | [**unset_label**](docs/DomainsApi.md#unset_label) | **POST** {domain_href}unset_label/ | Unset a label
|
|
188
190
|
*PulpcoreClient::DomainsApi* | [**update**](docs/DomainsApi.md#update) | **PUT** {domain_href} | Update a domain
|
|
189
191
|
*PulpcoreClient::ExportersFilesystemApi* | [**create**](docs/ExportersFilesystemApi.md#create) | **POST** /pulp/api/v3/exporters/core/filesystem/ | Create a filesystem exporter
|
|
190
192
|
*PulpcoreClient::ExportersFilesystemApi* | [**delete**](docs/ExportersFilesystemApi.md#delete) | **DELETE** {filesystem_exporter_href} | Delete a filesystem exporter
|
|
@@ -4,17 +4,17 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
|
|
8
|
-
| **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | |
|
|
9
|
-
| **no_content_change_since** | **String** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [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
7
|
| **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | |
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
8
|
+
| **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | |
|
|
9
|
+
| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
|
|
14
10
|
| **pulp_labels** | **Hash<String, String>** | | [optional] |
|
|
15
|
-
| **base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional][readonly] |
|
|
16
11
|
| **pulp_href** | **String** | | [optional][readonly] |
|
|
12
|
+
| **hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional][default to false] |
|
|
13
|
+
| **content_guard** | **String** | An optional content-guard. | [optional] |
|
|
17
14
|
| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
|
|
15
|
+
| **base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional][readonly] |
|
|
16
|
+
| **no_content_change_since** | **String** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [optional][readonly] |
|
|
17
|
+
| **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] |
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -22,17 +22,17 @@
|
|
|
22
22
|
require 'pulpcore_client'
|
|
23
23
|
|
|
24
24
|
instance = PulpcoreClient::ArtifactDistributionResponse.new(
|
|
25
|
-
pulp_created: null,
|
|
26
|
-
name: null,
|
|
27
|
-
no_content_change_since: null,
|
|
28
|
-
pulp_last_updated: null,
|
|
29
25
|
base_path: null,
|
|
30
|
-
|
|
31
|
-
|
|
26
|
+
name: null,
|
|
27
|
+
pulp_created: null,
|
|
32
28
|
pulp_labels: null,
|
|
33
|
-
base_url: null,
|
|
34
29
|
pulp_href: null,
|
|
35
|
-
|
|
30
|
+
hidden: null,
|
|
31
|
+
content_guard: null,
|
|
32
|
+
prn: null,
|
|
33
|
+
base_url: null,
|
|
34
|
+
no_content_change_since: null,
|
|
35
|
+
pulp_last_updated: null
|
|
36
36
|
)
|
|
37
37
|
```
|
|
38
38
|
|
data/docs/Domain.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | A name for this domain. | |
|
|
8
8
|
| **description** | **String** | An optional description. | [optional] |
|
|
9
|
+
| **pulp_labels** | **Hash<String, String>** | | [optional] |
|
|
9
10
|
| **storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage | |
|
|
10
11
|
| **storage_settings** | **Object** | Settings for storage class. | |
|
|
11
12
|
| **redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional][default to true] |
|
|
@@ -19,6 +20,7 @@ require 'pulpcore_client'
|
|
|
19
20
|
instance = PulpcoreClient::Domain.new(
|
|
20
21
|
name: null,
|
|
21
22
|
description: null,
|
|
23
|
+
pulp_labels: null,
|
|
22
24
|
storage_class: null,
|
|
23
25
|
storage_settings: null,
|
|
24
26
|
redirect_to_object_storage: null,
|
data/docs/DomainResponse.md
CHANGED
|
@@ -10,6 +10,7 @@
|
|
|
10
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
11
|
| **name** | **String** | A name for this domain. | |
|
|
12
12
|
| **description** | **String** | An optional description. | [optional] |
|
|
13
|
+
| **pulp_labels** | **Hash<String, String>** | | [optional] |
|
|
13
14
|
| **storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage | |
|
|
14
15
|
| **storage_settings** | **Object** | Settings for storage class. | |
|
|
15
16
|
| **redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional][default to true] |
|
|
@@ -27,6 +28,7 @@ instance = PulpcoreClient::DomainResponse.new(
|
|
|
27
28
|
pulp_last_updated: null,
|
|
28
29
|
name: null,
|
|
29
30
|
description: null,
|
|
31
|
+
pulp_labels: null,
|
|
30
32
|
storage_class: null,
|
|
31
33
|
storage_settings: null,
|
|
32
34
|
redirect_to_object_storage: null,
|
data/docs/DomainsApi.md
CHANGED
|
@@ -10,6 +10,8 @@ All URIs are relative to *http://localhost:24817*
|
|
|
10
10
|
| [**migrate**](DomainsApi.md#migrate) | **POST** /pulp/api/v3/domains/migrate/ | Migrate storage backend |
|
|
11
11
|
| [**partial_update**](DomainsApi.md#partial_update) | **PATCH** {domain_href} | Update a domain |
|
|
12
12
|
| [**read**](DomainsApi.md#read) | **GET** {domain_href} | Inspect a domain |
|
|
13
|
+
| [**set_label**](DomainsApi.md#set_label) | **POST** {domain_href}set_label/ | Set a label |
|
|
14
|
+
| [**unset_label**](DomainsApi.md#unset_label) | **POST** {domain_href}unset_label/ | Unset a label |
|
|
13
15
|
| [**update**](DomainsApi.md#update) | **PUT** {domain_href} | Update a domain |
|
|
14
16
|
|
|
15
17
|
|
|
@@ -186,10 +188,11 @@ opts = {
|
|
|
186
188
|
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
|
187
189
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
|
188
190
|
offset: 56, # Integer | The initial index from which to return the results.
|
|
189
|
-
ordering: ['-description'], # 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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
|
191
|
+
ordering: ['-description'], # 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
|
190
192
|
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
|
191
193
|
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
|
192
194
|
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
|
195
|
+
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
|
193
196
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
|
194
197
|
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
|
195
198
|
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
|
@@ -237,10 +240,11 @@ end
|
|
|
237
240
|
| **name__regex** | **String** | Filter results where name matches regex value | [optional] |
|
|
238
241
|
| **name__startswith** | **String** | Filter results where name starts with value | [optional] |
|
|
239
242
|
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
|
240
|
-
| **ordering** | [**Array<String>**](String.md) | 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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
|
243
|
+
| **ordering** | [**Array<String>**](String.md) | 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
|
241
244
|
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
|
242
245
|
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
|
243
246
|
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
|
247
|
+
| **pulp_label_select** | **String** | Filter labels by search string | [optional] |
|
|
244
248
|
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
|
245
249
|
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
|
246
250
|
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
|
@@ -477,6 +481,150 @@ end
|
|
|
477
481
|
- **Accept**: application/json
|
|
478
482
|
|
|
479
483
|
|
|
484
|
+
## set_label
|
|
485
|
+
|
|
486
|
+
> <SetLabelResponse> set_label(domain_href, set_label)
|
|
487
|
+
|
|
488
|
+
Set a label
|
|
489
|
+
|
|
490
|
+
Set a single pulp_label on the object to a specific value or null.
|
|
491
|
+
|
|
492
|
+
### Examples
|
|
493
|
+
|
|
494
|
+
```ruby
|
|
495
|
+
require 'time'
|
|
496
|
+
require 'pulpcore_client'
|
|
497
|
+
# setup authorization
|
|
498
|
+
PulpcoreClient.configure do |config|
|
|
499
|
+
# Configure HTTP basic authorization: basicAuth
|
|
500
|
+
config.username = 'YOUR USERNAME'
|
|
501
|
+
config.password = 'YOUR PASSWORD'
|
|
502
|
+
end
|
|
503
|
+
|
|
504
|
+
api_instance = PulpcoreClient::DomainsApi.new
|
|
505
|
+
domain_href = 'domain_href_example' # String |
|
|
506
|
+
set_label = PulpcoreClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
|
507
|
+
|
|
508
|
+
begin
|
|
509
|
+
# Set a label
|
|
510
|
+
result = api_instance.set_label(domain_href, set_label)
|
|
511
|
+
p result
|
|
512
|
+
rescue PulpcoreClient::ApiError => e
|
|
513
|
+
puts "Error when calling DomainsApi->set_label: #{e}"
|
|
514
|
+
end
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
#### Using the set_label_with_http_info variant
|
|
518
|
+
|
|
519
|
+
This returns an Array which contains the response data, status code and headers.
|
|
520
|
+
|
|
521
|
+
> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(domain_href, set_label)
|
|
522
|
+
|
|
523
|
+
```ruby
|
|
524
|
+
begin
|
|
525
|
+
# Set a label
|
|
526
|
+
data, status_code, headers = api_instance.set_label_with_http_info(domain_href, set_label)
|
|
527
|
+
p status_code # => 2xx
|
|
528
|
+
p headers # => { ... }
|
|
529
|
+
p data # => <SetLabelResponse>
|
|
530
|
+
rescue PulpcoreClient::ApiError => e
|
|
531
|
+
puts "Error when calling DomainsApi->set_label_with_http_info: #{e}"
|
|
532
|
+
end
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
### Parameters
|
|
536
|
+
|
|
537
|
+
| Name | Type | Description | Notes |
|
|
538
|
+
| ---- | ---- | ----------- | ----- |
|
|
539
|
+
| **domain_href** | **String** | | |
|
|
540
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
|
541
|
+
|
|
542
|
+
### Return type
|
|
543
|
+
|
|
544
|
+
[**SetLabelResponse**](SetLabelResponse.md)
|
|
545
|
+
|
|
546
|
+
### Authorization
|
|
547
|
+
|
|
548
|
+
[basicAuth](../README.md#basicAuth)
|
|
549
|
+
|
|
550
|
+
### HTTP request headers
|
|
551
|
+
|
|
552
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
553
|
+
- **Accept**: application/json
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
## unset_label
|
|
557
|
+
|
|
558
|
+
> <UnsetLabelResponse> unset_label(domain_href, unset_label)
|
|
559
|
+
|
|
560
|
+
Unset a label
|
|
561
|
+
|
|
562
|
+
Unset a single pulp_label on the object.
|
|
563
|
+
|
|
564
|
+
### Examples
|
|
565
|
+
|
|
566
|
+
```ruby
|
|
567
|
+
require 'time'
|
|
568
|
+
require 'pulpcore_client'
|
|
569
|
+
# setup authorization
|
|
570
|
+
PulpcoreClient.configure do |config|
|
|
571
|
+
# Configure HTTP basic authorization: basicAuth
|
|
572
|
+
config.username = 'YOUR USERNAME'
|
|
573
|
+
config.password = 'YOUR PASSWORD'
|
|
574
|
+
end
|
|
575
|
+
|
|
576
|
+
api_instance = PulpcoreClient::DomainsApi.new
|
|
577
|
+
domain_href = 'domain_href_example' # String |
|
|
578
|
+
unset_label = PulpcoreClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
|
579
|
+
|
|
580
|
+
begin
|
|
581
|
+
# Unset a label
|
|
582
|
+
result = api_instance.unset_label(domain_href, unset_label)
|
|
583
|
+
p result
|
|
584
|
+
rescue PulpcoreClient::ApiError => e
|
|
585
|
+
puts "Error when calling DomainsApi->unset_label: #{e}"
|
|
586
|
+
end
|
|
587
|
+
```
|
|
588
|
+
|
|
589
|
+
#### Using the unset_label_with_http_info variant
|
|
590
|
+
|
|
591
|
+
This returns an Array which contains the response data, status code and headers.
|
|
592
|
+
|
|
593
|
+
> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(domain_href, unset_label)
|
|
594
|
+
|
|
595
|
+
```ruby
|
|
596
|
+
begin
|
|
597
|
+
# Unset a label
|
|
598
|
+
data, status_code, headers = api_instance.unset_label_with_http_info(domain_href, unset_label)
|
|
599
|
+
p status_code # => 2xx
|
|
600
|
+
p headers # => { ... }
|
|
601
|
+
p data # => <UnsetLabelResponse>
|
|
602
|
+
rescue PulpcoreClient::ApiError => e
|
|
603
|
+
puts "Error when calling DomainsApi->unset_label_with_http_info: #{e}"
|
|
604
|
+
end
|
|
605
|
+
```
|
|
606
|
+
|
|
607
|
+
### Parameters
|
|
608
|
+
|
|
609
|
+
| Name | Type | Description | Notes |
|
|
610
|
+
| ---- | ---- | ----------- | ----- |
|
|
611
|
+
| **domain_href** | **String** | | |
|
|
612
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
|
613
|
+
|
|
614
|
+
### Return type
|
|
615
|
+
|
|
616
|
+
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
|
617
|
+
|
|
618
|
+
### Authorization
|
|
619
|
+
|
|
620
|
+
[basicAuth](../README.md#basicAuth)
|
|
621
|
+
|
|
622
|
+
### HTTP request headers
|
|
623
|
+
|
|
624
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
625
|
+
- **Accept**: application/json
|
|
626
|
+
|
|
627
|
+
|
|
480
628
|
## update
|
|
481
629
|
|
|
482
630
|
> <AsyncOperationResponse> update(domain_href, domain)
|
data/docs/PatchedDomain.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | A name for this domain. | [optional] |
|
|
8
8
|
| **description** | **String** | An optional description. | [optional] |
|
|
9
|
+
| **pulp_labels** | **Hash<String, String>** | | [optional] |
|
|
9
10
|
| **storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage | [optional] |
|
|
10
11
|
| **storage_settings** | **Object** | Settings for storage class. | [optional] |
|
|
11
12
|
| **redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional][default to true] |
|
|
@@ -19,6 +20,7 @@ require 'pulpcore_client'
|
|
|
19
20
|
instance = PulpcoreClient::PatchedDomain.new(
|
|
20
21
|
name: null,
|
|
21
22
|
description: null,
|
|
23
|
+
pulp_labels: null,
|
|
22
24
|
storage_class: null,
|
|
23
25
|
storage_settings: null,
|
|
24
26
|
redirect_to_object_storage: null,
|
|
@@ -164,10 +164,11 @@ module PulpcoreClient
|
|
|
164
164
|
# @option opts [String] :name__regex Filter results where name matches regex value
|
|
165
165
|
# @option opts [String] :name__startswith Filter results where name starts with value
|
|
166
166
|
# @option opts [Integer] :offset The initial index from which to return the results.
|
|
167
|
-
# @option opts [Array<String>] :ordering 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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
|
167
|
+
# @option opts [Array<String>] :ordering 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
|
168
168
|
# @option opts [Array<String>] :prn__in Multiple values may be separated by commas.
|
|
169
169
|
# @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
|
|
170
170
|
# @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
|
|
171
|
+
# @option opts [String] :pulp_label_select Filter labels by search string
|
|
171
172
|
# @option opts [String] :q Filter results by using NOT, AND and OR operations on other filters
|
|
172
173
|
# @option opts [Array<String>] :fields A list of fields to include in the response.
|
|
173
174
|
# @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
|
|
@@ -191,10 +192,11 @@ module PulpcoreClient
|
|
|
191
192
|
# @option opts [String] :name__regex Filter results where name matches regex value
|
|
192
193
|
# @option opts [String] :name__startswith Filter results where name starts with value
|
|
193
194
|
# @option opts [Integer] :offset The initial index from which to return the results.
|
|
194
|
-
# @option opts [Array<String>] :ordering 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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
|
195
|
+
# @option opts [Array<String>] :ordering 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
|
195
196
|
# @option opts [Array<String>] :prn__in Multiple values may be separated by commas.
|
|
196
197
|
# @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
|
|
197
198
|
# @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
|
|
199
|
+
# @option opts [String] :pulp_label_select Filter labels by search string
|
|
198
200
|
# @option opts [String] :q Filter results by using NOT, AND and OR operations on other filters
|
|
199
201
|
# @option opts [Array<String>] :fields A list of fields to include in the response.
|
|
200
202
|
# @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
|
|
@@ -203,7 +205,7 @@ module PulpcoreClient
|
|
|
203
205
|
if @api_client.config.debugging
|
|
204
206
|
@api_client.config.logger.debug 'Calling API: DomainsApi.list ...'
|
|
205
207
|
end
|
|
206
|
-
allowable_values = ["-description", "-hide_guarded_distributions", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-redirect_to_object_storage", "-storage_class", "-storage_settings", "description", "hide_guarded_distributions", "name", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "redirect_to_object_storage", "storage_class", "storage_settings"]
|
|
208
|
+
allowable_values = ["-description", "-hide_guarded_distributions", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-redirect_to_object_storage", "-storage_class", "-storage_settings", "description", "hide_guarded_distributions", "name", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "redirect_to_object_storage", "storage_class", "storage_settings"]
|
|
207
209
|
if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
|
|
208
210
|
fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
|
|
209
211
|
end
|
|
@@ -227,6 +229,7 @@ module PulpcoreClient
|
|
|
227
229
|
query_params[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].nil?
|
|
228
230
|
query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
|
|
229
231
|
query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
|
|
232
|
+
query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
|
|
230
233
|
query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
|
|
231
234
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
|
|
232
235
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?
|
|
@@ -476,6 +479,154 @@ module PulpcoreClient
|
|
|
476
479
|
return data, status_code, headers
|
|
477
480
|
end
|
|
478
481
|
|
|
482
|
+
# Set a label
|
|
483
|
+
# Set a single pulp_label on the object to a specific value or null.
|
|
484
|
+
# @param domain_href [String]
|
|
485
|
+
# @param set_label [SetLabel]
|
|
486
|
+
# @param [Hash] opts the optional parameters
|
|
487
|
+
# @return [SetLabelResponse]
|
|
488
|
+
def set_label(domain_href, set_label, opts = {})
|
|
489
|
+
data, _status_code, _headers = set_label_with_http_info(domain_href, set_label, opts)
|
|
490
|
+
data
|
|
491
|
+
end
|
|
492
|
+
|
|
493
|
+
# Set a label
|
|
494
|
+
# Set a single pulp_label on the object to a specific value or null.
|
|
495
|
+
# @param domain_href [String]
|
|
496
|
+
# @param set_label [SetLabel]
|
|
497
|
+
# @param [Hash] opts the optional parameters
|
|
498
|
+
# @return [Array<(SetLabelResponse, Integer, Hash)>] SetLabelResponse data, response status code and response headers
|
|
499
|
+
def set_label_with_http_info(domain_href, set_label, opts = {})
|
|
500
|
+
if @api_client.config.debugging
|
|
501
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.set_label ...'
|
|
502
|
+
end
|
|
503
|
+
# verify the required parameter 'domain_href' is set
|
|
504
|
+
if @api_client.config.client_side_validation && domain_href.nil?
|
|
505
|
+
fail ArgumentError, "Missing the required parameter 'domain_href' when calling DomainsApi.set_label"
|
|
506
|
+
end
|
|
507
|
+
# verify the required parameter 'set_label' is set
|
|
508
|
+
if @api_client.config.client_side_validation && set_label.nil?
|
|
509
|
+
fail ArgumentError, "Missing the required parameter 'set_label' when calling DomainsApi.set_label"
|
|
510
|
+
end
|
|
511
|
+
# resource path
|
|
512
|
+
local_var_path = '{domain_href}set_label/'.sub('{' + 'domain_href' + '}', CGI.escape(domain_href.to_s).gsub('%2F', '/'))
|
|
513
|
+
|
|
514
|
+
# query parameters
|
|
515
|
+
query_params = opts[:query_params] || {}
|
|
516
|
+
|
|
517
|
+
# header parameters
|
|
518
|
+
header_params = opts[:header_params] || {}
|
|
519
|
+
# HTTP header 'Accept' (if needed)
|
|
520
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
521
|
+
# HTTP header 'Content-Type'
|
|
522
|
+
content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
|
523
|
+
if !content_type.nil?
|
|
524
|
+
header_params['Content-Type'] = content_type
|
|
525
|
+
end
|
|
526
|
+
|
|
527
|
+
# form parameters
|
|
528
|
+
form_params = opts[:form_params] || {}
|
|
529
|
+
|
|
530
|
+
# http body (model)
|
|
531
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(set_label)
|
|
532
|
+
|
|
533
|
+
# return_type
|
|
534
|
+
return_type = opts[:debug_return_type] || 'SetLabelResponse'
|
|
535
|
+
|
|
536
|
+
# auth_names
|
|
537
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
538
|
+
|
|
539
|
+
new_options = opts.merge(
|
|
540
|
+
:operation => :"DomainsApi.set_label",
|
|
541
|
+
:header_params => header_params,
|
|
542
|
+
:query_params => query_params,
|
|
543
|
+
:form_params => form_params,
|
|
544
|
+
:body => post_body,
|
|
545
|
+
:auth_names => auth_names,
|
|
546
|
+
:return_type => return_type
|
|
547
|
+
)
|
|
548
|
+
|
|
549
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
550
|
+
if @api_client.config.debugging
|
|
551
|
+
@api_client.config.logger.debug "API called: DomainsApi#set_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
552
|
+
end
|
|
553
|
+
return data, status_code, headers
|
|
554
|
+
end
|
|
555
|
+
|
|
556
|
+
# Unset a label
|
|
557
|
+
# Unset a single pulp_label on the object.
|
|
558
|
+
# @param domain_href [String]
|
|
559
|
+
# @param unset_label [UnsetLabel]
|
|
560
|
+
# @param [Hash] opts the optional parameters
|
|
561
|
+
# @return [UnsetLabelResponse]
|
|
562
|
+
def unset_label(domain_href, unset_label, opts = {})
|
|
563
|
+
data, _status_code, _headers = unset_label_with_http_info(domain_href, unset_label, opts)
|
|
564
|
+
data
|
|
565
|
+
end
|
|
566
|
+
|
|
567
|
+
# Unset a label
|
|
568
|
+
# Unset a single pulp_label on the object.
|
|
569
|
+
# @param domain_href [String]
|
|
570
|
+
# @param unset_label [UnsetLabel]
|
|
571
|
+
# @param [Hash] opts the optional parameters
|
|
572
|
+
# @return [Array<(UnsetLabelResponse, Integer, Hash)>] UnsetLabelResponse data, response status code and response headers
|
|
573
|
+
def unset_label_with_http_info(domain_href, unset_label, opts = {})
|
|
574
|
+
if @api_client.config.debugging
|
|
575
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.unset_label ...'
|
|
576
|
+
end
|
|
577
|
+
# verify the required parameter 'domain_href' is set
|
|
578
|
+
if @api_client.config.client_side_validation && domain_href.nil?
|
|
579
|
+
fail ArgumentError, "Missing the required parameter 'domain_href' when calling DomainsApi.unset_label"
|
|
580
|
+
end
|
|
581
|
+
# verify the required parameter 'unset_label' is set
|
|
582
|
+
if @api_client.config.client_side_validation && unset_label.nil?
|
|
583
|
+
fail ArgumentError, "Missing the required parameter 'unset_label' when calling DomainsApi.unset_label"
|
|
584
|
+
end
|
|
585
|
+
# resource path
|
|
586
|
+
local_var_path = '{domain_href}unset_label/'.sub('{' + 'domain_href' + '}', CGI.escape(domain_href.to_s).gsub('%2F', '/'))
|
|
587
|
+
|
|
588
|
+
# query parameters
|
|
589
|
+
query_params = opts[:query_params] || {}
|
|
590
|
+
|
|
591
|
+
# header parameters
|
|
592
|
+
header_params = opts[:header_params] || {}
|
|
593
|
+
# HTTP header 'Accept' (if needed)
|
|
594
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
595
|
+
# HTTP header 'Content-Type'
|
|
596
|
+
content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
|
597
|
+
if !content_type.nil?
|
|
598
|
+
header_params['Content-Type'] = content_type
|
|
599
|
+
end
|
|
600
|
+
|
|
601
|
+
# form parameters
|
|
602
|
+
form_params = opts[:form_params] || {}
|
|
603
|
+
|
|
604
|
+
# http body (model)
|
|
605
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(unset_label)
|
|
606
|
+
|
|
607
|
+
# return_type
|
|
608
|
+
return_type = opts[:debug_return_type] || 'UnsetLabelResponse'
|
|
609
|
+
|
|
610
|
+
# auth_names
|
|
611
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
612
|
+
|
|
613
|
+
new_options = opts.merge(
|
|
614
|
+
:operation => :"DomainsApi.unset_label",
|
|
615
|
+
:header_params => header_params,
|
|
616
|
+
:query_params => query_params,
|
|
617
|
+
:form_params => form_params,
|
|
618
|
+
:body => post_body,
|
|
619
|
+
:auth_names => auth_names,
|
|
620
|
+
:return_type => return_type
|
|
621
|
+
)
|
|
622
|
+
|
|
623
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
624
|
+
if @api_client.config.debugging
|
|
625
|
+
@api_client.config.logger.debug "API called: DomainsApi#unset_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
626
|
+
end
|
|
627
|
+
return data, status_code, headers
|
|
628
|
+
end
|
|
629
|
+
|
|
479
630
|
# Update a domain
|
|
480
631
|
# Trigger an asynchronous update task
|
|
481
632
|
# @param domain_href [String]
|