Class: PulpcoreClient::RepositoryVersionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/repository_versions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RepositoryVersionsApi

Returns a new instance of RepositoryVersionsApi.



19
20
21
 
# File 'lib/pulpcore_client/api/repository_versions_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pulpcore_client/api/repository_versions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ PaginatedRepositoryVersionResponseList

List repository versions A mixin to hold the shared get_queryset logic used by RepositoryVersionViewSets.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :content (String) —

    Content Unit referenced by HREF/PRN

  • :content__in (Array<String>) —

    Multiple values may be separated by commas.

  • :limit (Integer) —

    Number of results to return per page.

  • :number (Integer) —

    Filter results where number matches value

  • :number__gt (Integer) —

    Filter results where number is greater than value

  • :number__gte (Integer) —

    Filter results where number is greater than or equal to value

  • :number__lt (Integer) —

    Filter results where number is less than value

  • :number__lte (Integer) —

    Filter results where number is less than or equal to value

  • :number__range (Array<Integer>) —

    Filter results where number is between two comma separated values

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;number&#x60; - Number * &#x60;-number&#x60; - Number (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;info&#x60; - Info * &#x60;-info&#x60; - Info (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_created (DateTime) —

    Filter results where pulp_created matches value

  • :pulp_created__gt (DateTime) —

    Filter results where pulp_created is greater than value

  • :pulp_created__gte (DateTime) —

    Filter results where pulp_created is greater than or equal to value

  • :pulp_created__lt (DateTime) —

    Filter results where pulp_created is less than value

  • :pulp_created__lte (DateTime) —

    Filter results where pulp_created is less than or equal to value

  • :pulp_created__range (Array<DateTime>) —

    Filter results where pulp_created is between two comma separated values

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



48
49
50
51
 
# File 'lib/pulpcore_client/api/repository_versions_api.rb', line 48

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(PaginatedRepositoryVersionResponseList, Integer, Hash)>

List repository versions A mixin to hold the shared get_queryset logic used by RepositoryVersionViewSets.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :content (String) —

    Content Unit referenced by HREF/PRN

  • :content__in (Array<String>) —

    Multiple values may be separated by commas.

  • :limit (Integer) —

    Number of results to return per page.

  • :number (Integer) —

    Filter results where number matches value

  • :number__gt (Integer) —

    Filter results where number is greater than value

  • :number__gte (Integer) —

    Filter results where number is greater than or equal to value

  • :number__lt (Integer) —

    Filter results where number is less than value

  • :number__lte (Integer) —

    Filter results where number is less than or equal to value

  • :number__range (Array<Integer>) —

    Filter results where number is between two comma separated values

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;number&#x60; - Number * &#x60;-number&#x60; - Number (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;info&#x60; - Info * &#x60;-info&#x60; - Info (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_created (DateTime) —

    Filter results where pulp_created matches value

  • :pulp_created__gt (DateTime) —

    Filter results where pulp_created is greater than value

  • :pulp_created__gte (DateTime) —

    Filter results where pulp_created is greater than or equal to value

  • :pulp_created__lt (DateTime) —

    Filter results where pulp_created is less than value

  • :pulp_created__lte (DateTime) —

    Filter results where pulp_created is less than or equal to value

  • :pulp_created__range (Array<DateTime>) —

    Filter results where pulp_created is between two comma separated values

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/pulpcore_client/api/repository_versions_api.rb', line 79

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoryVersionsApi.list ...'
  end
  allowable_values = ["-complete", "-info", "-number", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "complete", "info", "number", "pk", "pulp_created", "pulp_id", "pulp_last_updated"]
  if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/repository_versions/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
  query_params[:'content__in'] = @api_client.build_collection_param(opts[:'content__in'], :csv) if !opts[:'content__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
  query_params[:'number__gt'] = opts[:'number__gt'] if !opts[:'number__gt'].nil?
  query_params[:'number__gte'] = opts[:'number__gte'] if !opts[:'number__gte'].nil?
  query_params[:'number__lt'] = opts[:'number__lt'] if !opts[:'number__lt'].nil?
  query_params[:'number__lte'] = opts[:'number__lte'] if !opts[:'number__lte'].nil?
  query_params[:'number__range'] = @api_client.build_collection_param(opts[:'number__range'], :csv) if !opts[:'number__range'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].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[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) 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] || 'PaginatedRepositoryVersionResponseList' 

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