# PulpFileClient::PublicationsFileApi

All URIs are relative to *http://localhost:24817*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](PublicationsFileApi.md#create) | **POST** /pulp/api/v3/publications/file/file/ | Create a file publication
[**delete**](PublicationsFileApi.md#delete) | **DELETE** {file_publication_href} | Delete a file publication
[**list**](PublicationsFileApi.md#list) | **GET** /pulp/api/v3/publications/file/file/ | List file publications
[**read**](PublicationsFileApi.md#read) | **GET** {file_publication_href} | Inspect a file publication



## create

> AsyncOperationResponse create(data)

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: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpFileClient::PublicationsFileApi.new
data = PulpFileClient::FileFilePublication.new # FileFilePublication | 

begin
  #Create a file publication
  result = api_instance.create(data)
  p result
rescue PulpFileClient::ApiError => e
  puts "Exception when calling PublicationsFileApi->create: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **data** | [**FileFilePublication**](FileFilePublication.md)|  | 

### Return type

[**AsyncOperationResponse**](AsyncOperationResponse.md)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## delete

> delete(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: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpFileClient::PublicationsFileApi.new
file_publication_href = 'file_publication_href_example' # String | URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/

begin
  #Delete a file publication
  api_instance.delete(file_publication_href)
rescue PulpFileClient::ApiError => e
  puts "Exception when calling PublicationsFileApi->delete: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **file_publication_href** | **String**| URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/ | 

### Return type

nil (empty response body)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined


## list

> InlineResponse2003 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: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpFileClient::PublicationsFileApi.new
opts = {
  ordering: 'ordering_example', # String | Which field to use when ordering the results.
  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
  pulp_created__lt: 'pulp_created__lt_example', # String | Filter results where pulp_created is less than value
  pulp_created__lte: 'pulp_created__lte_example', # String | Filter results where pulp_created is less than or equal to value
  pulp_created__gt: 'pulp_created__gt_example', # String | Filter results where pulp_created is greater than value
  pulp_created__gte: 'pulp_created__gte_example', # String | Filter results where pulp_created is greater than or equal to value
  pulp_created__range: 'pulp_created__range_example', # String | Filter results where pulp_created is between two comma separated values
  pulp_created: 'pulp_created_example', # String | ISO 8601 formatted dates are supported
  limit: 56, # Integer | Number of results to return per page.
  offset: 56, # Integer | The initial index from which to return the results.
  fields: 'fields_example', # String | A list of fields to include in the response.
  exclude_fields: 'exclude_fields_example' # String | 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
------------- | ------------- | ------------- | -------------
 **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
 **pulp_created__lt** | **String**| Filter results where pulp_created is less than value | [optional] 
 **pulp_created__lte** | **String**| Filter results where pulp_created is less than or equal to value | [optional] 
 **pulp_created__gt** | **String**| Filter results where pulp_created is greater than value | [optional] 
 **pulp_created__gte** | **String**| Filter results where pulp_created is greater than or equal to value | [optional] 
 **pulp_created__range** | **String**| Filter results where pulp_created is between two comma separated values | [optional] 
 **pulp_created** | **String**| ISO 8601 formatted dates are supported | [optional] 
 **limit** | **Integer**| Number of results to return per page. | [optional] 
 **offset** | **Integer**| The initial index from which to return the results. | [optional] 
 **fields** | **String**| A list of fields to include in the response. | [optional] 
 **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 

### Return type

[**InlineResponse2003**](InlineResponse2003.md)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## read

> FileFilePublication read(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: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpFileClient::PublicationsFileApi.new
file_publication_href = 'file_publication_href_example' # String | URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/
opts = {
  fields: 'fields_example', # String | A list of fields to include in the response.
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
}

begin
  #Inspect a file publication
  result = api_instance.read(file_publication_href, opts)
  p result
rescue PulpFileClient::ApiError => e
  puts "Exception when calling PublicationsFileApi->read: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **file_publication_href** | **String**| URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/ | 
 **fields** | **String**| A list of fields to include in the response. | [optional] 
 **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 

### Return type

[**FileFilePublication**](FileFilePublication.md)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json