# PulpFileClient::PublicationsFileApi All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- [**add_role**](PublicationsFileApi.md#add_role) | **POST** {file_file_publication_href}add_role/ | Add a role [**create**](PublicationsFileApi.md#create) | **POST** /pulp/api/v3/publications/file/file/ | Create a file publication [**delete**](PublicationsFileApi.md#delete) | **DELETE** {file_file_publication_href} | Delete a file publication [**list**](PublicationsFileApi.md#list) | **GET** /pulp/api/v3/publications/file/file/ | List file publications [**list_roles**](PublicationsFileApi.md#list_roles) | **GET** {file_file_publication_href}list_roles/ | List roles [**my_permissions**](PublicationsFileApi.md#my_permissions) | **GET** {file_file_publication_href}my_permissions/ | List user permissions [**read**](PublicationsFileApi.md#read) | **GET** {file_file_publication_href} | Inspect a file publication [**remove_role**](PublicationsFileApi.md#remove_role) | **POST** {file_file_publication_href}remove_role/ | Remove a role ## add_role > NestedRoleResponse add_role(file_file_publication_href, nested_role) Add a role Add a role for this object to users/groups. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::PublicationsFileApi.new file_file_publication_href = 'file_file_publication_href_example' # String | nested_role = PulpFileClient::NestedRole.new # NestedRole | begin #Add a role result = api_instance.add_role(file_file_publication_href, nested_role) p result rescue PulpFileClient::ApiError => e puts "Exception when calling PublicationsFileApi->add_role: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_publication_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 > AsyncOperationResponse create(file_file_publication) Create a file publication Trigger an asynchronous task to publish file content. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::PublicationsFileApi.new file_file_publication = PulpFileClient::FileFilePublication.new # FileFilePublication | begin #Create a file publication result = api_instance.create(file_file_publication) p result rescue PulpFileClient::ApiError => e puts "Exception when calling PublicationsFileApi->create: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_publication** | [**FileFilePublication**](FileFilePublication.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 ## delete > delete(file_file_publication_href) Delete a file publication A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::PublicationsFileApi.new file_file_publication_href = 'file_file_publication_href_example' # String | begin #Delete a file publication api_instance.delete(file_file_publication_href) rescue PulpFileClient::ApiError => e puts "Exception when calling PublicationsFileApi->delete: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_publication_href** | **String**| | ### Return type nil (empty response body) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## list > PaginatedfileFilePublicationResponseList list(opts) List file publications A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::PublicationsFileApi.new opts = { content: 'content_example', # String | Content Unit referenced by HREF/PRN content__in: ['content__in_example'], # Array | Multiple values may be separated by commas. limit: 56, # Integer | Number of results to return per page. 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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `pk` - Pk * `-pk` - Pk (descending) prn__in: ['prn__in_example'], # Array | Multiple values may be separated by commas. pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created matches value pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array | Filter results where pulp_created is between two comma separated values 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 repository: 'repository_example', # String | Repository referenced by HREF/PRN repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN 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 publications result = api_instance.list(opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling PublicationsFileApi->list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **content** | **String**| Content Unit referenced by HREF/PRN | [optional] **content__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional] **limit** | **Integer**| Number of results to return per page. | [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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] **prn__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional] **pulp_created** | **DateTime**| Filter results where pulp_created matches value | [optional] **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional] **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional] **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional] **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional] **pulp_created__range** | [**Array<DateTime>**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [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] **repository** | **String**| Repository referenced by HREF/PRN | [optional] **repository_version** | [**String**](.md)| Repository Version referenced by HREF/PRN | [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 [**PaginatedfileFilePublicationResponseList**](PaginatedfileFilePublicationResponseList.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## list_roles > ObjectRolesResponse list_roles(file_file_publication_href, opts) List roles List roles assigned to this object. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::PublicationsFileApi.new file_file_publication_href = 'file_file_publication_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(file_file_publication_href, opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling PublicationsFileApi->list_roles: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_publication_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(file_file_publication_href, opts) List user permissions List permissions available to the current user on this object. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::PublicationsFileApi.new file_file_publication_href = 'file_file_publication_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(file_file_publication_href, opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling PublicationsFileApi->my_permissions: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_publication_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 ## read > FileFilePublicationResponse read(file_file_publication_href, opts) Inspect a file publication A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::PublicationsFileApi.new file_file_publication_href = 'file_file_publication_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 publication result = api_instance.read(file_file_publication_href, opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling PublicationsFileApi->read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_publication_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 [**FileFilePublicationResponse**](FileFilePublicationResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## remove_role > NestedRoleResponse remove_role(file_file_publication_href, nested_role) Remove a role Remove a role for this object from users/groups. ### Example ```ruby # load the gem require 'pulp_file_client' # setup authorization PulpFileClient.configure do |config| # Configure HTTP basic authorization: basicAuth config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = PulpFileClient::PublicationsFileApi.new file_file_publication_href = 'file_file_publication_href_example' # String | nested_role = PulpFileClient::NestedRole.new # NestedRole | begin #Remove a role result = api_instance.remove_role(file_file_publication_href, nested_role) p result rescue PulpFileClient::ApiError => e puts "Exception when calling PublicationsFileApi->remove_role: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_file_publication_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