# PulpcoreClient::DistributionsFileApi All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- [**distributions_file_file_add_role**](DistributionsFileApi.md#distributions_file_file_add_role) | **POST** {file_file_distribution_href}add_role/ | Add a role [**distributions_file_file_create**](DistributionsFileApi.md#distributions_file_file_create) | **POST** /pulp/api/v3/distributions/file/file/ | Create a file distribution [**distributions_file_file_delete**](DistributionsFileApi.md#distributions_file_file_delete) | **DELETE** {file_file_distribution_href} | Delete a file distribution [**distributions_file_file_list**](DistributionsFileApi.md#distributions_file_file_list) | **GET** /pulp/api/v3/distributions/file/file/ | List file distributions [**distributions_file_file_list_roles**](DistributionsFileApi.md#distributions_file_file_list_roles) | **GET** {file_file_distribution_href}list_roles/ | List roles [**distributions_file_file_my_permissions**](DistributionsFileApi.md#distributions_file_file_my_permissions) | **GET** {file_file_distribution_href}my_permissions/ | List user permissions [**distributions_file_file_partial_update**](DistributionsFileApi.md#distributions_file_file_partial_update) | **PATCH** {file_file_distribution_href} | Update a file distribution [**distributions_file_file_read**](DistributionsFileApi.md#distributions_file_file_read) | **GET** {file_file_distribution_href} | Inspect a file distribution [**distributions_file_file_remove_role**](DistributionsFileApi.md#distributions_file_file_remove_role) | **POST** {file_file_distribution_href}remove_role/ | Remove a role [**distributions_file_file_set_label**](DistributionsFileApi.md#distributions_file_file_set_label) | **POST** {file_file_distribution_href}set_label/ | Set a label [**distributions_file_file_unset_label**](DistributionsFileApi.md#distributions_file_file_unset_label) | **POST** {file_file_distribution_href}unset_label/ | Unset a label [**distributions_file_file_update**](DistributionsFileApi.md#distributions_file_file_update) | **PUT** {file_file_distribution_href} | Update a file distribution ## distributions_file_file_add_role > NestedRoleResponse distributions_file_file_add_role(file_file_distribution_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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_href_example' # String | nested_role = PulpcoreClient::NestedRole.new # NestedRole | begin #Add a role result = api_instance.distributions_file_file_add_role(file_file_distribution_href, nested_role) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_add_role: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_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 ## distributions_file_file_create > AsyncOperationResponse distributions_file_file_create(file_file_distribution) Create a file distribution Trigger an asynchronous create task ### 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::DistributionsFileApi.new file_file_distribution = PulpcoreClient::FileFileDistribution.new # FileFileDistribution | begin #Create a file distribution result = api_instance.distributions_file_file_create(file_file_distribution) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_create: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution** | [**FileFileDistribution**](FileFileDistribution.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 ## distributions_file_file_delete > AsyncOperationResponse distributions_file_file_delete(file_file_distribution_href) Delete a file distribution Trigger an asynchronous delete task ### 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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_href_example' # String | begin #Delete a file distribution result = api_instance.distributions_file_file_delete(file_file_distribution_href) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_delete: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_href** | **String**| | ### Return type [**AsyncOperationResponse**](AsyncOperationResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## distributions_file_file_list > PaginatedfileFileDistributionResponseList distributions_file_file_list(opts) List file distributions FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content. ### 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::DistributionsFileApi.new opts = { base_path: 'base_path_example', # String | Filter results where base_path matches value base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value base_path__in: ['base_path__in_example'], # Array | Filter results where base_path is in a comma-separated list of 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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (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. pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string q: 'q_example', # String | repository: 'repository_example', # String | Filter results where repository matches value repository__in: ['repository__in_example'], # Array | Filter results where repository is in a comma-separated list of values with_content: 'with_content_example', # String | Filter distributions based on the content served by them 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 file distributions result = api_instance.distributions_file_file_list(opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **base_path** | **String**| Filter results where base_path matches value | [optional] **base_path__contains** | **String**| Filter results where base_path contains value | [optional] **base_path__icontains** | **String**| Filter results where base_path contains value | [optional] **base_path__in** | [**Array<String>**](String.md)| Filter results where base_path is in a comma-separated list of 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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (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] **pulp_label_select** | **String**| Filter labels by search string | [optional] **q** | **String**| | [optional] **repository** | [**String**](.md)| Filter results where repository matches value | [optional] **repository__in** | [**Array<String>**](String.md)| Filter results where repository is in a comma-separated list of values | [optional] **with_content** | **String**| Filter distributions based on the content served by them | [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 [**PaginatedfileFileDistributionResponseList**](PaginatedfileFileDistributionResponseList.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## distributions_file_file_list_roles > ObjectRolesResponse distributions_file_file_list_roles(file_file_distribution_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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_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.distributions_file_file_list_roles(file_file_distribution_href, opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_list_roles: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_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 ## distributions_file_file_my_permissions > MyPermissionsResponse distributions_file_file_my_permissions(file_file_distribution_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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_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.distributions_file_file_my_permissions(file_file_distribution_href, opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_my_permissions: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_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 ## distributions_file_file_partial_update > AsyncOperationResponse distributions_file_file_partial_update(file_file_distribution_href, patchedfile_file_distribution) Update a file distribution Trigger an asynchronous partial update task ### 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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_href_example' # String | patchedfile_file_distribution = PulpcoreClient::PatchedfileFileDistribution.new # PatchedfileFileDistribution | begin #Update a file distribution result = api_instance.distributions_file_file_partial_update(file_file_distribution_href, patchedfile_file_distribution) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_partial_update: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_href** | **String**| | **patchedfile_file_distribution** | [**PatchedfileFileDistribution**](PatchedfileFileDistribution.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 ## distributions_file_file_read > FileFileDistributionResponse distributions_file_file_read(file_file_distribution_href, opts) Inspect a file distribution FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content. ### 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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_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 a file distribution result = api_instance.distributions_file_file_read(file_file_distribution_href, opts) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_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 [**FileFileDistributionResponse**](FileFileDistributionResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## distributions_file_file_remove_role > NestedRoleResponse distributions_file_file_remove_role(file_file_distribution_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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_href_example' # String | nested_role = PulpcoreClient::NestedRole.new # NestedRole | begin #Remove a role result = api_instance.distributions_file_file_remove_role(file_file_distribution_href, nested_role) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_remove_role: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_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 ## distributions_file_file_set_label > SetLabelResponse distributions_file_file_set_label(file_file_distribution_href, set_label) Set a label Set a single pulp_label on the object to a specific value or null. ### 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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_href_example' # String | set_label = PulpcoreClient::SetLabel.new # SetLabel | begin #Set a label result = api_instance.distributions_file_file_set_label(file_file_distribution_href, set_label) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_set_label: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_href** | **String**| | **set_label** | [**SetLabel**](SetLabel.md)| | ### Return type [**SetLabelResponse**](SetLabelResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## distributions_file_file_unset_label > UnsetLabelResponse distributions_file_file_unset_label(file_file_distribution_href, unset_label) Unset a label Unset a single pulp_label on the 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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_href_example' # String | unset_label = PulpcoreClient::UnsetLabel.new # UnsetLabel | begin #Unset a label result = api_instance.distributions_file_file_unset_label(file_file_distribution_href, unset_label) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_unset_label: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_href** | **String**| | **unset_label** | [**UnsetLabel**](UnsetLabel.md)| | ### Return type [**UnsetLabelResponse**](UnsetLabelResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## distributions_file_file_update > AsyncOperationResponse distributions_file_file_update(file_file_distribution_href, file_file_distribution) Update a file distribution Trigger an asynchronous update task ### 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::DistributionsFileApi.new file_file_distribution_href = 'file_file_distribution_href_example' # String | file_file_distribution = PulpcoreClient::FileFileDistribution.new # FileFileDistribution | begin #Update a file distribution result = api_instance.distributions_file_file_update(file_file_distribution_href, file_file_distribution) p result rescue PulpcoreClient::ApiError => e puts "Exception when calling DistributionsFileApi->distributions_file_file_update: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_distribution_href** | **String**| | **file_file_distribution** | [**FileFileDistribution**](FileFileDistribution.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