Class: PulpPythonClient::PublicationsPypiApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_python_client/api/publications_pypi_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PublicationsPypiApi

Returns a new instance of PublicationsPypiApi.



19
20
21
 
# File 'lib/pulp_python_client/api/publications_pypi_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/pulp_python_client/api/publications_pypi_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(python_python_publication, opts = {}) ⇒ AsyncOperationResponse

Create a python publication

Dispatches a publish task, which generates metadata that will be used by pip.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/pulp_python_client/api/publications_pypi_api.rb', line 27

def create(python_python_publication, opts = {})
  data, _status_code, _headers = create_with_http_info(python_python_publication, opts)
  data
end

#create_with_http_info(python_python_publication, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a python publication

Dispatches a publish task, which generates metadata that will be used by pip.

Parameters:

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>) —

    AsyncOperationResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/pulp_python_client/api/publications_pypi_api.rb', line 37

def create_with_http_info(python_python_publication, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsPypiApi.create ...'
  end
  # verify the required parameter 'python_python_publication' is set
  if @api_client.config.client_side_validation && python_python_publication.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_publication' when calling PublicationsPypiApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/publications/python/pypi/'

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

#delete(python_python_publication_href, opts = {}) ⇒ nil

Delete a python publication

Python Publications refer to the Python Package content in a repository version, and include metadata about that content.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/pulp_python_client/api/publications_pypi_api.rb', line 91

def delete(python_python_publication_href, opts = {})
  delete_with_http_info(python_python_publication_href, opts)
  nil
end

#delete_with_http_info(python_python_publication_href, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a python publication

Python Publications refer to the Python Package content in a repository version, and include metadata about that content.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/pulp_python_client/api/publications_pypi_api.rb', line 101

def delete_with_http_info(python_python_publication_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsPypiApi.delete ...'
  end
  # verify the required parameter 'python_python_publication_href' is set
  if @api_client.config.client_side_validation && python_python_publication_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_publication_href' when calling PublicationsPypiApi.delete"
  end
  # resource path
  local_var_path = '{python_python_publication_href}'.sub('{' + 'python_python_publication_href' + '}', CGI.escape(python_python_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: PublicationsPypiApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ PaginatedpythonPythonPublicationResponseList

List python publications

Python Publications refer to the Python Package content in a repository version, and include metadata about that content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :content (String) —

    Content Unit referenced by HREF

  • :content__in (String) —

    Content Unit referenced by HREF

  • :limit (Integer) —

    Number of results to return per page.

  • :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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;pass_through&#x60; - Pass through * &#x60;-pass_through&#x60; - Pass through (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :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.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :repository (String) —

    Repository referenced by HREF

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :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:



167
168
169
170
 
# File 'lib/pulp_python_client/api/publications_pypi_api.rb', line 167

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

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

List python publications

Python Publications refer to the Python Package content in a repository version, and include metadata about that content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :content (String) —

    Content Unit referenced by HREF

  • :content__in (String) —

    Content Unit referenced by HREF

  • :limit (Integer) —

    Number of results to return per page.

  • :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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;pass_through&#x60; - Pass through * &#x60;-pass_through&#x60; - Pass through (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :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.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :repository (String) —

    Repository referenced by HREF

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :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:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/pulp_python_client/api/publications_pypi_api.rb', line 193

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsPypiApi.list ...'
  end
  allowable_values = ["-complete", "-pass_through", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "complete", "pass_through", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type"]
  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/publications/python/pypi/'

  # 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'] = @api_client.build_collection_param(opts[:'ordering'], :csv) 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[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
  query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
  query_params[:'repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].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] || 'PaginatedpythonPythonPublicationResponseList' 

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

#read(python_python_publication_href, opts = {}) ⇒ PythonPythonPublicationResponse

Inspect a python publication

Python Publications refer to the Python Package content in a repository version, and include metadata about that content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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:



264
265
266
267
 
# File 'lib/pulp_python_client/api/publications_pypi_api.rb', line 264

def read(python_python_publication_href, opts = {})
  data, _status_code, _headers = read_with_http_info(python_python_publication_href, opts)
  data
end

#read_with_http_info(python_python_publication_href, opts = {}) ⇒ Array<(PythonPythonPublicationResponse, Integer, Hash)>

Inspect a python publication

Python Publications refer to the Python Package content in a repository version, and include metadata about that content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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:



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/pulp_python_client/api/publications_pypi_api.rb', line 276

def read_with_http_info(python_python_publication_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsPypiApi.read ...'
  end
  # verify the required parameter 'python_python_publication_href' is set
  if @api_client.config.client_side_validation && python_python_publication_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_publication_href' when calling PublicationsPypiApi.read"
  end
  # resource path
  local_var_path = '{python_python_publication_href}'.sub('{' + 'python_python_publication_href' + '}', CGI.escape(python_python_publication_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  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] || 'PythonPythonPublicationResponse' 

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