docs/RemotesPullThroughApi.md in pulp_container_client-2.20.0 vs docs/RemotesPullThroughApi.md in pulp_container_client-2.20.1

- old
+ new

@@ -1,29 +1,29 @@ # PulpContainerClient::RemotesPullThroughApi -All URIs are relative to *http://pulp* +All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_role**](RemotesPullThroughApi.md#add_role) | **POST** {container_container_pull_through_remote_href}add_role/ | Add a role -[**create**](RemotesPullThroughApi.md#create) | **POST** /pulp/api/v3/remotes/container/pull-through/ | Create a container pull through remote -[**delete**](RemotesPullThroughApi.md#delete) | **DELETE** {container_container_pull_through_remote_href} | Delete a container pull through remote -[**list**](RemotesPullThroughApi.md#list) | **GET** /pulp/api/v3/remotes/container/pull-through/ | List container pull through remotes -[**list_roles**](RemotesPullThroughApi.md#list_roles) | **GET** {container_container_pull_through_remote_href}list_roles/ | List roles -[**my_permissions**](RemotesPullThroughApi.md#my_permissions) | **GET** {container_container_pull_through_remote_href}my_permissions/ | List user permissions -[**partial_update**](RemotesPullThroughApi.md#partial_update) | **PATCH** {container_container_pull_through_remote_href} | Update a container pull through remote -[**read**](RemotesPullThroughApi.md#read) | **GET** {container_container_pull_through_remote_href} | Inspect a container pull through remote -[**remove_role**](RemotesPullThroughApi.md#remove_role) | **POST** {container_container_pull_through_remote_href}remove_role/ | Remove a role -[**set_label**](RemotesPullThroughApi.md#set_label) | **POST** {container_container_pull_through_remote_href}set_label/ | Set a label -[**unset_label**](RemotesPullThroughApi.md#unset_label) | **POST** {container_container_pull_through_remote_href}unset_label/ | Unset a label -[**update**](RemotesPullThroughApi.md#update) | **PUT** {container_container_pull_through_remote_href} | Update a container pull through remote +[**remotes_container_pull_through_add_role**](RemotesPullThroughApi.md#remotes_container_pull_through_add_role) | **POST** {container_container_pull_through_remote_href}add_role/ | Add a role +[**remotes_container_pull_through_create**](RemotesPullThroughApi.md#remotes_container_pull_through_create) | **POST** /pulp/api/v3/remotes/container/pull-through/ | Create a container pull through remote +[**remotes_container_pull_through_delete**](RemotesPullThroughApi.md#remotes_container_pull_through_delete) | **DELETE** {container_container_pull_through_remote_href} | Delete a container pull through remote +[**remotes_container_pull_through_list**](RemotesPullThroughApi.md#remotes_container_pull_through_list) | **GET** /pulp/api/v3/remotes/container/pull-through/ | List container pull through remotes +[**remotes_container_pull_through_list_roles**](RemotesPullThroughApi.md#remotes_container_pull_through_list_roles) | **GET** {container_container_pull_through_remote_href}list_roles/ | List roles +[**remotes_container_pull_through_my_permissions**](RemotesPullThroughApi.md#remotes_container_pull_through_my_permissions) | **GET** {container_container_pull_through_remote_href}my_permissions/ | List user permissions +[**remotes_container_pull_through_partial_update**](RemotesPullThroughApi.md#remotes_container_pull_through_partial_update) | **PATCH** {container_container_pull_through_remote_href} | Update a container pull through remote +[**remotes_container_pull_through_read**](RemotesPullThroughApi.md#remotes_container_pull_through_read) | **GET** {container_container_pull_through_remote_href} | Inspect a container pull through remote +[**remotes_container_pull_through_remove_role**](RemotesPullThroughApi.md#remotes_container_pull_through_remove_role) | **POST** {container_container_pull_through_remote_href}remove_role/ | Remove a role +[**remotes_container_pull_through_set_label**](RemotesPullThroughApi.md#remotes_container_pull_through_set_label) | **POST** {container_container_pull_through_remote_href}set_label/ | Set a label +[**remotes_container_pull_through_unset_label**](RemotesPullThroughApi.md#remotes_container_pull_through_unset_label) | **POST** {container_container_pull_through_remote_href}unset_label/ | Unset a label +[**remotes_container_pull_through_update**](RemotesPullThroughApi.md#remotes_container_pull_through_update) | **PUT** {container_container_pull_through_remote_href} | Update a container pull through remote -## add_role +## remotes_container_pull_through_add_role -> NestedRoleResponse add_role(container_container_pull_through_remote_href, nested_role) +> NestedRoleResponse remotes_container_pull_through_add_role(container_container_pull_through_remote_href, nested_role) Add a role Add a role for this object to users/groups. @@ -43,14 +43,14 @@ container_container_pull_through_remote_href = 'container_container_pull_through_remote_href_example' # String | nested_role = PulpContainerClient::NestedRole.new # NestedRole | begin #Add a role - result = api_instance.add_role(container_container_pull_through_remote_href, nested_role) + result = api_instance.remotes_container_pull_through_add_role(container_container_pull_through_remote_href, nested_role) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->add_role: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_add_role: #{e}" end ``` ### Parameters @@ -72,13 +72,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## create +## remotes_container_pull_through_create -> ContainerContainerPullThroughRemoteResponse create(container_container_pull_through_remote) +> ContainerContainerPullThroughRemoteResponse remotes_container_pull_through_create(container_container_pull_through_remote) Create a container pull through remote A Container Remote referencing a remote registry used as a source for the pull-through caching. @@ -97,14 +97,14 @@ api_instance = PulpContainerClient::RemotesPullThroughApi.new container_container_pull_through_remote = PulpContainerClient::ContainerContainerPullThroughRemote.new # ContainerContainerPullThroughRemote | begin #Create a container pull through remote - result = api_instance.create(container_container_pull_through_remote) + result = api_instance.remotes_container_pull_through_create(container_container_pull_through_remote) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->create: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_create: #{e}" end ``` ### Parameters @@ -125,13 +125,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## delete +## remotes_container_pull_through_delete -> AsyncOperationResponse delete(container_container_pull_through_remote_href) +> AsyncOperationResponse remotes_container_pull_through_delete(container_container_pull_through_remote_href) Delete a container pull through remote Trigger an asynchronous delete task @@ -150,14 +150,14 @@ api_instance = PulpContainerClient::RemotesPullThroughApi.new container_container_pull_through_remote_href = 'container_container_pull_through_remote_href_example' # String | begin #Delete a container pull through remote - result = api_instance.delete(container_container_pull_through_remote_href) + result = api_instance.remotes_container_pull_through_delete(container_container_pull_through_remote_href) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->delete: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_delete: #{e}" end ``` ### Parameters @@ -178,13 +178,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## list +## remotes_container_pull_through_list -> PaginatedcontainerContainerPullThroughRemoteResponseList list(opts) +> PaginatedcontainerContainerPullThroughRemoteResponseList remotes_container_pull_through_list(opts) List container pull through remotes A Container Remote referencing a remote registry used as a source for the pull-through caching. @@ -228,14 +228,14 @@ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response. } begin #List container pull through remotes - result = api_instance.list(opts) + result = api_instance.remotes_container_pull_through_list(opts) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->list: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_list: #{e}" end ``` ### Parameters @@ -279,13 +279,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## list_roles +## remotes_container_pull_through_list_roles -> ObjectRolesResponse list_roles(container_container_pull_through_remote_href, opts) +> ObjectRolesResponse remotes_container_pull_through_list_roles(container_container_pull_through_remote_href, opts) List roles List roles assigned to this object. @@ -308,14 +308,14 @@ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response. } begin #List roles - result = api_instance.list_roles(container_container_pull_through_remote_href, opts) + result = api_instance.remotes_container_pull_through_list_roles(container_container_pull_through_remote_href, opts) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->list_roles: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_list_roles: #{e}" end ``` ### Parameters @@ -338,13 +338,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## my_permissions +## remotes_container_pull_through_my_permissions -> MyPermissionsResponse my_permissions(container_container_pull_through_remote_href, opts) +> MyPermissionsResponse remotes_container_pull_through_my_permissions(container_container_pull_through_remote_href, opts) List user permissions List permissions available to the current user on this object. @@ -367,14 +367,14 @@ 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(container_container_pull_through_remote_href, opts) + result = api_instance.remotes_container_pull_through_my_permissions(container_container_pull_through_remote_href, opts) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->my_permissions: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_my_permissions: #{e}" end ``` ### Parameters @@ -397,13 +397,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## partial_update +## remotes_container_pull_through_partial_update -> AsyncOperationResponse partial_update(container_container_pull_through_remote_href, patchedcontainer_container_pull_through_remote) +> AsyncOperationResponse remotes_container_pull_through_partial_update(container_container_pull_through_remote_href, patchedcontainer_container_pull_through_remote) Update a container pull through remote Trigger an asynchronous partial update task @@ -423,14 +423,14 @@ container_container_pull_through_remote_href = 'container_container_pull_through_remote_href_example' # String | patchedcontainer_container_pull_through_remote = PulpContainerClient::PatchedcontainerContainerPullThroughRemote.new # PatchedcontainerContainerPullThroughRemote | begin #Update a container pull through remote - result = api_instance.partial_update(container_container_pull_through_remote_href, patchedcontainer_container_pull_through_remote) + result = api_instance.remotes_container_pull_through_partial_update(container_container_pull_through_remote_href, patchedcontainer_container_pull_through_remote) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->partial_update: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_partial_update: #{e}" end ``` ### Parameters @@ -452,13 +452,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## read +## remotes_container_pull_through_read -> ContainerContainerPullThroughRemoteResponse read(container_container_pull_through_remote_href, opts) +> ContainerContainerPullThroughRemoteResponse remotes_container_pull_through_read(container_container_pull_through_remote_href, opts) Inspect a container pull through remote A Container Remote referencing a remote registry used as a source for the pull-through caching. @@ -481,14 +481,14 @@ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response. } begin #Inspect a container pull through remote - result = api_instance.read(container_container_pull_through_remote_href, opts) + result = api_instance.remotes_container_pull_through_read(container_container_pull_through_remote_href, opts) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->read: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_read: #{e}" end ``` ### Parameters @@ -511,13 +511,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## remove_role +## remotes_container_pull_through_remove_role -> NestedRoleResponse remove_role(container_container_pull_through_remote_href, nested_role) +> NestedRoleResponse remotes_container_pull_through_remove_role(container_container_pull_through_remote_href, nested_role) Remove a role Remove a role for this object from users/groups. @@ -537,14 +537,14 @@ container_container_pull_through_remote_href = 'container_container_pull_through_remote_href_example' # String | nested_role = PulpContainerClient::NestedRole.new # NestedRole | begin #Remove a role - result = api_instance.remove_role(container_container_pull_through_remote_href, nested_role) + result = api_instance.remotes_container_pull_through_remove_role(container_container_pull_through_remote_href, nested_role) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->remove_role: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_remove_role: #{e}" end ``` ### Parameters @@ -566,13 +566,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## set_label +## remotes_container_pull_through_set_label -> SetLabelResponse set_label(container_container_pull_through_remote_href, set_label) +> SetLabelResponse remotes_container_pull_through_set_label(container_container_pull_through_remote_href, set_label) Set a label Set a single pulp_label on the object to a specific value or null. @@ -592,14 +592,14 @@ container_container_pull_through_remote_href = 'container_container_pull_through_remote_href_example' # String | set_label = PulpContainerClient::SetLabel.new # SetLabel | begin #Set a label - result = api_instance.set_label(container_container_pull_through_remote_href, set_label) + result = api_instance.remotes_container_pull_through_set_label(container_container_pull_through_remote_href, set_label) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->set_label: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_set_label: #{e}" end ``` ### Parameters @@ -621,13 +621,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## unset_label +## remotes_container_pull_through_unset_label -> UnsetLabelResponse unset_label(container_container_pull_through_remote_href, unset_label) +> UnsetLabelResponse remotes_container_pull_through_unset_label(container_container_pull_through_remote_href, unset_label) Unset a label Unset a single pulp_label on the object. @@ -647,14 +647,14 @@ container_container_pull_through_remote_href = 'container_container_pull_through_remote_href_example' # String | unset_label = PulpContainerClient::UnsetLabel.new # UnsetLabel | begin #Unset a label - result = api_instance.unset_label(container_container_pull_through_remote_href, unset_label) + result = api_instance.remotes_container_pull_through_unset_label(container_container_pull_through_remote_href, unset_label) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->unset_label: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_unset_label: #{e}" end ``` ### Parameters @@ -676,13 +676,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## update +## remotes_container_pull_through_update -> AsyncOperationResponse update(container_container_pull_through_remote_href, container_container_pull_through_remote) +> AsyncOperationResponse remotes_container_pull_through_update(container_container_pull_through_remote_href, container_container_pull_through_remote) Update a container pull through remote Trigger an asynchronous update task @@ -702,13 +702,13 @@ container_container_pull_through_remote_href = 'container_container_pull_through_remote_href_example' # String | container_container_pull_through_remote = PulpContainerClient::ContainerContainerPullThroughRemote.new # ContainerContainerPullThroughRemote | begin #Update a container pull through remote - result = api_instance.update(container_container_pull_through_remote_href, container_container_pull_through_remote) + result = api_instance.remotes_container_pull_through_update(container_container_pull_through_remote_href, container_container_pull_through_remote) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling RemotesPullThroughApi->update: #{e}" + puts "Exception when calling RemotesPullThroughApi->remotes_container_pull_through_update: #{e}" end ``` ### Parameters