# PulpFileClient::ExportersPulpExportsApi All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- [**exporters_core_pulp_exports_create**](ExportersPulpExportsApi.md#exporters_core_pulp_exports_create) | **POST** {pulp_exporter_href}exports/ | Create a pulp export [**exporters_core_pulp_exports_delete**](ExportersPulpExportsApi.md#exporters_core_pulp_exports_delete) | **DELETE** {pulp_pulp_export_href} | Delete a pulp export [**exporters_core_pulp_exports_list**](ExportersPulpExportsApi.md#exporters_core_pulp_exports_list) | **GET** {pulp_exporter_href}exports/ | List pulp exports [**exporters_core_pulp_exports_read**](ExportersPulpExportsApi.md#exporters_core_pulp_exports_read) | **GET** {pulp_pulp_export_href} | Inspect a pulp export ## exporters_core_pulp_exports_create > AsyncOperationResponse exporters_core_pulp_exports_create(pulp_exporter_href, pulp_export) Create a pulp export Trigger an asynchronous task to export a set of repositories ### 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::ExportersPulpExportsApi.new pulp_exporter_href = 'pulp_exporter_href_example' # String | pulp_export = PulpFileClient::PulpExport.new # PulpExport | begin #Create a pulp export result = api_instance.exporters_core_pulp_exports_create(pulp_exporter_href, pulp_export) p result rescue PulpFileClient::ApiError => e puts "Exception when calling ExportersPulpExportsApi->exporters_core_pulp_exports_create: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pulp_exporter_href** | **String**| | **pulp_export** | [**PulpExport**](PulpExport.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 ## exporters_core_pulp_exports_delete > exporters_core_pulp_exports_delete(pulp_pulp_export_href) Delete a pulp export ViewSet for viewing exports from a PulpExporter. ### 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::ExportersPulpExportsApi.new pulp_pulp_export_href = 'pulp_pulp_export_href_example' # String | begin #Delete a pulp export api_instance.exporters_core_pulp_exports_delete(pulp_pulp_export_href) rescue PulpFileClient::ApiError => e puts "Exception when calling ExportersPulpExportsApi->exporters_core_pulp_exports_delete: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pulp_pulp_export_href** | **String**| | ### Return type nil (empty response body) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## exporters_core_pulp_exports_list > PaginatedPulpExportResponseList exporters_core_pulp_exports_list(pulp_exporter_href, opts) List pulp exports ViewSet for viewing exports from a PulpExporter. ### 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::ExportersPulpExportsApi.new pulp_exporter_href = 'pulp_exporter_href_example' # String | opts = { 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'], # 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 pulp exports result = api_instance.exporters_core_pulp_exports_list(pulp_exporter_href, opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling ExportersPulpExportsApi->exporters_core_pulp_exports_list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pulp_exporter_href** | **String**| | **limit** | **Integer**| Number of results to return per page. | [optional] **offset** | **Integer**| The initial index from which to return the results. | [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 [**PaginatedPulpExportResponseList**](PaginatedPulpExportResponseList.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## exporters_core_pulp_exports_read > PulpExportResponse exporters_core_pulp_exports_read(pulp_pulp_export_href, opts) Inspect a pulp export ViewSet for viewing exports from a PulpExporter. ### 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::ExportersPulpExportsApi.new pulp_pulp_export_href = 'pulp_pulp_export_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 pulp export result = api_instance.exporters_core_pulp_exports_read(pulp_pulp_export_href, opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling ExportersPulpExportsApi->exporters_core_pulp_exports_read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pulp_pulp_export_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 [**PulpExportResponse**](PulpExportResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json