pulp_container_client 2.17.0 → 2.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +40 -6
- data/docs/ContainerContainerDistribution.md +6 -6
- data/docs/ContainerContainerDistributionResponse.md +12 -10
- data/docs/ContainerContainerPullThroughDistribution.md +35 -0
- data/docs/ContainerContainerPullThroughDistributionResponse.md +41 -0
- data/docs/ContainerContainerPullThroughRemote.md +57 -0
- data/docs/ContainerContainerPullThroughRemoteResponse.md +55 -0
- data/docs/{ContainerContainerRemoteResponseHiddenFields.md → ContainerContainerPullThroughRemoteResponseHiddenFields.md} +2 -2
- data/docs/ContainerContainerPushRepository.md +6 -6
- data/docs/ContainerContainerPushRepositoryResponse.md +10 -10
- data/docs/ContainerContainerRemote.md +1 -1
- data/docs/ContainerContainerRemoteResponse.md +2 -2
- data/docs/ContentBlobsApi.md +2 -0
- data/docs/ContentManifestsApi.md +2 -0
- data/docs/ContentSignaturesApi.md +2 -0
- data/docs/ContentTagsApi.md +2 -0
- data/docs/DistributionsPullThroughApi.md +736 -0
- data/docs/PaginatedcontainerContainerPullThroughDistributionResponseList.md +23 -0
- data/docs/PaginatedcontainerContainerPullThroughRemoteResponseList.md +23 -0
- data/docs/PatchedcontainerContainerDistribution.md +6 -6
- data/docs/PatchedcontainerContainerPullThroughDistribution.md +35 -0
- data/docs/PatchedcontainerContainerPullThroughRemote.md +57 -0
- data/docs/PatchedcontainerContainerPushRepository.md +6 -6
- data/docs/PatchedcontainerContainerRemote.md +1 -1
- data/docs/{PolicyEnum.md → Policy762Enum.md} +2 -2
- data/docs/Policy8e2Enum.md +16 -0
- data/docs/RemotesPullThroughApi.md +734 -0
- data/lib/pulp_container_client/api/content_blobs_api.rb +3 -0
- data/lib/pulp_container_client/api/content_manifests_api.rb +3 -0
- data/lib/pulp_container_client/api/content_signatures_api.rb +3 -0
- data/lib/pulp_container_client/api/content_tags_api.rb +3 -0
- data/lib/pulp_container_client/api/distributions_pull_through_api.rb +907 -0
- data/lib/pulp_container_client/api/remotes_pull_through_api.rb +904 -0
- data/lib/pulp_container_client/models/container_container_distribution.rb +26 -26
- data/lib/pulp_container_client/models/container_container_distribution_response.rb +55 -45
- data/lib/pulp_container_client/models/container_container_pull_through_distribution.rb +373 -0
- data/lib/pulp_container_client/models/container_container_pull_through_distribution_response.rb +349 -0
- data/lib/pulp_container_client/models/container_container_pull_through_remote.rb +668 -0
- data/lib/pulp_container_client/models/container_container_pull_through_remote_response.rb +496 -0
- data/lib/pulp_container_client/models/{container_container_remote_response_hidden_fields.rb → container_container_pull_through_remote_response_hidden_fields.rb} +3 -3
- data/lib/pulp_container_client/models/container_container_push_repository.rb +51 -51
- data/lib/pulp_container_client/models/container_container_push_repository_response.rb +48 -48
- data/lib/pulp_container_client/models/container_container_remote.rb +1 -1
- data/lib/pulp_container_client/models/container_container_remote_response.rb +2 -2
- data/lib/pulp_container_client/models/paginatedcontainer_container_pull_through_distribution_response_list.rb +237 -0
- data/lib/pulp_container_client/models/paginatedcontainer_container_pull_through_remote_response_list.rb +237 -0
- data/lib/pulp_container_client/models/patchedcontainer_container_distribution.rb +26 -26
- data/lib/pulp_container_client/models/patchedcontainer_container_pull_through_distribution.rb +350 -0
- data/lib/pulp_container_client/models/patchedcontainer_container_pull_through_remote.rb +650 -0
- data/lib/pulp_container_client/models/patchedcontainer_container_push_repository.rb +43 -43
- data/lib/pulp_container_client/models/patchedcontainer_container_remote.rb +1 -1
- data/lib/pulp_container_client/models/{policy_enum.rb → policy762_enum.rb} +3 -3
- data/lib/pulp_container_client/models/policy8e2_enum.rb +35 -0
- data/lib/pulp_container_client/version.rb +1 -1
- data/lib/pulp_container_client.rb +13 -2
- data/spec/api/content_blobs_api_spec.rb +1 -0
- data/spec/api/content_manifests_api_spec.rb +1 -0
- data/spec/api/content_signatures_api_spec.rb +1 -0
- data/spec/api/content_tags_api_spec.rb +1 -0
- data/spec/api/distributions_pull_through_api_spec.rb +215 -0
- data/spec/api/remotes_pull_through_api_spec.rb +214 -0
- data/spec/models/container_container_distribution_response_spec.rb +14 -8
- data/spec/models/container_container_distribution_spec.rb +6 -6
- data/spec/models/container_container_pull_through_distribution_response_spec.rb +113 -0
- data/spec/models/container_container_pull_through_distribution_spec.rb +95 -0
- data/spec/models/{container_container_remote_response_hidden_fields_spec.rb → container_container_pull_through_remote_response_hidden_fields_spec.rb} +6 -6
- data/spec/models/container_container_pull_through_remote_response_spec.rb +155 -0
- data/spec/models/container_container_pull_through_remote_spec.rb +161 -0
- data/spec/models/container_container_push_repository_response_spec.rb +7 -7
- data/spec/models/container_container_push_repository_spec.rb +4 -4
- data/spec/models/paginatedcontainer_container_pull_through_distribution_response_list_spec.rb +59 -0
- data/spec/models/paginatedcontainer_container_pull_through_remote_response_list_spec.rb +59 -0
- data/spec/models/patchedcontainer_container_distribution_spec.rb +6 -6
- data/spec/models/patchedcontainer_container_pull_through_distribution_spec.rb +95 -0
- data/spec/models/patchedcontainer_container_pull_through_remote_spec.rb +161 -0
- data/spec/models/patchedcontainer_container_push_repository_spec.rb +4 -4
- data/spec/models/{policy_enum_spec.rb → policy762_enum_spec.rb} +6 -6
- data/spec/models/policy8e2_enum_spec.rb +35 -0
- metadata +104 -60
@@ -0,0 +1,736 @@
|
|
1
|
+
# PulpContainerClient::DistributionsPullThroughApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_role**](DistributionsPullThroughApi.md#add_role) | **POST** {container_container_pull_through_distribution_href}add_role/ | Add a role
|
8
|
+
[**create**](DistributionsPullThroughApi.md#create) | **POST** /pulp/api/v3/distributions/container/pull-through/ | Create a container pull through distribution
|
9
|
+
[**delete**](DistributionsPullThroughApi.md#delete) | **DELETE** {container_container_pull_through_distribution_href} | Delete a container pull through distribution
|
10
|
+
[**list**](DistributionsPullThroughApi.md#list) | **GET** /pulp/api/v3/distributions/container/pull-through/ | List container pull through distributions
|
11
|
+
[**list_roles**](DistributionsPullThroughApi.md#list_roles) | **GET** {container_container_pull_through_distribution_href}list_roles/ | List roles
|
12
|
+
[**my_permissions**](DistributionsPullThroughApi.md#my_permissions) | **GET** {container_container_pull_through_distribution_href}my_permissions/ | List user permissions
|
13
|
+
[**partial_update**](DistributionsPullThroughApi.md#partial_update) | **PATCH** {container_container_pull_through_distribution_href} | Update a container pull through distribution
|
14
|
+
[**read**](DistributionsPullThroughApi.md#read) | **GET** {container_container_pull_through_distribution_href} | Inspect a container pull through distribution
|
15
|
+
[**remove_role**](DistributionsPullThroughApi.md#remove_role) | **POST** {container_container_pull_through_distribution_href}remove_role/ | Remove a role
|
16
|
+
[**set_label**](DistributionsPullThroughApi.md#set_label) | **POST** {container_container_pull_through_distribution_href}set_label/ | Set a label
|
17
|
+
[**unset_label**](DistributionsPullThroughApi.md#unset_label) | **POST** {container_container_pull_through_distribution_href}unset_label/ | Unset a label
|
18
|
+
[**update**](DistributionsPullThroughApi.md#update) | **PUT** {container_container_pull_through_distribution_href} | Update a container pull through distribution
|
19
|
+
|
20
|
+
|
21
|
+
|
22
|
+
## add_role
|
23
|
+
|
24
|
+
> NestedRoleResponse add_role(container_container_pull_through_distribution_href, nested_role)
|
25
|
+
|
26
|
+
Add a role
|
27
|
+
|
28
|
+
Add a role for this object to users/groups.
|
29
|
+
|
30
|
+
### Example
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
# load the gem
|
34
|
+
require 'pulp_container_client'
|
35
|
+
# setup authorization
|
36
|
+
PulpContainerClient.configure do |config|
|
37
|
+
# Configure HTTP basic authorization: basicAuth
|
38
|
+
config.username = 'YOUR USERNAME'
|
39
|
+
config.password = 'YOUR PASSWORD'
|
40
|
+
end
|
41
|
+
|
42
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
43
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
44
|
+
nested_role = PulpContainerClient::NestedRole.new # NestedRole |
|
45
|
+
|
46
|
+
begin
|
47
|
+
#Add a role
|
48
|
+
result = api_instance.add_role(container_container_pull_through_distribution_href, nested_role)
|
49
|
+
p result
|
50
|
+
rescue PulpContainerClient::ApiError => e
|
51
|
+
puts "Exception when calling DistributionsPullThroughApi->add_role: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
61
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
[basicAuth](../README.md#basicAuth)
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
74
|
+
- **Accept**: application/json
|
75
|
+
|
76
|
+
|
77
|
+
## create
|
78
|
+
|
79
|
+
> AsyncOperationResponse create(container_container_pull_through_distribution)
|
80
|
+
|
81
|
+
Create a container pull through distribution
|
82
|
+
|
83
|
+
Trigger an asynchronous create task
|
84
|
+
|
85
|
+
### Example
|
86
|
+
|
87
|
+
```ruby
|
88
|
+
# load the gem
|
89
|
+
require 'pulp_container_client'
|
90
|
+
# setup authorization
|
91
|
+
PulpContainerClient.configure do |config|
|
92
|
+
# Configure HTTP basic authorization: basicAuth
|
93
|
+
config.username = 'YOUR USERNAME'
|
94
|
+
config.password = 'YOUR PASSWORD'
|
95
|
+
end
|
96
|
+
|
97
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
98
|
+
container_container_pull_through_distribution = PulpContainerClient::ContainerContainerPullThroughDistribution.new # ContainerContainerPullThroughDistribution |
|
99
|
+
|
100
|
+
begin
|
101
|
+
#Create a container pull through distribution
|
102
|
+
result = api_instance.create(container_container_pull_through_distribution)
|
103
|
+
p result
|
104
|
+
rescue PulpContainerClient::ApiError => e
|
105
|
+
puts "Exception when calling DistributionsPullThroughApi->create: #{e}"
|
106
|
+
end
|
107
|
+
```
|
108
|
+
|
109
|
+
### Parameters
|
110
|
+
|
111
|
+
|
112
|
+
Name | Type | Description | Notes
|
113
|
+
------------- | ------------- | ------------- | -------------
|
114
|
+
**container_container_pull_through_distribution** | [**ContainerContainerPullThroughDistribution**](ContainerContainerPullThroughDistribution.md)| |
|
115
|
+
|
116
|
+
### Return type
|
117
|
+
|
118
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
119
|
+
|
120
|
+
### Authorization
|
121
|
+
|
122
|
+
[basicAuth](../README.md#basicAuth)
|
123
|
+
|
124
|
+
### HTTP request headers
|
125
|
+
|
126
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
127
|
+
- **Accept**: application/json
|
128
|
+
|
129
|
+
|
130
|
+
## delete
|
131
|
+
|
132
|
+
> AsyncOperationResponse delete(container_container_pull_through_distribution_href)
|
133
|
+
|
134
|
+
Delete a container pull through distribution
|
135
|
+
|
136
|
+
Trigger an asynchronous delete task
|
137
|
+
|
138
|
+
### Example
|
139
|
+
|
140
|
+
```ruby
|
141
|
+
# load the gem
|
142
|
+
require 'pulp_container_client'
|
143
|
+
# setup authorization
|
144
|
+
PulpContainerClient.configure do |config|
|
145
|
+
# Configure HTTP basic authorization: basicAuth
|
146
|
+
config.username = 'YOUR USERNAME'
|
147
|
+
config.password = 'YOUR PASSWORD'
|
148
|
+
end
|
149
|
+
|
150
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
151
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
152
|
+
|
153
|
+
begin
|
154
|
+
#Delete a container pull through distribution
|
155
|
+
result = api_instance.delete(container_container_pull_through_distribution_href)
|
156
|
+
p result
|
157
|
+
rescue PulpContainerClient::ApiError => e
|
158
|
+
puts "Exception when calling DistributionsPullThroughApi->delete: #{e}"
|
159
|
+
end
|
160
|
+
```
|
161
|
+
|
162
|
+
### Parameters
|
163
|
+
|
164
|
+
|
165
|
+
Name | Type | Description | Notes
|
166
|
+
------------- | ------------- | ------------- | -------------
|
167
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
168
|
+
|
169
|
+
### Return type
|
170
|
+
|
171
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
172
|
+
|
173
|
+
### Authorization
|
174
|
+
|
175
|
+
[basicAuth](../README.md#basicAuth)
|
176
|
+
|
177
|
+
### HTTP request headers
|
178
|
+
|
179
|
+
- **Content-Type**: Not defined
|
180
|
+
- **Accept**: application/json
|
181
|
+
|
182
|
+
|
183
|
+
## list
|
184
|
+
|
185
|
+
> PaginatedcontainerContainerPullThroughDistributionResponseList list(opts)
|
186
|
+
|
187
|
+
List container pull through distributions
|
188
|
+
|
189
|
+
A special pull-through Container Distribution that will reference distributions serving content.
|
190
|
+
|
191
|
+
### Example
|
192
|
+
|
193
|
+
```ruby
|
194
|
+
# load the gem
|
195
|
+
require 'pulp_container_client'
|
196
|
+
# setup authorization
|
197
|
+
PulpContainerClient.configure do |config|
|
198
|
+
# Configure HTTP basic authorization: basicAuth
|
199
|
+
config.username = 'YOUR USERNAME'
|
200
|
+
config.password = 'YOUR PASSWORD'
|
201
|
+
end
|
202
|
+
|
203
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
204
|
+
opts = {
|
205
|
+
base_path: 'base_path_example', # String | Filter results where base_path matches value
|
206
|
+
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
207
|
+
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
208
|
+
base_path__in: ['base_path__in_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
|
209
|
+
limit: 56, # Integer | Number of results to return per page.
|
210
|
+
name: 'name_example', # String | Filter results where name matches value
|
211
|
+
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
212
|
+
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
213
|
+
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
214
|
+
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
215
|
+
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
216
|
+
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
217
|
+
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
218
|
+
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
219
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
220
|
+
ordering: ['ordering_example'], # 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
221
|
+
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
222
|
+
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
223
|
+
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
224
|
+
q: 'q_example', # String |
|
225
|
+
repository: 'repository_example', # String | Filter results where repository matches value
|
226
|
+
repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
|
227
|
+
with_content: 'with_content_example', # String | Filter distributions based on the content served by them
|
228
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
229
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
230
|
+
}
|
231
|
+
|
232
|
+
begin
|
233
|
+
#List container pull through distributions
|
234
|
+
result = api_instance.list(opts)
|
235
|
+
p result
|
236
|
+
rescue PulpContainerClient::ApiError => e
|
237
|
+
puts "Exception when calling DistributionsPullThroughApi->list: #{e}"
|
238
|
+
end
|
239
|
+
```
|
240
|
+
|
241
|
+
### Parameters
|
242
|
+
|
243
|
+
|
244
|
+
Name | Type | Description | Notes
|
245
|
+
------------- | ------------- | ------------- | -------------
|
246
|
+
**base_path** | **String**| Filter results where base_path matches value | [optional]
|
247
|
+
**base_path__contains** | **String**| Filter results where base_path contains value | [optional]
|
248
|
+
**base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
|
249
|
+
**base_path__in** | [**Array<String>**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional]
|
250
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
251
|
+
**name** | **String**| Filter results where name matches value | [optional]
|
252
|
+
**name__contains** | **String**| Filter results where name contains value | [optional]
|
253
|
+
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
254
|
+
**name__iexact** | **String**| Filter results where name matches value | [optional]
|
255
|
+
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
256
|
+
**name__iregex** | **String**| Filter results where name matches regex value | [optional]
|
257
|
+
**name__istartswith** | **String**| Filter results where name starts with value | [optional]
|
258
|
+
**name__regex** | **String**| Filter results where name matches regex value | [optional]
|
259
|
+
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
260
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
261
|
+
**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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
262
|
+
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
263
|
+
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
264
|
+
**pulp_label_select** | **String**| Filter labels by search string | [optional]
|
265
|
+
**q** | **String**| | [optional]
|
266
|
+
**repository** | [**String**](.md)| Filter results where repository matches value | [optional]
|
267
|
+
**repository__in** | [**Array<String>**](String.md)| Filter results where repository is in a comma-separated list of values | [optional]
|
268
|
+
**with_content** | **String**| Filter distributions based on the content served by them | [optional]
|
269
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
270
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
271
|
+
|
272
|
+
### Return type
|
273
|
+
|
274
|
+
[**PaginatedcontainerContainerPullThroughDistributionResponseList**](PaginatedcontainerContainerPullThroughDistributionResponseList.md)
|
275
|
+
|
276
|
+
### Authorization
|
277
|
+
|
278
|
+
[basicAuth](../README.md#basicAuth)
|
279
|
+
|
280
|
+
### HTTP request headers
|
281
|
+
|
282
|
+
- **Content-Type**: Not defined
|
283
|
+
- **Accept**: application/json
|
284
|
+
|
285
|
+
|
286
|
+
## list_roles
|
287
|
+
|
288
|
+
> ObjectRolesResponse list_roles(container_container_pull_through_distribution_href, opts)
|
289
|
+
|
290
|
+
List roles
|
291
|
+
|
292
|
+
List roles assigned to this object.
|
293
|
+
|
294
|
+
### Example
|
295
|
+
|
296
|
+
```ruby
|
297
|
+
# load the gem
|
298
|
+
require 'pulp_container_client'
|
299
|
+
# setup authorization
|
300
|
+
PulpContainerClient.configure do |config|
|
301
|
+
# Configure HTTP basic authorization: basicAuth
|
302
|
+
config.username = 'YOUR USERNAME'
|
303
|
+
config.password = 'YOUR PASSWORD'
|
304
|
+
end
|
305
|
+
|
306
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
307
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
308
|
+
opts = {
|
309
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
310
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
311
|
+
}
|
312
|
+
|
313
|
+
begin
|
314
|
+
#List roles
|
315
|
+
result = api_instance.list_roles(container_container_pull_through_distribution_href, opts)
|
316
|
+
p result
|
317
|
+
rescue PulpContainerClient::ApiError => e
|
318
|
+
puts "Exception when calling DistributionsPullThroughApi->list_roles: #{e}"
|
319
|
+
end
|
320
|
+
```
|
321
|
+
|
322
|
+
### Parameters
|
323
|
+
|
324
|
+
|
325
|
+
Name | Type | Description | Notes
|
326
|
+
------------- | ------------- | ------------- | -------------
|
327
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
328
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
329
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
330
|
+
|
331
|
+
### Return type
|
332
|
+
|
333
|
+
[**ObjectRolesResponse**](ObjectRolesResponse.md)
|
334
|
+
|
335
|
+
### Authorization
|
336
|
+
|
337
|
+
[basicAuth](../README.md#basicAuth)
|
338
|
+
|
339
|
+
### HTTP request headers
|
340
|
+
|
341
|
+
- **Content-Type**: Not defined
|
342
|
+
- **Accept**: application/json
|
343
|
+
|
344
|
+
|
345
|
+
## my_permissions
|
346
|
+
|
347
|
+
> MyPermissionsResponse my_permissions(container_container_pull_through_distribution_href, opts)
|
348
|
+
|
349
|
+
List user permissions
|
350
|
+
|
351
|
+
List permissions available to the current user on this object.
|
352
|
+
|
353
|
+
### Example
|
354
|
+
|
355
|
+
```ruby
|
356
|
+
# load the gem
|
357
|
+
require 'pulp_container_client'
|
358
|
+
# setup authorization
|
359
|
+
PulpContainerClient.configure do |config|
|
360
|
+
# Configure HTTP basic authorization: basicAuth
|
361
|
+
config.username = 'YOUR USERNAME'
|
362
|
+
config.password = 'YOUR PASSWORD'
|
363
|
+
end
|
364
|
+
|
365
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
366
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
367
|
+
opts = {
|
368
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
369
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
370
|
+
}
|
371
|
+
|
372
|
+
begin
|
373
|
+
#List user permissions
|
374
|
+
result = api_instance.my_permissions(container_container_pull_through_distribution_href, opts)
|
375
|
+
p result
|
376
|
+
rescue PulpContainerClient::ApiError => e
|
377
|
+
puts "Exception when calling DistributionsPullThroughApi->my_permissions: #{e}"
|
378
|
+
end
|
379
|
+
```
|
380
|
+
|
381
|
+
### Parameters
|
382
|
+
|
383
|
+
|
384
|
+
Name | Type | Description | Notes
|
385
|
+
------------- | ------------- | ------------- | -------------
|
386
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
387
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
388
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
389
|
+
|
390
|
+
### Return type
|
391
|
+
|
392
|
+
[**MyPermissionsResponse**](MyPermissionsResponse.md)
|
393
|
+
|
394
|
+
### Authorization
|
395
|
+
|
396
|
+
[basicAuth](../README.md#basicAuth)
|
397
|
+
|
398
|
+
### HTTP request headers
|
399
|
+
|
400
|
+
- **Content-Type**: Not defined
|
401
|
+
- **Accept**: application/json
|
402
|
+
|
403
|
+
|
404
|
+
## partial_update
|
405
|
+
|
406
|
+
> AsyncOperationResponse partial_update(container_container_pull_through_distribution_href, patchedcontainer_container_pull_through_distribution)
|
407
|
+
|
408
|
+
Update a container pull through distribution
|
409
|
+
|
410
|
+
Trigger an asynchronous partial update task
|
411
|
+
|
412
|
+
### Example
|
413
|
+
|
414
|
+
```ruby
|
415
|
+
# load the gem
|
416
|
+
require 'pulp_container_client'
|
417
|
+
# setup authorization
|
418
|
+
PulpContainerClient.configure do |config|
|
419
|
+
# Configure HTTP basic authorization: basicAuth
|
420
|
+
config.username = 'YOUR USERNAME'
|
421
|
+
config.password = 'YOUR PASSWORD'
|
422
|
+
end
|
423
|
+
|
424
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
425
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
426
|
+
patchedcontainer_container_pull_through_distribution = PulpContainerClient::PatchedcontainerContainerPullThroughDistribution.new # PatchedcontainerContainerPullThroughDistribution |
|
427
|
+
|
428
|
+
begin
|
429
|
+
#Update a container pull through distribution
|
430
|
+
result = api_instance.partial_update(container_container_pull_through_distribution_href, patchedcontainer_container_pull_through_distribution)
|
431
|
+
p result
|
432
|
+
rescue PulpContainerClient::ApiError => e
|
433
|
+
puts "Exception when calling DistributionsPullThroughApi->partial_update: #{e}"
|
434
|
+
end
|
435
|
+
```
|
436
|
+
|
437
|
+
### Parameters
|
438
|
+
|
439
|
+
|
440
|
+
Name | Type | Description | Notes
|
441
|
+
------------- | ------------- | ------------- | -------------
|
442
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
443
|
+
**patchedcontainer_container_pull_through_distribution** | [**PatchedcontainerContainerPullThroughDistribution**](PatchedcontainerContainerPullThroughDistribution.md)| |
|
444
|
+
|
445
|
+
### Return type
|
446
|
+
|
447
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
448
|
+
|
449
|
+
### Authorization
|
450
|
+
|
451
|
+
[basicAuth](../README.md#basicAuth)
|
452
|
+
|
453
|
+
### HTTP request headers
|
454
|
+
|
455
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
456
|
+
- **Accept**: application/json
|
457
|
+
|
458
|
+
|
459
|
+
## read
|
460
|
+
|
461
|
+
> ContainerContainerPullThroughDistributionResponse read(container_container_pull_through_distribution_href, opts)
|
462
|
+
|
463
|
+
Inspect a container pull through distribution
|
464
|
+
|
465
|
+
A special pull-through Container Distribution that will reference distributions serving content.
|
466
|
+
|
467
|
+
### Example
|
468
|
+
|
469
|
+
```ruby
|
470
|
+
# load the gem
|
471
|
+
require 'pulp_container_client'
|
472
|
+
# setup authorization
|
473
|
+
PulpContainerClient.configure do |config|
|
474
|
+
# Configure HTTP basic authorization: basicAuth
|
475
|
+
config.username = 'YOUR USERNAME'
|
476
|
+
config.password = 'YOUR PASSWORD'
|
477
|
+
end
|
478
|
+
|
479
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
480
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
481
|
+
opts = {
|
482
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
483
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
484
|
+
}
|
485
|
+
|
486
|
+
begin
|
487
|
+
#Inspect a container pull through distribution
|
488
|
+
result = api_instance.read(container_container_pull_through_distribution_href, opts)
|
489
|
+
p result
|
490
|
+
rescue PulpContainerClient::ApiError => e
|
491
|
+
puts "Exception when calling DistributionsPullThroughApi->read: #{e}"
|
492
|
+
end
|
493
|
+
```
|
494
|
+
|
495
|
+
### Parameters
|
496
|
+
|
497
|
+
|
498
|
+
Name | Type | Description | Notes
|
499
|
+
------------- | ------------- | ------------- | -------------
|
500
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
501
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
502
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
503
|
+
|
504
|
+
### Return type
|
505
|
+
|
506
|
+
[**ContainerContainerPullThroughDistributionResponse**](ContainerContainerPullThroughDistributionResponse.md)
|
507
|
+
|
508
|
+
### Authorization
|
509
|
+
|
510
|
+
[basicAuth](../README.md#basicAuth)
|
511
|
+
|
512
|
+
### HTTP request headers
|
513
|
+
|
514
|
+
- **Content-Type**: Not defined
|
515
|
+
- **Accept**: application/json
|
516
|
+
|
517
|
+
|
518
|
+
## remove_role
|
519
|
+
|
520
|
+
> NestedRoleResponse remove_role(container_container_pull_through_distribution_href, nested_role)
|
521
|
+
|
522
|
+
Remove a role
|
523
|
+
|
524
|
+
Remove a role for this object from users/groups.
|
525
|
+
|
526
|
+
### Example
|
527
|
+
|
528
|
+
```ruby
|
529
|
+
# load the gem
|
530
|
+
require 'pulp_container_client'
|
531
|
+
# setup authorization
|
532
|
+
PulpContainerClient.configure do |config|
|
533
|
+
# Configure HTTP basic authorization: basicAuth
|
534
|
+
config.username = 'YOUR USERNAME'
|
535
|
+
config.password = 'YOUR PASSWORD'
|
536
|
+
end
|
537
|
+
|
538
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
539
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
540
|
+
nested_role = PulpContainerClient::NestedRole.new # NestedRole |
|
541
|
+
|
542
|
+
begin
|
543
|
+
#Remove a role
|
544
|
+
result = api_instance.remove_role(container_container_pull_through_distribution_href, nested_role)
|
545
|
+
p result
|
546
|
+
rescue PulpContainerClient::ApiError => e
|
547
|
+
puts "Exception when calling DistributionsPullThroughApi->remove_role: #{e}"
|
548
|
+
end
|
549
|
+
```
|
550
|
+
|
551
|
+
### Parameters
|
552
|
+
|
553
|
+
|
554
|
+
Name | Type | Description | Notes
|
555
|
+
------------- | ------------- | ------------- | -------------
|
556
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
557
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
558
|
+
|
559
|
+
### Return type
|
560
|
+
|
561
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
562
|
+
|
563
|
+
### Authorization
|
564
|
+
|
565
|
+
[basicAuth](../README.md#basicAuth)
|
566
|
+
|
567
|
+
### HTTP request headers
|
568
|
+
|
569
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
570
|
+
- **Accept**: application/json
|
571
|
+
|
572
|
+
|
573
|
+
## set_label
|
574
|
+
|
575
|
+
> SetLabelResponse set_label(container_container_pull_through_distribution_href, set_label)
|
576
|
+
|
577
|
+
Set a label
|
578
|
+
|
579
|
+
Set a single pulp_label on the object to a specific value or null.
|
580
|
+
|
581
|
+
### Example
|
582
|
+
|
583
|
+
```ruby
|
584
|
+
# load the gem
|
585
|
+
require 'pulp_container_client'
|
586
|
+
# setup authorization
|
587
|
+
PulpContainerClient.configure do |config|
|
588
|
+
# Configure HTTP basic authorization: basicAuth
|
589
|
+
config.username = 'YOUR USERNAME'
|
590
|
+
config.password = 'YOUR PASSWORD'
|
591
|
+
end
|
592
|
+
|
593
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
594
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
595
|
+
set_label = PulpContainerClient::SetLabel.new # SetLabel |
|
596
|
+
|
597
|
+
begin
|
598
|
+
#Set a label
|
599
|
+
result = api_instance.set_label(container_container_pull_through_distribution_href, set_label)
|
600
|
+
p result
|
601
|
+
rescue PulpContainerClient::ApiError => e
|
602
|
+
puts "Exception when calling DistributionsPullThroughApi->set_label: #{e}"
|
603
|
+
end
|
604
|
+
```
|
605
|
+
|
606
|
+
### Parameters
|
607
|
+
|
608
|
+
|
609
|
+
Name | Type | Description | Notes
|
610
|
+
------------- | ------------- | ------------- | -------------
|
611
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
612
|
+
**set_label** | [**SetLabel**](SetLabel.md)| |
|
613
|
+
|
614
|
+
### Return type
|
615
|
+
|
616
|
+
[**SetLabelResponse**](SetLabelResponse.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
|
+
|
628
|
+
## unset_label
|
629
|
+
|
630
|
+
> UnsetLabelResponse unset_label(container_container_pull_through_distribution_href, unset_label)
|
631
|
+
|
632
|
+
Unset a label
|
633
|
+
|
634
|
+
Unset a single pulp_label on the object.
|
635
|
+
|
636
|
+
### Example
|
637
|
+
|
638
|
+
```ruby
|
639
|
+
# load the gem
|
640
|
+
require 'pulp_container_client'
|
641
|
+
# setup authorization
|
642
|
+
PulpContainerClient.configure do |config|
|
643
|
+
# Configure HTTP basic authorization: basicAuth
|
644
|
+
config.username = 'YOUR USERNAME'
|
645
|
+
config.password = 'YOUR PASSWORD'
|
646
|
+
end
|
647
|
+
|
648
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
649
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
650
|
+
unset_label = PulpContainerClient::UnsetLabel.new # UnsetLabel |
|
651
|
+
|
652
|
+
begin
|
653
|
+
#Unset a label
|
654
|
+
result = api_instance.unset_label(container_container_pull_through_distribution_href, unset_label)
|
655
|
+
p result
|
656
|
+
rescue PulpContainerClient::ApiError => e
|
657
|
+
puts "Exception when calling DistributionsPullThroughApi->unset_label: #{e}"
|
658
|
+
end
|
659
|
+
```
|
660
|
+
|
661
|
+
### Parameters
|
662
|
+
|
663
|
+
|
664
|
+
Name | Type | Description | Notes
|
665
|
+
------------- | ------------- | ------------- | -------------
|
666
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
667
|
+
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
668
|
+
|
669
|
+
### Return type
|
670
|
+
|
671
|
+
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
672
|
+
|
673
|
+
### Authorization
|
674
|
+
|
675
|
+
[basicAuth](../README.md#basicAuth)
|
676
|
+
|
677
|
+
### HTTP request headers
|
678
|
+
|
679
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
680
|
+
- **Accept**: application/json
|
681
|
+
|
682
|
+
|
683
|
+
## update
|
684
|
+
|
685
|
+
> AsyncOperationResponse update(container_container_pull_through_distribution_href, container_container_pull_through_distribution)
|
686
|
+
|
687
|
+
Update a container pull through distribution
|
688
|
+
|
689
|
+
Trigger an asynchronous update task
|
690
|
+
|
691
|
+
### Example
|
692
|
+
|
693
|
+
```ruby
|
694
|
+
# load the gem
|
695
|
+
require 'pulp_container_client'
|
696
|
+
# setup authorization
|
697
|
+
PulpContainerClient.configure do |config|
|
698
|
+
# Configure HTTP basic authorization: basicAuth
|
699
|
+
config.username = 'YOUR USERNAME'
|
700
|
+
config.password = 'YOUR PASSWORD'
|
701
|
+
end
|
702
|
+
|
703
|
+
api_instance = PulpContainerClient::DistributionsPullThroughApi.new
|
704
|
+
container_container_pull_through_distribution_href = 'container_container_pull_through_distribution_href_example' # String |
|
705
|
+
container_container_pull_through_distribution = PulpContainerClient::ContainerContainerPullThroughDistribution.new # ContainerContainerPullThroughDistribution |
|
706
|
+
|
707
|
+
begin
|
708
|
+
#Update a container pull through distribution
|
709
|
+
result = api_instance.update(container_container_pull_through_distribution_href, container_container_pull_through_distribution)
|
710
|
+
p result
|
711
|
+
rescue PulpContainerClient::ApiError => e
|
712
|
+
puts "Exception when calling DistributionsPullThroughApi->update: #{e}"
|
713
|
+
end
|
714
|
+
```
|
715
|
+
|
716
|
+
### Parameters
|
717
|
+
|
718
|
+
|
719
|
+
Name | Type | Description | Notes
|
720
|
+
------------- | ------------- | ------------- | -------------
|
721
|
+
**container_container_pull_through_distribution_href** | **String**| |
|
722
|
+
**container_container_pull_through_distribution** | [**ContainerContainerPullThroughDistribution**](ContainerContainerPullThroughDistribution.md)| |
|
723
|
+
|
724
|
+
### Return type
|
725
|
+
|
726
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
727
|
+
|
728
|
+
### Authorization
|
729
|
+
|
730
|
+
[basicAuth](../README.md#basicAuth)
|
731
|
+
|
732
|
+
### HTTP request headers
|
733
|
+
|
734
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
735
|
+
- **Accept**: application/json
|
736
|
+
|