# PulpFileClient::ExportersFileExportsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](ExportersFileExportsApi.md#create) | **POST** /pulp/api/v3/exporters/file/filesystem/{exporter_pk}/exports/ | Create an export
[**delete**](ExportersFileExportsApi.md#delete) | **DELETE** {export_href} | Delete an export
[**list**](ExportersFileExportsApi.md#list) | **GET** /pulp/api/v3/exporters/file/filesystem/{exporter_pk}/exports/ | List exports
[**read**](ExportersFileExportsApi.md#read) | **GET** {export_href} | Inspect an export



## create

> AsyncOperationResponse create(exporter_pk, data)

Create an export

Trigger an asynchronous task to export a file publication.

### 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::ExportersFileExportsApi.new
exporter_pk = 'exporter_pk_example' # String | 
data = PulpFileClient::PublicationExport.new # PublicationExport | 

begin
  #Create an export
  result = api_instance.create(exporter_pk, data)
  p result
rescue PulpFileClient::ApiError => e
  puts "Exception when calling ExportersFileExportsApi->create: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **exporter_pk** | **String**|  | 
 **data** | [**PublicationExport**](PublicationExport.md)|  | 

### Return type

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

### Authorization

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

### HTTP request headers

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


## delete

> delete(export_href)

Delete an export

FileSystemExports provide a history of previous exports.

### 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::ExportersFileExportsApi.new
export_href = 'export_href_example' # String | URI of Export. e.g.: /pulp/api/v3/exporters/file/filesystem/1/exports/1/

begin
  #Delete an export
  api_instance.delete(export_href)
rescue PulpFileClient::ApiError => e
  puts "Exception when calling ExportersFileExportsApi->delete: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **export_href** | **String**| URI of Export. e.g.: /pulp/api/v3/exporters/file/filesystem/1/exports/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(exporter_pk, opts)

List exports

FileSystemExports provide a history of previous exports.

### 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::ExportersFileExportsApi.new
exporter_pk = 'exporter_pk_example' # String | 
opts = {
  ordering: 'ordering_example', # String | Which field to use when ordering the results.
  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 exports
  result = api_instance.list(exporter_pk, opts)
  p result
rescue PulpFileClient::ApiError => e
  puts "Exception when calling ExportersFileExportsApi->list: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **exporter_pk** | **String**|  | 
 **ordering** | **String**| Which field to use when ordering the results. | [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

> Export read(export_href, opts)

Inspect an export

FileSystemExports provide a history of previous exports.

### 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::ExportersFileExportsApi.new
export_href = 'export_href_example' # String | URI of Export. e.g.: /pulp/api/v3/exporters/file/filesystem/1/exports/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 an export
  result = api_instance.read(export_href, opts)
  p result
rescue PulpFileClient::ApiError => e
  puts "Exception when calling ExportersFileExportsApi->read: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **export_href** | **String**| URI of Export. e.g.: /pulp/api/v3/exporters/file/filesystem/1/exports/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

[**Export**](Export.md)

### Authorization

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

### HTTP request headers

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