# PulpcoreClient::UpstreamPulpsApi All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- [**add_role**](UpstreamPulpsApi.md#add_role) | **POST** {upstream_pulp_href}add_role/ | Add a role [**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 [**list_roles**](UpstreamPulpsApi.md#list_roles) | **GET** {upstream_pulp_href}list_roles/ | List roles [**my_permissions**](UpstreamPulpsApi.md#my_permissions) | **GET** {upstream_pulp_href}my_permissions/ | List user permissions [**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 [**remove_role**](UpstreamPulpsApi.md#remove_role) | **POST** {upstream_pulp_href}remove_role/ | Remove a role [**replicate**](UpstreamPulpsApi.md#replicate) | **POST** {upstream_pulp_href}replicate/ | Replicate [**update**](UpstreamPulpsApi.md#update) | **PUT** {upstream_pulp_href} | Update an upstream pulp ## add_role > NestedRoleResponse add_role(upstream_pulp_href, nested_role) Add a role Add a role for this object to users/groups. ### Example ```ruby # load the gem require 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp_href = 'upstream_pulp_href_example' # String | nested_role = PulpcoreClient::NestedRole.new # NestedRole | begin #Add a role result = api_instance.add_role(upstream_pulp_href, nested_role) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling UpstreamPulpsApi->add_role: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **upstream_pulp_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 > 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 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp = PulpcoreClient::UpstreamPulp.new # UpstreamPulp | begin #Create an upstream pulp result = api_instance.create(upstream_pulp) p result rescue PulpcoreClient::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 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp_href = 'upstream_pulp_href_example' # String | begin #Delete an upstream pulp api_instance.delete(upstream_pulp_href) rescue PulpcoreClient::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 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new opts = { base_url: 'base_url_example', # String | Filter results where base_url matches value base_url__contains: 'base_url__contains_example', # String | Filter results where base_url contains value base_url__icontains: 'base_url__icontains_example', # String | Filter results where base_url contains value base_url__iexact: 'base_url__iexact_example', # String | Filter results where base_url matches value base_url__in: ['base_url__in_example'], # Array | Filter results where base_url is in a comma-separated list of values base_url__iregex: 'base_url__iregex_example', # String | Filter results where base_url matches regex value base_url__istartswith: 'base_url__istartswith_example', # String | Filter results where base_url starts with value base_url__regex: 'base_url__regex_example', # String | Filter results where base_url matches regex value base_url__startswith: 'base_url__startswith_example', # String | Filter results where base_url starts with value last_replication: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_replication matches value last_replication__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_replication is greater than value last_replication__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_replication is greater than or equal to value last_replication__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_replication is less than value last_replication__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_replication is less than or equal to value last_replication__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array | Filter results where last_replication is between two comma separated values 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 name__icontains: 'name__icontains_example', # String | Filter results where name contains value name__iexact: 'name__iexact_example', # String | Filter results where name matches value name__in: ['name__in_example'], # Array | Filter results where name is in a comma-separated list of values name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value name__regex: 'name__regex_example', # String | Filter results where name matches regex value name__startswith: 'name__startswith_example', # String | Filter results where name starts with value offset: 56, # Integer | The initial index from which to return the results. ordering: ['ordering_example'], # Array | 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) * `name` - Name * `-name` - Name (descending) * `base_url` - Base url * `-base_url` - Base url (descending) * `api_root` - Api root * `-api_root` - Api root (descending) * `domain` - Domain * `-domain` - Domain (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `pulp_label_select` - Pulp label select * `-pulp_label_select` - Pulp label select (descending) * `q_select` - Q select * `-q_select` - Q select (descending) * `last_replication` - Last replication * `-last_replication` - Last replication (descending) * `pk` - Pk * `-pk` - Pk (descending) pulp_href__in: ['pulp_href__in_example'], # Array | Multiple values may be separated by commas. pulp_id__in: ['pulp_id__in_example'], # Array | Multiple values may be separated by commas. q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | A list of fields to exclude from the response. } begin #List upstream pulps result = api_instance.list(opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling UpstreamPulpsApi->list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **base_url** | **String**| Filter results where base_url matches value | [optional] **base_url__contains** | **String**| Filter results where base_url contains value | [optional] **base_url__icontains** | **String**| Filter results where base_url contains value | [optional] **base_url__iexact** | **String**| Filter results where base_url matches value | [optional] **base_url__in** | [**Array<String>**](String.md)| Filter results where base_url is in a comma-separated list of values | [optional] **base_url__iregex** | **String**| Filter results where base_url matches regex value | [optional] **base_url__istartswith** | **String**| Filter results where base_url starts with value | [optional] **base_url__regex** | **String**| Filter results where base_url matches regex value | [optional] **base_url__startswith** | **String**| Filter results where base_url starts with value | [optional] **last_replication** | **DateTime**| Filter results where last_replication matches value | [optional] **last_replication__gt** | **DateTime**| Filter results where last_replication is greater than value | [optional] **last_replication__gte** | **DateTime**| Filter results where last_replication is greater than or equal to value | [optional] **last_replication__lt** | **DateTime**| Filter results where last_replication is less than value | [optional] **last_replication__lte** | **DateTime**| Filter results where last_replication is less than or equal to value | [optional] **last_replication__range** | [**Array<DateTime>**](DateTime.md)| Filter results where last_replication is between two comma separated values | [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] **name__icontains** | **String**| Filter results where name contains value | [optional] **name__iexact** | **String**| Filter results where name matches value | [optional] **name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional] **name__iregex** | **String**| Filter results where name matches regex value | [optional] **name__istartswith** | **String**| Filter results where name starts with value | [optional] **name__regex** | **String**| Filter results where name matches regex value | [optional] **name__startswith** | **String**| Filter results where name starts with value | [optional] **offset** | **Integer**| The initial index from which to return the results. | [optional] **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) * `name` - Name * `-name` - Name (descending) * `base_url` - Base url * `-base_url` - Base url (descending) * `api_root` - Api root * `-api_root` - Api root (descending) * `domain` - Domain * `-domain` - Domain (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `pulp_label_select` - Pulp label select * `-pulp_label_select` - Pulp label select (descending) * `q_select` - Q select * `-q_select` - Q select (descending) * `last_replication` - Last replication * `-last_replication` - Last replication (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] **pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional] **pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional] **q** | **String**| Filter results by using NOT, AND and OR operations on other filters | [optional] **fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional] **exclude_fields** | [**Array<String>**](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 ## list_roles > ObjectRolesResponse list_roles(upstream_pulp_href, opts) List roles List roles assigned to this object. ### Example ```ruby # load the gem require 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp_href = 'upstream_pulp_href_example' # String | opts = { fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | A list of fields to exclude from the response. } begin #List roles result = api_instance.list_roles(upstream_pulp_href, opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling UpstreamPulpsApi->list_roles: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **upstream_pulp_href** | **String**| | **fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional] **exclude_fields** | [**Array<String>**](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(upstream_pulp_href, opts) List user permissions List permissions available to the current user on this object. ### Example ```ruby # load the gem require 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp_href = 'upstream_pulp_href_example' # String | opts = { fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | A list of fields to exclude from the response. } begin #List user permissions result = api_instance.my_permissions(upstream_pulp_href, opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling UpstreamPulpsApi->my_permissions: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **upstream_pulp_href** | **String**| | **fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional] **exclude_fields** | [**Array<String>**](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 > 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 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp_href = 'upstream_pulp_href_example' # String | patched_upstream_pulp = PulpcoreClient::PatchedUpstreamPulp.new # PatchedUpstreamPulp | begin #Update an upstream pulp result = api_instance.partial_update(upstream_pulp_href, patched_upstream_pulp) p result rescue PulpcoreClient::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 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp_href = 'upstream_pulp_href_example' # String | opts = { fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | 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 PulpcoreClient::ApiError => e puts "Exception when calling UpstreamPulpsApi->read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **upstream_pulp_href** | **String**| | **fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional] **exclude_fields** | [**Array<String>**](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 ## remove_role > NestedRoleResponse remove_role(upstream_pulp_href, nested_role) Remove a role Remove a role for this object from users/groups. ### Example ```ruby # load the gem require 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp_href = 'upstream_pulp_href_example' # String | nested_role = PulpcoreClient::NestedRole.new # NestedRole | begin #Remove a role result = api_instance.remove_role(upstream_pulp_href, nested_role) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling UpstreamPulpsApi->remove_role: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **upstream_pulp_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 ## replicate > TaskGroupOperationResponse replicate(upstream_pulp_href) Replicate Trigger an asynchronous repository replication task group. This API is provided as a tech preview. ### Example ```ruby # load the gem require 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp_href = 'upstream_pulp_href_example' # String | begin #Replicate result = api_instance.replicate(upstream_pulp_href) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling UpstreamPulpsApi->replicate: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **upstream_pulp_href** | **String**| | ### Return type [**TaskGroupOperationResponse**](TaskGroupOperationResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **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 'pulpcore_client' # setup authorization PulpcoreClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpcoreClient::UpstreamPulpsApi.new upstream_pulp_href = 'upstream_pulp_href_example' # String | upstream_pulp = PulpcoreClient::UpstreamPulp.new # UpstreamPulp | begin #Update an upstream pulp result = api_instance.update(upstream_pulp_href, upstream_pulp) p result rescue PulpcoreClient::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