class PulpcoreClient::ExportersFilesystemExportsApi
Attributes
Public Class Methods
# File lib/pulpcore_client/api/exporters_filesystem_exports_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a filesystem export Trigger an asynchronous task to export files to the filesystem @param filesystem_exporter_href [String] @param filesystem_export [FilesystemExport] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulpcore_client/api/exporters_filesystem_exports_api.rb, line 28 def create(filesystem_exporter_href, filesystem_export, opts = {}) data, _status_code, _headers = create_with_http_info(filesystem_exporter_href, filesystem_export, opts) data end
Create a filesystem export Trigger an asynchronous task to export files to the filesystem @param filesystem_exporter_href [String] @param filesystem_export [FilesystemExport] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse
, Integer, Hash)>] AsyncOperationResponse
data, response status code and response headers
# File lib/pulpcore_client/api/exporters_filesystem_exports_api.rb, line 39 def create_with_http_info(filesystem_exporter_href, filesystem_export, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExportersFilesystemExportsApi.create ...' end # verify the required parameter 'filesystem_exporter_href' is set if @api_client.config.client_side_validation && filesystem_exporter_href.nil? fail ArgumentError, "Missing the required parameter 'filesystem_exporter_href' when calling ExportersFilesystemExportsApi.create" end # verify the required parameter 'filesystem_export' is set if @api_client.config.client_side_validation && filesystem_export.nil? fail ArgumentError, "Missing the required parameter 'filesystem_export' when calling ExportersFilesystemExportsApi.create" end # resource path local_var_path = '{filesystem_exporter_href}exports/'.sub('{' + 'filesystem_exporter_href' + '}', CGI.escape(filesystem_exporter_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(filesystem_export) # return_type return_type = opts[:return_type] || 'AsyncOperationResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ExportersFilesystemExportsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a filesystem export Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview. @param filesystem_filesystem_export_href [String] @param [Hash] opts the optional parameters @return [nil]
# File lib/pulpcore_client/api/exporters_filesystem_exports_api.rb, line 97 def delete(filesystem_filesystem_export_href, opts = {}) delete_with_http_info(filesystem_filesystem_export_href, opts) nil end
Delete a filesystem export Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview. @param filesystem_filesystem_export_href [String] @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/pulpcore_client/api/exporters_filesystem_exports_api.rb, line 107 def delete_with_http_info(filesystem_filesystem_export_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExportersFilesystemExportsApi.delete ...' end # verify the required parameter 'filesystem_filesystem_export_href' is set if @api_client.config.client_side_validation && filesystem_filesystem_export_href.nil? fail ArgumentError, "Missing the required parameter 'filesystem_filesystem_export_href' when calling ExportersFilesystemExportsApi.delete" end # resource path local_var_path = '{filesystem_filesystem_export_href}'.sub('{' + 'filesystem_filesystem_export_href' + '}', CGI.escape(filesystem_filesystem_export_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['basicAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ExportersFilesystemExportsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List filesystem exports Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview. @param filesystem_exporter_href [String] @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [PaginatedFilesystemExportResponseList]
# File lib/pulpcore_client/api/exporters_filesystem_exports_api.rb, line 162 def list(filesystem_exporter_href, opts = {}) data, _status_code, _headers = list_with_http_info(filesystem_exporter_href, opts) data end
List filesystem exports Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview. @param filesystem_exporter_href [String] @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(PaginatedFilesystemExportResponseList
, Integer, Hash)>] PaginatedFilesystemExportResponseList
data, response status code and response headers
# File lib/pulpcore_client/api/exporters_filesystem_exports_api.rb, line 177 def list_with_http_info(filesystem_exporter_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExportersFilesystemExportsApi.list ...' end # verify the required parameter 'filesystem_exporter_href' is set if @api_client.config.client_side_validation && filesystem_exporter_href.nil? fail ArgumentError, "Missing the required parameter 'filesystem_exporter_href' when calling ExportersFilesystemExportsApi.list" end # resource path local_var_path = '{filesystem_exporter_href}exports/'.sub('{' + 'filesystem_exporter_href' + '}', CGI.escape(filesystem_exporter_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil? query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil? query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PaginatedFilesystemExportResponseList' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ExportersFilesystemExportsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Inspect a filesystem export Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview. @param filesystem_filesystem_export_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [FilesystemExportResponse]
# File lib/pulpcore_client/api/exporters_filesystem_exports_api.rb, line 236 def read(filesystem_filesystem_export_href, opts = {}) data, _status_code, _headers = read_with_http_info(filesystem_filesystem_export_href, opts) data end
Inspect a filesystem export Endpoint for managing FilesystemExports. This endpoint is provided as a tech preview. @param filesystem_filesystem_export_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(FilesystemExportResponse
, Integer, Hash)>] FilesystemExportResponse
data, response status code and response headers
# File lib/pulpcore_client/api/exporters_filesystem_exports_api.rb, line 248 def read_with_http_info(filesystem_filesystem_export_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExportersFilesystemExportsApi.read ...' end # verify the required parameter 'filesystem_filesystem_export_href' is set if @api_client.config.client_side_validation && filesystem_filesystem_export_href.nil? fail ArgumentError, "Missing the required parameter 'filesystem_filesystem_export_href' when calling ExportersFilesystemExportsApi.read" end # resource path local_var_path = '{filesystem_filesystem_export_href}'.sub('{' + 'filesystem_filesystem_export_href' + '}', CGI.escape(filesystem_filesystem_export_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil? query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'FilesystemExportResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ExportersFilesystemExportsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end