pulp_container_client 1.0.0rc1

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 (102) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +164 -0
  4. data/Rakefile +10 -0
  5. data/docs/AsyncOperationResponse.md +17 -0
  6. data/docs/ContainerBlob.md +25 -0
  7. data/docs/ContainerContainerDistribution.md +31 -0
  8. data/docs/ContainerContainerRemote.md +43 -0
  9. data/docs/ContainerContainerRepository.md +27 -0
  10. data/docs/ContainerManifest.md +33 -0
  11. data/docs/ContainerTag.md +25 -0
  12. data/docs/ContentBlobsApi.md +142 -0
  13. data/docs/ContentManifestsApi.md +142 -0
  14. data/docs/ContentSummary.md +21 -0
  15. data/docs/ContentTagsApi.md +144 -0
  16. data/docs/DistributionsContainerApi.md +362 -0
  17. data/docs/InlineResponse200.md +23 -0
  18. data/docs/InlineResponse2001.md +23 -0
  19. data/docs/InlineResponse2002.md +23 -0
  20. data/docs/InlineResponse2003.md +23 -0
  21. data/docs/InlineResponse2004.md +23 -0
  22. data/docs/InlineResponse2005.md +23 -0
  23. data/docs/InlineResponse2006.md +23 -0
  24. data/docs/ManifestCopy.md +23 -0
  25. data/docs/RecursiveManage.md +17 -0
  26. data/docs/RemotesContainerApi.md +366 -0
  27. data/docs/RepositoriesContainerApi.md +739 -0
  28. data/docs/RepositoriesContainerVersionsApi.md +214 -0
  29. data/docs/RepositorySyncURL.md +19 -0
  30. data/docs/RepositoryVersion.md +25 -0
  31. data/docs/TagCopy.md +21 -0
  32. data/docs/TagImage.md +19 -0
  33. data/docs/UnTagImage.md +17 -0
  34. data/git_push.sh +58 -0
  35. data/lib/pulp_container_client/api/content_blobs_api.rb +176 -0
  36. data/lib/pulp_container_client/api/content_manifests_api.rb +176 -0
  37. data/lib/pulp_container_client/api/content_tags_api.rb +179 -0
  38. data/lib/pulp_container_client/api/distributions_container_api.rb +442 -0
  39. data/lib/pulp_container_client/api/remotes_container_api.rb +448 -0
  40. data/lib/pulp_container_client/api/repositories_container_api.rb +906 -0
  41. data/lib/pulp_container_client/api/repositories_container_versions_api.rb +268 -0
  42. data/lib/pulp_container_client/api_client.rb +402 -0
  43. data/lib/pulp_container_client/api_error.rb +57 -0
  44. data/lib/pulp_container_client/configuration.rb +243 -0
  45. data/lib/pulp_container_client/models/async_operation_response.rb +212 -0
  46. data/lib/pulp_container_client/models/container_blob.rb +299 -0
  47. data/lib/pulp_container_client/models/container_container_distribution.rb +342 -0
  48. data/lib/pulp_container_client/models/container_container_remote.rb +526 -0
  49. data/lib/pulp_container_client/models/container_container_repository.rb +294 -0
  50. data/lib/pulp_container_client/models/container_manifest.rb +363 -0
  51. data/lib/pulp_container_client/models/container_tag.rb +280 -0
  52. data/lib/pulp_container_client/models/content_summary.rb +246 -0
  53. data/lib/pulp_container_client/models/inline_response200.rb +247 -0
  54. data/lib/pulp_container_client/models/inline_response2001.rb +247 -0
  55. data/lib/pulp_container_client/models/inline_response2002.rb +247 -0
  56. data/lib/pulp_container_client/models/inline_response2003.rb +247 -0
  57. data/lib/pulp_container_client/models/inline_response2004.rb +247 -0
  58. data/lib/pulp_container_client/models/inline_response2005.rb +247 -0
  59. data/lib/pulp_container_client/models/inline_response2006.rb +247 -0
  60. data/lib/pulp_container_client/models/manifest_copy.rb +263 -0
  61. data/lib/pulp_container_client/models/recursive_manage.rb +209 -0
  62. data/lib/pulp_container_client/models/repository_sync_url.rb +224 -0
  63. data/lib/pulp_container_client/models/repository_version.rb +244 -0
  64. data/lib/pulp_container_client/models/tag_copy.rb +229 -0
  65. data/lib/pulp_container_client/models/tag_image.rb +265 -0
  66. data/lib/pulp_container_client/models/un_tag_image.rb +231 -0
  67. data/lib/pulp_container_client/version.rb +15 -0
  68. data/lib/pulp_container_client.rb +68 -0
  69. data/pulp_container_client.gemspec +39 -0
  70. data/spec/api/content_blobs_api_spec.rb +70 -0
  71. data/spec/api/content_manifests_api_spec.rb +70 -0
  72. data/spec/api/content_tags_api_spec.rb +71 -0
  73. data/spec/api/distributions_container_api_spec.rb +120 -0
  74. data/spec/api/remotes_container_api_spec.rb +122 -0
  75. data/spec/api/repositories_container_api_spec.rb +200 -0
  76. data/spec/api/repositories_container_versions_api_spec.rb +91 -0
  77. data/spec/api_client_spec.rb +188 -0
  78. data/spec/configuration_spec.rb +42 -0
  79. data/spec/models/async_operation_response_spec.rb +41 -0
  80. data/spec/models/container_blob_spec.rb +65 -0
  81. data/spec/models/container_container_distribution_spec.rb +83 -0
  82. data/spec/models/container_container_remote_spec.rb +123 -0
  83. data/spec/models/container_container_repository_spec.rb +71 -0
  84. data/spec/models/container_manifest_spec.rb +89 -0
  85. data/spec/models/container_tag_spec.rb +65 -0
  86. data/spec/models/content_summary_spec.rb +53 -0
  87. data/spec/models/inline_response2001_spec.rb +59 -0
  88. data/spec/models/inline_response2002_spec.rb +59 -0
  89. data/spec/models/inline_response2003_spec.rb +59 -0
  90. data/spec/models/inline_response2004_spec.rb +59 -0
  91. data/spec/models/inline_response2005_spec.rb +59 -0
  92. data/spec/models/inline_response2006_spec.rb +59 -0
  93. data/spec/models/inline_response200_spec.rb +59 -0
  94. data/spec/models/manifest_copy_spec.rb +63 -0
  95. data/spec/models/recursive_manage_spec.rb +41 -0
  96. data/spec/models/repository_sync_url_spec.rb +47 -0
  97. data/spec/models/repository_version_spec.rb +65 -0
  98. data/spec/models/tag_copy_spec.rb +53 -0
  99. data/spec/models/tag_image_spec.rb +47 -0
  100. data/spec/models/un_tag_image_spec.rb +41 -0
  101. data/spec/spec_helper.rb +111 -0
  102. metadata +230 -0
@@ -0,0 +1,23 @@
1
+ # PulpContainerClient::InlineResponse2001
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | |
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<ContainerManifest>**](ContainerManifest.md) | |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpContainerClient'
16
+
17
+ instance = PulpContainerClient::InlineResponse2001.new(count: null,
18
+ _next: null,
19
+ previous: null,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpContainerClient::InlineResponse2002
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | |
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<ContainerTag>**](ContainerTag.md) | |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpContainerClient'
16
+
17
+ instance = PulpContainerClient::InlineResponse2002.new(count: null,
18
+ _next: null,
19
+ previous: null,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpContainerClient::InlineResponse2003
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | |
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<ContainerContainerDistribution>**](ContainerContainerDistribution.md) | |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpContainerClient'
16
+
17
+ instance = PulpContainerClient::InlineResponse2003.new(count: null,
18
+ _next: null,
19
+ previous: null,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpContainerClient::InlineResponse2004
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | |
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<ContainerContainerRemote>**](ContainerContainerRemote.md) | |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpContainerClient'
16
+
17
+ instance = PulpContainerClient::InlineResponse2004.new(count: null,
18
+ _next: null,
19
+ previous: null,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpContainerClient::InlineResponse2005
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | |
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<ContainerContainerRepository>**](ContainerContainerRepository.md) | |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpContainerClient'
16
+
17
+ instance = PulpContainerClient::InlineResponse2005.new(count: null,
18
+ _next: null,
19
+ previous: null,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpContainerClient::InlineResponse2006
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | |
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<RepositoryVersion>**](RepositoryVersion.md) | |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpContainerClient'
16
+
17
+ instance = PulpContainerClient::InlineResponse2006.new(count: null,
18
+ _next: null,
19
+ previous: null,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpContainerClient::ManifestCopy
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **source_repository** | **String** | A URI of the repository to copy content from. | [optional]
8
+ **source_repository_version** | **String** | A URI of the repository version to copy content from. | [optional]
9
+ **digests** | **Array<String>** | A list of manifest digests to copy. | [optional]
10
+ **media_types** | **Array<String>** | A list of media_types to copy. | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpContainerClient'
16
+
17
+ instance = PulpContainerClient::ManifestCopy.new(source_repository: null,
18
+ source_repository_version: null,
19
+ digests: null,
20
+ media_types: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,17 @@
1
+ # PulpContainerClient::RecursiveManage
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **content_units** | **Array<String>** | A list of content units to operate on. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'PulpContainerClient'
13
+
14
+ instance = PulpContainerClient::RecursiveManage.new(content_units: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,366 @@
1
+ # PulpContainerClient::RemotesContainerApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](RemotesContainerApi.md#create) | **POST** /pulp/api/v3/remotes/container/container/ | Create a container remote
8
+ [**delete**](RemotesContainerApi.md#delete) | **DELETE** {container_remote_href} | Delete a container remote
9
+ [**list**](RemotesContainerApi.md#list) | **GET** /pulp/api/v3/remotes/container/container/ | List container remotes
10
+ [**partial_update**](RemotesContainerApi.md#partial_update) | **PATCH** {container_remote_href} | Partially update a container remote
11
+ [**read**](RemotesContainerApi.md#read) | **GET** {container_remote_href} | Inspect a container remote
12
+ [**update**](RemotesContainerApi.md#update) | **PUT** {container_remote_href} | Update a container remote
13
+
14
+
15
+
16
+ ## create
17
+
18
+ > ContainerContainerRemote create(data)
19
+
20
+ Create a container remote
21
+
22
+ Container remotes represent an external repository that implements the Container Registry API. Container remotes support deferred downloading by configuring the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide significant disk space savings.
23
+
24
+ ### Example
25
+
26
+ ```ruby
27
+ # load the gem
28
+ require 'pulp_container_client'
29
+ # setup authorization
30
+ PulpContainerClient.configure do |config|
31
+ # Configure HTTP basic authorization: Basic
32
+ config.username = 'YOUR USERNAME'
33
+ config.password = 'YOUR PASSWORD'
34
+ end
35
+
36
+ api_instance = PulpContainerClient::RemotesContainerApi.new
37
+ data = PulpContainerClient::ContainerContainerRemote.new # ContainerContainerRemote |
38
+
39
+ begin
40
+ #Create a container remote
41
+ result = api_instance.create(data)
42
+ p result
43
+ rescue PulpContainerClient::ApiError => e
44
+ puts "Exception when calling RemotesContainerApi->create: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **data** | [**ContainerContainerRemote**](ContainerContainerRemote.md)| |
54
+
55
+ ### Return type
56
+
57
+ [**ContainerContainerRemote**](ContainerContainerRemote.md)
58
+
59
+ ### Authorization
60
+
61
+ [Basic](../README.md#Basic)
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: application/json
66
+ - **Accept**: application/json
67
+
68
+
69
+ ## delete
70
+
71
+ > AsyncOperationResponse delete(container_remote_href)
72
+
73
+ Delete a container remote
74
+
75
+ Trigger an asynchronous delete task
76
+
77
+ ### Example
78
+
79
+ ```ruby
80
+ # load the gem
81
+ require 'pulp_container_client'
82
+ # setup authorization
83
+ PulpContainerClient.configure do |config|
84
+ # Configure HTTP basic authorization: Basic
85
+ config.username = 'YOUR USERNAME'
86
+ config.password = 'YOUR PASSWORD'
87
+ end
88
+
89
+ api_instance = PulpContainerClient::RemotesContainerApi.new
90
+ container_remote_href = 'container_remote_href_example' # String | URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
91
+
92
+ begin
93
+ #Delete a container remote
94
+ result = api_instance.delete(container_remote_href)
95
+ p result
96
+ rescue PulpContainerClient::ApiError => e
97
+ puts "Exception when calling RemotesContainerApi->delete: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+
104
+ Name | Type | Description | Notes
105
+ ------------- | ------------- | ------------- | -------------
106
+ **container_remote_href** | **String**| URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/ |
107
+
108
+ ### Return type
109
+
110
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
111
+
112
+ ### Authorization
113
+
114
+ [Basic](../README.md#Basic)
115
+
116
+ ### HTTP request headers
117
+
118
+ - **Content-Type**: Not defined
119
+ - **Accept**: application/json
120
+
121
+
122
+ ## list
123
+
124
+ > InlineResponse2004 list(opts)
125
+
126
+ List container remotes
127
+
128
+ Container remotes represent an external repository that implements the Container Registry API. Container remotes support deferred downloading by configuring the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide significant disk space savings.
129
+
130
+ ### Example
131
+
132
+ ```ruby
133
+ # load the gem
134
+ require 'pulp_container_client'
135
+ # setup authorization
136
+ PulpContainerClient.configure do |config|
137
+ # Configure HTTP basic authorization: Basic
138
+ config.username = 'YOUR USERNAME'
139
+ config.password = 'YOUR PASSWORD'
140
+ end
141
+
142
+ api_instance = PulpContainerClient::RemotesContainerApi.new
143
+ opts = {
144
+ name: 'name_example', # String |
145
+ name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
146
+ pulp_last_updated__lt: 'pulp_last_updated__lt_example', # String | Filter results where pulp_last_updated is less than value
147
+ pulp_last_updated__lte: 'pulp_last_updated__lte_example', # String | Filter results where pulp_last_updated is less than or equal to value
148
+ pulp_last_updated__gt: 'pulp_last_updated__gt_example', # String | Filter results where pulp_last_updated is greater than value
149
+ pulp_last_updated__gte: 'pulp_last_updated__gte_example', # String | Filter results where pulp_last_updated is greater than or equal to value
150
+ pulp_last_updated__range: 'pulp_last_updated__range_example', # String | Filter results where pulp_last_updated is between two comma separated values
151
+ pulp_last_updated: 'pulp_last_updated_example', # String | ISO 8601 formatted dates are supported
152
+ limit: 56, # Integer | Number of results to return per page.
153
+ offset: 56, # Integer | The initial index from which to return the results.
154
+ fields: 'fields_example', # String | A list of fields to include in the response.
155
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
156
+ }
157
+
158
+ begin
159
+ #List container remotes
160
+ result = api_instance.list(opts)
161
+ p result
162
+ rescue PulpContainerClient::ApiError => e
163
+ puts "Exception when calling RemotesContainerApi->list: #{e}"
164
+ end
165
+ ```
166
+
167
+ ### Parameters
168
+
169
+
170
+ Name | Type | Description | Notes
171
+ ------------- | ------------- | ------------- | -------------
172
+ **name** | **String**| | [optional]
173
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
174
+ **pulp_last_updated__lt** | **String**| Filter results where pulp_last_updated is less than value | [optional]
175
+ **pulp_last_updated__lte** | **String**| Filter results where pulp_last_updated is less than or equal to value | [optional]
176
+ **pulp_last_updated__gt** | **String**| Filter results where pulp_last_updated is greater than value | [optional]
177
+ **pulp_last_updated__gte** | **String**| Filter results where pulp_last_updated is greater than or equal to value | [optional]
178
+ **pulp_last_updated__range** | **String**| Filter results where pulp_last_updated is between two comma separated values | [optional]
179
+ **pulp_last_updated** | **String**| ISO 8601 formatted dates are supported | [optional]
180
+ **limit** | **Integer**| Number of results to return per page. | [optional]
181
+ **offset** | **Integer**| The initial index from which to return the results. | [optional]
182
+ **fields** | **String**| A list of fields to include in the response. | [optional]
183
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
184
+
185
+ ### Return type
186
+
187
+ [**InlineResponse2004**](InlineResponse2004.md)
188
+
189
+ ### Authorization
190
+
191
+ [Basic](../README.md#Basic)
192
+
193
+ ### HTTP request headers
194
+
195
+ - **Content-Type**: Not defined
196
+ - **Accept**: application/json
197
+
198
+
199
+ ## partial_update
200
+
201
+ > AsyncOperationResponse partial_update(container_remote_href, data)
202
+
203
+ Partially update a container remote
204
+
205
+ Trigger an asynchronous partial update task
206
+
207
+ ### Example
208
+
209
+ ```ruby
210
+ # load the gem
211
+ require 'pulp_container_client'
212
+ # setup authorization
213
+ PulpContainerClient.configure do |config|
214
+ # Configure HTTP basic authorization: Basic
215
+ config.username = 'YOUR USERNAME'
216
+ config.password = 'YOUR PASSWORD'
217
+ end
218
+
219
+ api_instance = PulpContainerClient::RemotesContainerApi.new
220
+ container_remote_href = 'container_remote_href_example' # String | URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
221
+ data = PulpContainerClient::ContainerContainerRemote.new # ContainerContainerRemote |
222
+
223
+ begin
224
+ #Partially update a container remote
225
+ result = api_instance.partial_update(container_remote_href, data)
226
+ p result
227
+ rescue PulpContainerClient::ApiError => e
228
+ puts "Exception when calling RemotesContainerApi->partial_update: #{e}"
229
+ end
230
+ ```
231
+
232
+ ### Parameters
233
+
234
+
235
+ Name | Type | Description | Notes
236
+ ------------- | ------------- | ------------- | -------------
237
+ **container_remote_href** | **String**| URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/ |
238
+ **data** | [**ContainerContainerRemote**](ContainerContainerRemote.md)| |
239
+
240
+ ### Return type
241
+
242
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
243
+
244
+ ### Authorization
245
+
246
+ [Basic](../README.md#Basic)
247
+
248
+ ### HTTP request headers
249
+
250
+ - **Content-Type**: application/json
251
+ - **Accept**: application/json
252
+
253
+
254
+ ## read
255
+
256
+ > ContainerContainerRemote read(container_remote_href, opts)
257
+
258
+ Inspect a container remote
259
+
260
+ Container remotes represent an external repository that implements the Container Registry API. Container remotes support deferred downloading by configuring the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide significant disk space savings.
261
+
262
+ ### Example
263
+
264
+ ```ruby
265
+ # load the gem
266
+ require 'pulp_container_client'
267
+ # setup authorization
268
+ PulpContainerClient.configure do |config|
269
+ # Configure HTTP basic authorization: Basic
270
+ config.username = 'YOUR USERNAME'
271
+ config.password = 'YOUR PASSWORD'
272
+ end
273
+
274
+ api_instance = PulpContainerClient::RemotesContainerApi.new
275
+ container_remote_href = 'container_remote_href_example' # String | URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
276
+ opts = {
277
+ fields: 'fields_example', # String | A list of fields to include in the response.
278
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
279
+ }
280
+
281
+ begin
282
+ #Inspect a container remote
283
+ result = api_instance.read(container_remote_href, opts)
284
+ p result
285
+ rescue PulpContainerClient::ApiError => e
286
+ puts "Exception when calling RemotesContainerApi->read: #{e}"
287
+ end
288
+ ```
289
+
290
+ ### Parameters
291
+
292
+
293
+ Name | Type | Description | Notes
294
+ ------------- | ------------- | ------------- | -------------
295
+ **container_remote_href** | **String**| URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/ |
296
+ **fields** | **String**| A list of fields to include in the response. | [optional]
297
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
298
+
299
+ ### Return type
300
+
301
+ [**ContainerContainerRemote**](ContainerContainerRemote.md)
302
+
303
+ ### Authorization
304
+
305
+ [Basic](../README.md#Basic)
306
+
307
+ ### HTTP request headers
308
+
309
+ - **Content-Type**: Not defined
310
+ - **Accept**: application/json
311
+
312
+
313
+ ## update
314
+
315
+ > AsyncOperationResponse update(container_remote_href, data)
316
+
317
+ Update a container remote
318
+
319
+ Trigger an asynchronous update task
320
+
321
+ ### Example
322
+
323
+ ```ruby
324
+ # load the gem
325
+ require 'pulp_container_client'
326
+ # setup authorization
327
+ PulpContainerClient.configure do |config|
328
+ # Configure HTTP basic authorization: Basic
329
+ config.username = 'YOUR USERNAME'
330
+ config.password = 'YOUR PASSWORD'
331
+ end
332
+
333
+ api_instance = PulpContainerClient::RemotesContainerApi.new
334
+ container_remote_href = 'container_remote_href_example' # String | URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
335
+ data = PulpContainerClient::ContainerContainerRemote.new # ContainerContainerRemote |
336
+
337
+ begin
338
+ #Update a container remote
339
+ result = api_instance.update(container_remote_href, data)
340
+ p result
341
+ rescue PulpContainerClient::ApiError => e
342
+ puts "Exception when calling RemotesContainerApi->update: #{e}"
343
+ end
344
+ ```
345
+
346
+ ### Parameters
347
+
348
+
349
+ Name | Type | Description | Notes
350
+ ------------- | ------------- | ------------- | -------------
351
+ **container_remote_href** | **String**| URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/ |
352
+ **data** | [**ContainerContainerRemote**](ContainerContainerRemote.md)| |
353
+
354
+ ### Return type
355
+
356
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
357
+
358
+ ### Authorization
359
+
360
+ [Basic](../README.md#Basic)
361
+
362
+ ### HTTP request headers
363
+
364
+ - **Content-Type**: application/json
365
+ - **Accept**: application/json
366
+