Class: PulpPythonClient::RemotesPythonApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RemotesPythonApi

Returns a new instance of RemotesPythonApi.



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

def api_client
  @api_client
end

Instance Method Details

#create(python_python_remote, opts = {}) ⇒ PythonPythonRemoteResponse

Create a python remote

Python Remotes are representations of an external repository of Python content, eg. PyPI.  Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.

Parameters:

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

    the optional parameters

Returns:



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

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

#create_with_http_info(python_python_remote, opts = {}) ⇒ Array<(PythonPythonRemoteResponse, Integer, Hash)>

Create a python remote

Python Remotes are representations of an external repository of Python content, eg. PyPI.  Fields include upstream repository config. Python Remotes are also used to &#x60;sync&#x60; from upstream repositories, and contains sync settings.

Parameters:

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

    the optional parameters

Returns:

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

    PythonPythonRemoteResponse 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/remotes_python_api.rb', line 37

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

  # 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_remote) 

  # return_type
  return_type = opts[:return_type] || 'PythonPythonRemoteResponse' 

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

#delete(python_python_remote_href, opts = {}) ⇒ AsyncOperationResponse

Delete a python remote Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Returns:



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

def delete(python_python_remote_href, opts = {})
  data, _status_code, _headers = delete_with_http_info(python_python_remote_href, opts)
  data
end

#delete_with_http_info(python_python_remote_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Delete a python remote Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, 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
145
146
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 101

def delete_with_http_info(python_python_remote_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.delete ...'
  end
  # verify the required parameter 'python_python_remote_href' is set
  if @api_client.config.client_side_validation && python_python_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_remote_href' when calling RemotesPythonApi.delete"
  end
  # resource path
  local_var_path = '{python_python_remote_href}'.sub('{' + 'python_python_remote_href' + '}', CGI.escape(python_python_remote_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # 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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RemotesPythonApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#from_bandersnatch(config, name, opts = {}) ⇒ PythonPythonRemoteResponse

Create from Bandersnatch

Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.

Parameters:

  • config (File) —

    A Bandersnatch config that may be used to construct a Python Remote.

  • name (String) —

    A unique name for this remote

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

    the optional parameters

Options Hash (opts):

  • :policy (PolicyEnum) —

    The policy to use when downloading content. The possible values include: &#39;immediate&#39;, &#39;on_demand&#39;, and &#39;streamed&#39;. &#39;on_demand&#39; is the default.

Returns:



155
156
157
158
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 155

def from_bandersnatch(config, name, opts = {})
  data, _status_code, _headers = from_bandersnatch_with_http_info(config, name, opts)
  data
end

#from_bandersnatch_with_http_info(config, name, opts = {}) ⇒ Array<(PythonPythonRemoteResponse, Integer, Hash)>

Create from Bandersnatch

Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.

Parameters:

  • config (File) —

    A Bandersnatch config that may be used to construct a Python Remote.

  • name (String) —

    A unique name for this remote

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

    the optional parameters

Options Hash (opts):

  • :policy (PolicyEnum) —

    The policy to use when downloading content. The possible values include: &#39;immediate&#39;, &#39;on_demand&#39;, and &#39;streamed&#39;. &#39;on_demand&#39; is the default.

Returns:

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

    PythonPythonRemoteResponse data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
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
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 167

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

  # 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(['multipart/form-data', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['config'] = config
  form_params['name'] = name
  form_params['policy'] = opts[:'policy'] if !opts[:'policy'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PythonPythonRemoteResponse' 

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

#list(opts = {}) ⇒ PaginatedpythonPythonRemoteResponseList

List python remotes

Python Remotes are representations of an external repository of Python content, eg. PyPI.  Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String)
  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__in (Array<String>) —

    Filter results where name is in a comma-separated list of values

  • :name__startswith (String) —

    Filter results where name starts with value

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :pulp_last_updated (DateTime) —

    ISO 8601 formatted dates are supported

  • :pulp_last_updated__gt (DateTime) —

    Filter results where pulp_last_updated is greater than value

  • :pulp_last_updated__gte (DateTime) —

    Filter results where pulp_last_updated is greater than or equal to value

  • :pulp_last_updated__lt (DateTime) —

    Filter results where pulp_last_updated is less than value

  • :pulp_last_updated__lte (DateTime) —

    Filter results where pulp_last_updated is less than or equal to value

  • :pulp_last_updated__range (Array<DateTime>) —

    Filter results where pulp_last_updated is between two comma separated values

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



244
245
246
247
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 244

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

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

List python remotes

Python Remotes are representations of an external repository of Python content, eg. PyPI.  Fields include upstream repository config. Python Remotes are also used to &#x60;sync&#x60; from upstream repositories, and contains sync settings.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String)
  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__in (Array<String>) —

    Filter results where name is in a comma-separated list of values

  • :name__startswith (String) —

    Filter results where name starts with value

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :pulp_last_updated (DateTime) —

    ISO 8601 formatted dates are supported

  • :pulp_last_updated__gt (DateTime) —

    Filter results where pulp_last_updated is greater than value

  • :pulp_last_updated__gte (DateTime) —

    Filter results where pulp_last_updated is greater than or equal to value

  • :pulp_last_updated__lt (DateTime) —

    Filter results where pulp_last_updated is less than value

  • :pulp_last_updated__lte (DateTime) —

    Filter results where pulp_last_updated is less than or equal to value

  • :pulp_last_updated__range (Array<DateTime>) —

    Filter results where pulp_last_updated is between two comma separated values

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



270
271
272
273
274
275
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
324
325
326
327
328
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 270

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/remotes/python/python/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
  query_params[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].nil?
  query_params[:'pulp_last_updated__gt'] = opts[:'pulp_last_updated__gt'] if !opts[:'pulp_last_updated__gt'].nil?
  query_params[:'pulp_last_updated__gte'] = opts[:'pulp_last_updated__gte'] if !opts[:'pulp_last_updated__gte'].nil?
  query_params[:'pulp_last_updated__lt'] = opts[:'pulp_last_updated__lt'] if !opts[:'pulp_last_updated__lt'].nil?
  query_params[:'pulp_last_updated__lte'] = opts[:'pulp_last_updated__lte'] if !opts[:'pulp_last_updated__lte'].nil?
  query_params[:'pulp_last_updated__range'] = @api_client.build_collection_param(opts[:'pulp_last_updated__range'], :csv) if !opts[:'pulp_last_updated__range'].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] || 'PaginatedpythonPythonRemoteResponseList' 

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

#partial_update(python_python_remote_href, patchedpython_python_remote, opts = {}) ⇒ AsyncOperationResponse

Update a python remote Trigger an asynchronous partial update task

Parameters:

  • python_python_remote_href (String)
  • patchedpython_python_remote (PatchedpythonPythonRemote)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



336
337
338
339
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 336

def partial_update(python_python_remote_href, patchedpython_python_remote, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(python_python_remote_href, patchedpython_python_remote, opts)
  data
end

#partial_update_with_http_info(python_python_remote_href, patchedpython_python_remote, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Update a python remote Trigger an asynchronous partial update task

Parameters:

  • python_python_remote_href (String)
  • patchedpython_python_remote (PatchedpythonPythonRemote)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 347

def partial_update_with_http_info(python_python_remote_href, patchedpython_python_remote, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.partial_update ...'
  end
  # verify the required parameter 'python_python_remote_href' is set
  if @api_client.config.client_side_validation && python_python_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_remote_href' when calling RemotesPythonApi.partial_update"
  end
  # verify the required parameter 'patchedpython_python_remote' is set
  if @api_client.config.client_side_validation && patchedpython_python_remote.nil?
    fail ArgumentError, "Missing the required parameter 'patchedpython_python_remote' when calling RemotesPythonApi.partial_update"
  end
  # resource path
  local_var_path = '{python_python_remote_href}'.sub('{' + 'python_python_remote_href' + '}', CGI.escape(python_python_remote_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(patchedpython_python_remote) 

  # 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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RemotesPythonApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(python_python_remote_href, opts = {}) ⇒ PythonPythonRemoteResponse

Inspect a python remote

Python Remotes are representations of an external repository of Python content, eg. PyPI.  Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



407
408
409
410
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 407

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

#read_with_http_info(python_python_remote_href, opts = {}) ⇒ Array<(PythonPythonRemoteResponse, Integer, Hash)>

Inspect a python remote

Python Remotes are representations of an external repository of Python content, eg. PyPI.  Fields include upstream repository config. Python Remotes are also used to &#x60;sync&#x60; from upstream repositories, and contains sync settings.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    PythonPythonRemoteResponse data, response status code and response headers



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 419

def read_with_http_info(python_python_remote_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.read ...'
  end
  # verify the required parameter 'python_python_remote_href' is set
  if @api_client.config.client_side_validation && python_python_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_remote_href' when calling RemotesPythonApi.read"
  end
  # resource path
  local_var_path = '{python_python_remote_href}'.sub('{' + 'python_python_remote_href' + '}', CGI.escape(python_python_remote_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] || 'PythonPythonRemoteResponse' 

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

#update(python_python_remote_href, python_python_remote, opts = {}) ⇒ AsyncOperationResponse

Update a python remote Trigger an asynchronous update task

Parameters:

  • python_python_remote_href (String)
  • python_python_remote (PythonPythonRemote)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



474
475
476
477
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 474

def update(python_python_remote_href, python_python_remote, opts = {})
  data, _status_code, _headers = update_with_http_info(python_python_remote_href, python_python_remote, opts)
  data
end

#update_with_http_info(python_python_remote_href, python_python_remote, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Update a python remote Trigger an asynchronous update task

Parameters:

  • python_python_remote_href (String)
  • python_python_remote (PythonPythonRemote)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 485

def update_with_http_info(python_python_remote_href, python_python_remote, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.update ...'
  end
  # verify the required parameter 'python_python_remote_href' is set
  if @api_client.config.client_side_validation && python_python_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_remote_href' when calling RemotesPythonApi.update"
  end
  # verify the required parameter 'python_python_remote' is set
  if @api_client.config.client_side_validation && python_python_remote.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_remote' when calling RemotesPythonApi.update"
  end
  # resource path
  local_var_path = '{python_python_remote_href}'.sub('{' + 'python_python_remote_href' + '}', CGI.escape(python_python_remote_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(python_python_remote) 

  # 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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RemotesPythonApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end