pulp_python_client 3.11.8 → 3.12.0

data/docs/RemotesPythonApi.md

@@ -1,24 +1,83 @@
 # PulpPythonClient::RemotesPythonApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](RemotesPythonApi.md#add_role) | **POST** {python_python_remote_href}add_role/ | Add a role
 [**create**](RemotesPythonApi.md#create) | **POST** /pulp/api/v3/remotes/python/python/ | Create a python remote
 [**delete**](RemotesPythonApi.md#delete) | **DELETE** {python_python_remote_href} | Delete a python remote
 [**from_bandersnatch**](RemotesPythonApi.md#from_bandersnatch) | **POST** /pulp/api/v3/remotes/python/python/from_bandersnatch/ | Create from Bandersnatch
 [**list**](RemotesPythonApi.md#list) | **GET** /pulp/api/v3/remotes/python/python/ | List python remotes
+[**list_roles**](RemotesPythonApi.md#list_roles) | **GET** {python_python_remote_href}list_roles/ | List roles
+[**my_permissions**](RemotesPythonApi.md#my_permissions) | **GET** {python_python_remote_href}my_permissions/ | List user permissions
 [**partial_update**](RemotesPythonApi.md#partial_update) | **PATCH** {python_python_remote_href} | Update a python remote
 [**read**](RemotesPythonApi.md#read) | **GET** {python_python_remote_href} | Inspect a python remote
+[**remove_role**](RemotesPythonApi.md#remove_role) | **POST** {python_python_remote_href}remove_role/ | Remove a role
 [**set_label**](RemotesPythonApi.md#set_label) | **POST** {python_python_remote_href}set_label/ | Set a label
 [**unset_label**](RemotesPythonApi.md#unset_label) | **POST** {python_python_remote_href}unset_label/ | Unset a label
 [**update**](RemotesPythonApi.md#update) | **PUT** {python_python_remote_href} | Update a python remote
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(python_python_remote_href, nested_role)
+
+Add a role
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RemotesPythonApi.new
+python_python_remote_href = 'python_python_remote_href_example' # String | 
+nested_role = PulpPythonClient::NestedRole.new # NestedRole | 
+
+begin
+  #Add a role
+  result = api_instance.add_role(python_python_remote_href, nested_role)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_remote_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## create
 
-> PythonPythonRemoteResponse create(python_python_remote, opts)
+> PythonPythonRemoteResponse create(python_python_remote)
 
 Create a python remote
 
@@ -38,13 +97,10 @@ end
 
 api_instance = PulpPythonClient::RemotesPythonApi.new
 python_python_remote = PulpPythonClient::PythonPythonRemote.new # PythonPythonRemote | 
-opts = {
-  x_task_diagnostics: ['x_task_diagnostics_example'] # Array<String> | List of profilers to use on tasks.
-}
 
 begin
   #Create a python remote
-  result = api_instance.create(python_python_remote, opts)
+  result = api_instance.create(python_python_remote)
   p result
 rescue PulpPythonClient::ApiError => e
   puts "Exception when calling RemotesPythonApi->create: #{e}"
@@ -57,7 +113,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **python_python_remote** | [**PythonPythonRemote**](PythonPythonRemote.md)|  | 
- **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md)| List of profilers to use on tasks. | [optional] 
 
 ### Return type
 
@@ -75,7 +130,7 @@ Name | Type | Description  | Notes
 
 ## delete
 
-> AsyncOperationResponse delete(python_python_remote_href, opts)
+> AsyncOperationResponse delete(python_python_remote_href)
 
 Delete a python remote
 
@@ -95,13 +150,10 @@ end
 
 api_instance = PulpPythonClient::RemotesPythonApi.new
 python_python_remote_href = 'python_python_remote_href_example' # String | 
-opts = {
-  x_task_diagnostics: ['x_task_diagnostics_example'] # Array<String> | List of profilers to use on tasks.
-}
 
 begin
   #Delete a python remote
-  result = api_instance.delete(python_python_remote_href, opts)
+  result = api_instance.delete(python_python_remote_href)
   p result
 rescue PulpPythonClient::ApiError => e
   puts "Exception when calling RemotesPythonApi->delete: #{e}"
@@ -114,7 +166,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **python_python_remote_href** | **String**|  | 
- **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md)| List of profilers to use on tasks. | [optional] 
 
 ### Return type
 
@@ -154,7 +205,6 @@ api_instance = PulpPythonClient::RemotesPythonApi.new
 config = File.new('/path/to/file') # File | A Bandersnatch config that may be used to construct a Python Remote.
 name = 'name_example' # String | A unique name for this remote
 opts = {
-  x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
   policy: PulpPythonClient::PolicyEnum.new # PolicyEnum | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default.  * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.
 }
 
@@ -174,7 +224,6 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **config** | **File**| A Bandersnatch config that may be used to construct a Python Remote. | 
  **name** | **String**| A unique name for this remote | 
- **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md)| List of profilers to use on tasks. | [optional] 
  **policy** | [**PolicyEnum**](PolicyEnum.md)| The policy to use when downloading content. The possible values include: &#39;immediate&#39;, &#39;on_demand&#39;, and &#39;streamed&#39;. &#39;on_demand&#39; is the default.  * &#x60;immediate&#x60; - When syncing, download all metadata and content now. * &#x60;on_demand&#x60; - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * &#x60;streamed&#x60; - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] 
 
 ### Return type
@@ -213,7 +262,6 @@ end
 
 api_instance = PulpPythonClient::RemotesPythonApi.new
 opts = {
-  x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
   limit: 56, # Integer | Number of results to return per page.
   name: 'name_example', # String | Filter results where name matches value
   name__contains: 'name__contains_example', # String | Filter results where name contains value
@@ -254,7 +302,6 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md)| List of profilers to use on tasks. | [optional] 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
  **name** | **String**| Filter results where name matches value | [optional] 
  **name__contains** | **String**| Filter results where name contains value | [optional] 
@@ -294,9 +341,127 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(python_python_remote_href, opts)
+
+List roles
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RemotesPythonApi.new
+python_python_remote_href = 'python_python_remote_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
+  #List roles
+  result = api_instance.list_roles(python_python_remote_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_remote_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
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## my_permissions
+
+> MyPermissionsResponse my_permissions(python_python_remote_href, opts)
+
+List user permissions
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RemotesPythonApi.new
+python_python_remote_href = 'python_python_remote_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
+  #List user permissions
+  result = api_instance.my_permissions(python_python_remote_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_remote_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
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## partial_update
 
-> AsyncOperationResponse partial_update(python_python_remote_href, patchedpython_python_remote, opts)
+> AsyncOperationResponse partial_update(python_python_remote_href, patchedpython_python_remote)
 
 Update a python remote
 
@@ -317,13 +482,10 @@ end
 api_instance = PulpPythonClient::RemotesPythonApi.new
 python_python_remote_href = 'python_python_remote_href_example' # String | 
 patchedpython_python_remote = PulpPythonClient::PatchedpythonPythonRemote.new # PatchedpythonPythonRemote | 
-opts = {
-  x_task_diagnostics: ['x_task_diagnostics_example'] # Array<String> | List of profilers to use on tasks.
-}
 
 begin
   #Update a python remote
-  result = api_instance.partial_update(python_python_remote_href, patchedpython_python_remote, opts)
+  result = api_instance.partial_update(python_python_remote_href, patchedpython_python_remote)
   p result
 rescue PulpPythonClient::ApiError => e
   puts "Exception when calling RemotesPythonApi->partial_update: #{e}"
@@ -337,7 +499,6 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **python_python_remote_href** | **String**|  | 
  **patchedpython_python_remote** | [**PatchedpythonPythonRemote**](PatchedpythonPythonRemote.md)|  | 
- **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md)| List of profilers to use on tasks. | [optional] 
 
 ### Return type
 
@@ -376,7 +537,6 @@ end
 api_instance = PulpPythonClient::RemotesPythonApi.new
 python_python_remote_href = 'python_python_remote_href_example' # String | 
 opts = {
-  x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
   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.
 }
@@ -396,7 +556,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **python_python_remote_href** | **String**|  | 
- **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md)| List of profilers to use on tasks. | [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] 
 
@@ -414,9 +573,64 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(python_python_remote_href, nested_role)
+
+Remove a role
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RemotesPythonApi.new
+python_python_remote_href = 'python_python_remote_href_example' # String | 
+nested_role = PulpPythonClient::NestedRole.new # NestedRole | 
+
+begin
+  #Remove a role
+  result = api_instance.remove_role(python_python_remote_href, nested_role)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_remote_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## set_label
 
-> SetLabelResponse set_label(python_python_remote_href, set_label, opts)
+> SetLabelResponse set_label(python_python_remote_href, set_label)
 
 Set a label
 
@@ -437,13 +651,10 @@ end
 api_instance = PulpPythonClient::RemotesPythonApi.new
 python_python_remote_href = 'python_python_remote_href_example' # String | 
 set_label = PulpPythonClient::SetLabel.new # SetLabel | 
-opts = {
-  x_task_diagnostics: ['x_task_diagnostics_example'] # Array<String> | List of profilers to use on tasks.
-}
 
 begin
   #Set a label
-  result = api_instance.set_label(python_python_remote_href, set_label, opts)
+  result = api_instance.set_label(python_python_remote_href, set_label)
   p result
 rescue PulpPythonClient::ApiError => e
   puts "Exception when calling RemotesPythonApi->set_label: #{e}"
@@ -457,7 +668,6 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **python_python_remote_href** | **String**|  | 
  **set_label** | [**SetLabel**](SetLabel.md)|  | 
- **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md)| List of profilers to use on tasks. | [optional] 
 
 ### Return type
 
@@ -475,7 +685,7 @@ Name | Type | Description  | Notes
 
 ## unset_label
 
-> UnsetLabelResponse unset_label(python_python_remote_href, unset_label, opts)
+> UnsetLabelResponse unset_label(python_python_remote_href, unset_label)
 
 Unset a label
 
@@ -496,13 +706,10 @@ end
 api_instance = PulpPythonClient::RemotesPythonApi.new
 python_python_remote_href = 'python_python_remote_href_example' # String | 
 unset_label = PulpPythonClient::UnsetLabel.new # UnsetLabel | 
-opts = {
-  x_task_diagnostics: ['x_task_diagnostics_example'] # Array<String> | List of profilers to use on tasks.
-}
 
 begin
   #Unset a label
-  result = api_instance.unset_label(python_python_remote_href, unset_label, opts)
+  result = api_instance.unset_label(python_python_remote_href, unset_label)
   p result
 rescue PulpPythonClient::ApiError => e
   puts "Exception when calling RemotesPythonApi->unset_label: #{e}"
@@ -516,7 +723,6 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **python_python_remote_href** | **String**|  | 
  **unset_label** | [**UnsetLabel**](UnsetLabel.md)|  | 
- **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md)| List of profilers to use on tasks. | [optional] 
 
 ### Return type
 
@@ -534,7 +740,7 @@ Name | Type | Description  | Notes
 
 ## update
 
-> AsyncOperationResponse update(python_python_remote_href, python_python_remote, opts)
+> AsyncOperationResponse update(python_python_remote_href, python_python_remote)
 
 Update a python remote
 
@@ -555,13 +761,10 @@ end
 api_instance = PulpPythonClient::RemotesPythonApi.new
 python_python_remote_href = 'python_python_remote_href_example' # String | 
 python_python_remote = PulpPythonClient::PythonPythonRemote.new # PythonPythonRemote | 
-opts = {
-  x_task_diagnostics: ['x_task_diagnostics_example'] # Array<String> | List of profilers to use on tasks.
-}
 
 begin
   #Update a python remote
-  result = api_instance.update(python_python_remote_href, python_python_remote, opts)
+  result = api_instance.update(python_python_remote_href, python_python_remote)
   p result
 rescue PulpPythonClient::ApiError => e
   puts "Exception when calling RemotesPythonApi->update: #{e}"
@@ -575,7 +778,6 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **python_python_remote_href** | **String**|  | 
  **python_python_remote** | [**PythonPythonRemote**](PythonPythonRemote.md)|  | 
- **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md)| List of profilers to use on tasks. | [optional] 
 
 ### Return type