pulp_container_client 2.14.12 → 2.14.14

data/docs/UpstreamPulpResponse.md

@@ -0,0 +1,39 @@
+# PulpContainerClient::UpstreamPulpResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | A unique name for this Pulp server. | 
+**base_url** | **String** | The transport, hostname, and an optional port of the Pulp server. e.g. https://example.com | 
+**api_root** | **String** | The API root. Defaults to '/pulp/'. | 
+**domain** | **String** | The domain of the Pulp server if enabled. | [optional] 
+**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
+**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] 
+**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
+**pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly] 
+**hidden_fields** | [**Array<RemoteResponseHiddenFields>**](RemoteResponseHiddenFields.md) | List of hidden (write only) fields | [optional] [readonly] 
+**pulp_label_select** | **String** | One or more comma separated labels that will be used to filter distributions on the upstream Pulp. E.g. \"foo=bar,key=val\" or \"foo,key\" | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::UpstreamPulpResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 base_url: null,
+                                 api_root: null,
+                                 domain: null,
+                                 ca_cert: null,
+                                 client_cert: null,
+                                 tls_validation: null,
+                                 pulp_last_updated: null,
+                                 hidden_fields: null,
+                                 pulp_label_select: null)
+```
+
+

data/docs/UpstreamPulpsApi.md

@@ -0,0 +1,405 @@
+# PulpContainerClient::UpstreamPulpsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](UpstreamPulpsApi.md#create) | **POST** /pulp/api/v3/upstream-pulps/ | Create an upstream pulp
+[**delete**](UpstreamPulpsApi.md#delete) | **DELETE** {upstream_pulp_href} | Delete an upstream pulp
+[**list**](UpstreamPulpsApi.md#list) | **GET** /pulp/api/v3/upstream-pulps/ | List upstream pulps
+[**partial_update**](UpstreamPulpsApi.md#partial_update) | **PATCH** {upstream_pulp_href} | Update an upstream pulp
+[**read**](UpstreamPulpsApi.md#read) | **GET** {upstream_pulp_href} | Inspect an upstream pulp
+[**replicate**](UpstreamPulpsApi.md#replicate) | **POST** {upstream_pulp_href}replicate/ | Replicate
+[**update**](UpstreamPulpsApi.md#update) | **PUT** {upstream_pulp_href} | Update an upstream pulp
+
+
+
+## create
+
+> UpstreamPulpResponse create(upstream_pulp)
+
+Create an upstream pulp
+
+API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::UpstreamPulpsApi.new
+upstream_pulp = PulpContainerClient::UpstreamPulp.new # UpstreamPulp | 
+
+begin
+  #Create an upstream pulp
+  result = api_instance.create(upstream_pulp)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling UpstreamPulpsApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upstream_pulp** | [**UpstreamPulp**](UpstreamPulp.md)|  | 
+
+### Return type
+
+[**UpstreamPulpResponse**](UpstreamPulpResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## delete
+
+> delete(upstream_pulp_href)
+
+Delete an upstream pulp
+
+API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::UpstreamPulpsApi.new
+upstream_pulp_href = 'upstream_pulp_href_example' # String | 
+
+begin
+  #Delete an upstream pulp
+  api_instance.delete(upstream_pulp_href)
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling UpstreamPulpsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upstream_pulp_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> PaginatedUpstreamPulpResponseList list(opts)
+
+List upstream pulps
+
+API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::UpstreamPulpsApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List upstream pulps
+  result = api_instance.list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling UpstreamPulpsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedUpstreamPulpResponseList**](PaginatedUpstreamPulpResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> UpstreamPulpResponse partial_update(upstream_pulp_href, patched_upstream_pulp)
+
+Update an upstream pulp
+
+API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::UpstreamPulpsApi.new
+upstream_pulp_href = 'upstream_pulp_href_example' # String | 
+patched_upstream_pulp = PulpContainerClient::PatchedUpstreamPulp.new # PatchedUpstreamPulp | 
+
+begin
+  #Update an upstream pulp
+  result = api_instance.partial_update(upstream_pulp_href, patched_upstream_pulp)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling UpstreamPulpsApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upstream_pulp_href** | **String**|  | 
+ **patched_upstream_pulp** | [**PatchedUpstreamPulp**](PatchedUpstreamPulp.md)|  | 
+
+### Return type
+
+[**UpstreamPulpResponse**](UpstreamPulpResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## read
+
+> UpstreamPulpResponse read(upstream_pulp_href, opts)
+
+Inspect an upstream pulp
+
+API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::UpstreamPulpsApi.new
+upstream_pulp_href = 'upstream_pulp_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect an upstream pulp
+  result = api_instance.read(upstream_pulp_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling UpstreamPulpsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upstream_pulp_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**UpstreamPulpResponse**](UpstreamPulpResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## replicate
+
+> AsyncOperationResponse replicate(upstream_pulp_href, upstream_pulp)
+
+Replicate
+
+Trigger an asynchronous repository replication task group. This API is provided as a tech preview.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::UpstreamPulpsApi.new
+upstream_pulp_href = 'upstream_pulp_href_example' # String | 
+upstream_pulp = PulpContainerClient::UpstreamPulp.new # UpstreamPulp | 
+
+begin
+  #Replicate
+  result = api_instance.replicate(upstream_pulp_href, upstream_pulp)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling UpstreamPulpsApi->replicate: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upstream_pulp_href** | **String**|  | 
+ **upstream_pulp** | [**UpstreamPulp**](UpstreamPulp.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## update
+
+> UpstreamPulpResponse update(upstream_pulp_href, upstream_pulp)
+
+Update an upstream pulp
+
+API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::UpstreamPulpsApi.new
+upstream_pulp_href = 'upstream_pulp_href_example' # String | 
+upstream_pulp = PulpContainerClient::UpstreamPulp.new # UpstreamPulp | 
+
+begin
+  #Update an upstream pulp
+  result = api_instance.update(upstream_pulp_href, upstream_pulp)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling UpstreamPulpsApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upstream_pulp_href** | **String**|  | 
+ **upstream_pulp** | [**UpstreamPulp**](UpstreamPulp.md)|  | 
+
+### Return type
+
+[**UpstreamPulpResponse**](UpstreamPulpResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/User.md

@@ -0,0 +1,29 @@
+# PulpContainerClient::User
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. | 
+**password** | **String** | Users password. Set to ``null`` to disable password authentication. | [optional] 
+**first_name** | **String** | First name | [optional] 
+**last_name** | **String** | Last name | [optional] 
+**email** | **String** | Email address | [optional] 
+**is_staff** | **Boolean** | Designates whether the user can log into this admin site. | [optional] [default to false]
+**is_active** | **Boolean** | Designates whether this user should be treated as active. | [optional] [default to true]
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::User.new(username: null,
+                                 password: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 email: null,
+                                 is_staff: null,
+                                 is_active: null)
+```
+
+

data/docs/UserGroup.md

@@ -0,0 +1,17 @@
+# PulpContainerClient::UserGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name. | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::UserGroup.new(name: null)
+```
+
+

data/docs/UserGroupResponse.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::UserGroupResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name. | 
+**pulp_href** | **String** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::UserGroupResponse.new(name: null,
+                                 pulp_href: null)
+```
+
+

data/docs/UserResponse.md

@@ -0,0 +1,37 @@
+# PulpContainerClient::UserResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**id** | **Integer** |  | [optional] [readonly] 
+**username** | **String** | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. | 
+**first_name** | **String** | First name | [optional] 
+**last_name** | **String** | Last name | [optional] 
+**email** | **String** | Email address | [optional] 
+**is_staff** | **Boolean** | Designates whether the user can log into this admin site. | [optional] [default to false]
+**is_active** | **Boolean** | Designates whether this user should be treated as active. | [optional] [default to true]
+**date_joined** | **DateTime** | Date joined | [optional] [readonly] 
+**groups** | [**Array<UserGroupResponse>**](UserGroupResponse.md) |  | [optional] [readonly] 
+**hidden_fields** | [**Array<RemoteResponseHiddenFields>**](RemoteResponseHiddenFields.md) | List of hidden (write only) fields | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::UserResponse.new(pulp_href: null,
+                                 id: null,
+                                 username: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 email: null,
+                                 is_staff: null,
+                                 is_active: null,
+                                 date_joined: null,
+                                 groups: null,
+                                 hidden_fields: null)
+```
+
+

data/docs/UserRole.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::UserRole
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** |  | 
+**content_object** | **String** | pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level. | 
+**domain** | **String** | Domain this role should be applied on, mutually exclusive with content_object. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::UserRole.new(role: null,
+                                 content_object: null,
+                                 domain: null)
+```
+
+

data/docs/UserRoleResponse.md

@@ -0,0 +1,29 @@
+# PulpContainerClient::UserRoleResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**role** | **String** |  | 
+**content_object** | **String** | pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level. | 
+**description** | **String** |  | [optional] [readonly] 
+**permissions** | **Array<String>** |  | [optional] [readonly] 
+**domain** | **String** | Domain this role should be applied on, mutually exclusive with content_object. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::UserRoleResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 role: null,
+                                 content_object: null,
+                                 description: null,
+                                 permissions: null,
+                                 domain: null)
+```
+
+