pulpcore_client 3.69.2 → 3.70.0

data/docs/ExportersFilesystemExportsApi.md

@@ -2,27 +2,26 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ExportersFilesystemExportsApi.md#create) | **POST** {filesystem_exporter_href}exports/ | Create a filesystem export
-[**delete**](ExportersFilesystemExportsApi.md#delete) | **DELETE** {filesystem_filesystem_export_href} | Delete a filesystem export
-[**list**](ExportersFilesystemExportsApi.md#list) | **GET** {filesystem_exporter_href}exports/ | List filesystem exports
-[**read**](ExportersFilesystemExportsApi.md#read) | **GET** {filesystem_filesystem_export_href} | Inspect a filesystem export
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](ExportersFilesystemExportsApi.md#create) | **POST** {filesystem_exporter_href}exports/ | Create a filesystem export |
+| [**delete**](ExportersFilesystemExportsApi.md#delete) | **DELETE** {filesystem_filesystem_export_href} | Delete a filesystem export |
+| [**list**](ExportersFilesystemExportsApi.md#list) | **GET** {filesystem_exporter_href}exports/ | List filesystem exports |
+| [**read**](ExportersFilesystemExportsApi.md#read) | **GET** {filesystem_filesystem_export_href} | Inspect a filesystem export |
 
 
 ## create
 
-> AsyncOperationResponse create(filesystem_exporter_href, filesystem_export)
+> <AsyncOperationResponse> create(filesystem_exporter_href, filesystem_export)
 
 Create a filesystem export
 
 Trigger an asynchronous task to export files to the filesystem
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -36,21 +35,38 @@ filesystem_exporter_href = 'filesystem_exporter_href_example' # String |
 filesystem_export = PulpcoreClient::FilesystemExport.new # FilesystemExport | 
 
 begin
-  #Create a filesystem export
+  # Create a filesystem export
   result = api_instance.create(filesystem_exporter_href, filesystem_export)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemExportsApi->create: #{e}"
+  puts "Error when calling ExportersFilesystemExportsApi->create: #{e}"
 end
 ```
 
-### Parameters
+#### Using the create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(filesystem_exporter_href, filesystem_export)
+
+```ruby
+begin
+  # Create a filesystem export
+  data, status_code, headers = api_instance.create_with_http_info(filesystem_exporter_href, filesystem_export)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersFilesystemExportsApi->create_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_exporter_href** | **String**|  | 
- **filesystem_export** | [**FilesystemExport**](FilesystemExport.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filesystem_exporter_href** | **String** |  |  |
+| **filesystem_export** | [**FilesystemExport**](FilesystemExport.md) |  |  |
 
 ### Return type
 
@@ -74,10 +90,10 @@ Delete a filesystem export
 
 Endpoint for managing FilesystemExports.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -90,19 +106,36 @@ api_instance = PulpcoreClient::ExportersFilesystemExportsApi.new
 filesystem_filesystem_export_href = 'filesystem_filesystem_export_href_example' # String | 
 
 begin
-  #Delete a filesystem export
+  # Delete a filesystem export
   api_instance.delete(filesystem_filesystem_export_href)
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemExportsApi->delete: #{e}"
+  puts "Error when calling ExportersFilesystemExportsApi->delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_with_http_info(filesystem_filesystem_export_href)
+
+```ruby
+begin
+  # Delete a filesystem export
+  data, status_code, headers = api_instance.delete_with_http_info(filesystem_filesystem_export_href)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersFilesystemExportsApi->delete_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_filesystem_export_href** | **String**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filesystem_filesystem_export_href** | **String** |  |  |
 
 ### Return type
 
@@ -120,16 +153,16 @@ nil (empty response body)
 
 ## list
 
-> PaginatedFilesystemExportResponseList list(filesystem_exporter_href, opts)
+> <PaginatedFilesystemExportResponseList> list(filesystem_exporter_href, opts)
 
 List filesystem exports
 
 Endpoint for managing FilesystemExports.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -143,29 +176,46 @@ filesystem_exporter_href = 'filesystem_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<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List filesystem exports
+  # List filesystem exports
   result = api_instance.list(filesystem_exporter_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemExportsApi->list: #{e}"
+  puts "Error when calling ExportersFilesystemExportsApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedFilesystemExportResponseList>, Integer, Hash)> list_with_http_info(filesystem_exporter_href, opts)
+
+```ruby
+begin
+  # List filesystem exports
+  data, status_code, headers = api_instance.list_with_http_info(filesystem_exporter_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedFilesystemExportResponseList>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersFilesystemExportsApi->list_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_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&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filesystem_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&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type
 
@@ -183,16 +233,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> FilesystemExportResponse read(filesystem_filesystem_export_href, opts)
+> <FilesystemExportResponse> read(filesystem_filesystem_export_href, opts)
 
 Inspect a filesystem export
 
 Endpoint for managing FilesystemExports.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -204,27 +254,44 @@ end
 api_instance = PulpcoreClient::ExportersFilesystemExportsApi.new
 filesystem_filesystem_export_href = 'filesystem_filesystem_export_href_example' # String | 
 opts = {
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #Inspect a filesystem export
+  # Inspect a filesystem export
   result = api_instance.read(filesystem_filesystem_export_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemExportsApi->read: #{e}"
+  puts "Error when calling ExportersFilesystemExportsApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FilesystemExportResponse>, Integer, Hash)> read_with_http_info(filesystem_filesystem_export_href, opts)
+
+```ruby
+begin
+  # Inspect a filesystem export
+  data, status_code, headers = api_instance.read_with_http_info(filesystem_filesystem_export_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FilesystemExportResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling ExportersFilesystemExportsApi->read_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_filesystem_export_href** | **String**|  | 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filesystem_filesystem_export_href** | **String** |  |  |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type