class PulpcoreClient::PublicationsApi
Attributes
Public Class Methods
# File lib/pulpcore_client/api/publications_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
List publications A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the “register_with“ method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @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 [PaginatedPublicationResponseList]
# File lib/pulpcore_client/api/publications_api.rb, line 40 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List publications A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @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<(PaginatedPublicationResponseList
, Integer, Hash)>] PaginatedPublicationResponseList
data, response status code and response headers
# File lib/pulpcore_client/api/publications_api.rb, line 63 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicationsApi.list ...' end # resource path local_var_path = '/pulp/api/v3/publications/' # 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] || 'PaginatedPublicationResponseList' # 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: PublicationsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end