class PulpFileClient::PublicationsFileApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pulp_file_client/api/publications_file_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create(file_file_publication, opts = {}) click to toggle source

Create a file publication Trigger an asynchronous task to publish file content. @param file_file_publication [FileFilePublication] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_file_client/api/publications_file_api.rb, line 27
def create(file_file_publication, opts = {})
  data, _status_code, _headers = create_with_http_info(file_file_publication, opts)
  data
end
create_with_http_info(file_file_publication, opts = {}) click to toggle source

Create a file publication Trigger an asynchronous task to publish file content. @param file_file_publication [FileFilePublication] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_file_client/api/publications_file_api.rb, line 37
def create_with_http_info(file_file_publication, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsFileApi.create ...'
  end
  # verify the required parameter 'file_file_publication' is set
  if @api_client.config.client_side_validation && file_file_publication.nil?
    fail ArgumentError, "Missing the required parameter 'file_file_publication' when calling PublicationsFileApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/publications/file/file/'

  # 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(file_file_publication) 

  # 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: PublicationsFileApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete(file_file_publication_href, opts = {}) click to toggle source

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.

@param file_file_publication_href [String] @param [Hash] opts the optional parameters @return [nil]

# File lib/pulp_file_client/api/publications_file_api.rb, line 91
def delete(file_file_publication_href, opts = {})
  delete_with_http_info(file_file_publication_href, opts)
  nil
end
delete_with_http_info(file_file_publication_href, opts = {}) click to toggle source

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.

@param file_file_publication_href [String] @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/pulp_file_client/api/publications_file_api.rb, line 101
def delete_with_http_info(file_file_publication_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsFileApi.delete ...'
  end
  # verify the required parameter 'file_file_publication_href' is set
  if @api_client.config.client_side_validation && file_file_publication_href.nil?
    fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.delete"
  end
  # resource path
  local_var_path = '{file_file_publication_href}'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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: PublicationsFileApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

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.

@param [Hash] opts the optional parameters @option opts [String] :content Content Unit referenced by HREF @option opts [String] :content__in Content Unit referenced by HREF @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 [DateTime] :pulp_created ISO 8601 formatted dates are supported @option opts [DateTime] :pulp_created__gt Filter results where pulp_created is greater than value @option opts [DateTime] :pulp_created__gte Filter results where pulp_created is greater than or equal to value @option opts [DateTime] :pulp_created__lt Filter results where pulp_created is less than value @option opts [DateTime] :pulp_created__lte Filter results where pulp_created is less than or equal to value @option opts [Array<DateTime>] :pulp_created__range Filter results where pulp_created is between two comma separated values @option opts [String] :repository_version Repository Version referenced by HREF @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 [PaginatedfileFilePublicationResponseList]

# File lib/pulp_file_client/api/publications_file_api.rb, line 164
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_with_http_info(opts = {}) click to toggle source

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.

@param [Hash] opts the optional parameters @option opts [String] :content Content Unit referenced by HREF @option opts [String] :content__in Content Unit referenced by HREF @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 [DateTime] :pulp_created ISO 8601 formatted dates are supported @option opts [DateTime] :pulp_created__gt Filter results where pulp_created is greater than value @option opts [DateTime] :pulp_created__gte Filter results where pulp_created is greater than or equal to value @option opts [DateTime] :pulp_created__lt Filter results where pulp_created is less than value @option opts [DateTime] :pulp_created__lte Filter results where pulp_created is less than or equal to value @option opts [Array<DateTime>] :pulp_created__range Filter results where pulp_created is between two comma separated values @option opts [String] :repository_version Repository Version referenced by HREF @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<(PaginatedfileFilePublicationResponseList, Integer, Hash)>] PaginatedfileFilePublicationResponseList data, response status code and response headers

# File lib/pulp_file_client/api/publications_file_api.rb, line 187
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsFileApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/publications/file/file/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
  query_params[:'content__in'] = opts[:'content__in'] if !opts[:'content__in'].nil?
  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[:'pulp_created'] = opts[:'pulp_created'] if !opts[:'pulp_created'].nil?
  query_params[:'pulp_created__gt'] = opts[:'pulp_created__gt'] if !opts[:'pulp_created__gt'].nil?
  query_params[:'pulp_created__gte'] = opts[:'pulp_created__gte'] if !opts[:'pulp_created__gte'].nil?
  query_params[:'pulp_created__lt'] = opts[:'pulp_created__lt'] if !opts[:'pulp_created__lt'].nil?
  query_params[:'pulp_created__lte'] = opts[:'pulp_created__lte'] if !opts[:'pulp_created__lte'].nil?
  query_params[:'pulp_created__range'] = @api_client.build_collection_param(opts[:'pulp_created__range'], :csv) if !opts[:'pulp_created__range'].nil?
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].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] || 'PaginatedfileFilePublicationResponseList' 

  # 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: PublicationsFileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(file_file_publication_href, opts = {}) click to toggle source

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.

@param file_file_publication_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 [FileFilePublicationResponse]

# File lib/pulp_file_client/api/publications_file_api.rb, line 251
def read(file_file_publication_href, opts = {})
  data, _status_code, _headers = read_with_http_info(file_file_publication_href, opts)
  data
end
read_with_http_info(file_file_publication_href, opts = {}) click to toggle source

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.

@param file_file_publication_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<(FileFilePublicationResponse, Integer, Hash)>] FileFilePublicationResponse data, response status code and response headers

# File lib/pulp_file_client/api/publications_file_api.rb, line 263
def read_with_http_info(file_file_publication_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsFileApi.read ...'
  end
  # verify the required parameter 'file_file_publication_href' is set
  if @api_client.config.client_side_validation && file_file_publication_href.nil?
    fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.read"
  end
  # resource path
  local_var_path = '{file_file_publication_href}'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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] || 'FileFilePublicationResponse' 

  # 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: PublicationsFileApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end