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

#add_role(python_python_remote_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Add a role Add a role for this object to users/groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



29
30
31
32
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 29

def add_role(python_python_remote_href, nested_role, opts = {})
  data, _status_code, _headers = add_role_with_http_info(python_python_remote_href, nested_role, opts)
  data
end

#add_role_with_http_info(python_python_remote_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Add a role Add a role for this object to users/groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    NestedRoleResponse data, response status code and response headers



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
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 41

def add_role_with_http_info(python_python_remote_href, nested_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.add_role ...'
  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.add_role"
  end
  # verify the required parameter 'nested_role' is set
  if @api_client.config.client_side_validation && nested_role.nil?
    fail ArgumentError, "Missing the required parameter 'nested_role' when calling RemotesPythonApi.add_role"
  end
  # resource path
  local_var_path = '{python_python_remote_href}add_role/'.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(nested_role)

  # return_type
  return_type = opts[:debug_return_type] || 'NestedRoleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.add_role",
    :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#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#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

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



105
106
107
108
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 105

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

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    PythonPythonRemoteResponse data, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 116

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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(python_python_remote)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.create",
    :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

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



176
177
178
179
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 176

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

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 187

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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'AsyncOperationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.delete",
    :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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :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. * &#x60;immediate&#x60; - When syncing, download all metadata and content now. * &#x60;on_demand&#x60; - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * &#x60;streamed&#x60; - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.

Returns:



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

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

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :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. * &#x60;immediate&#x60; - When syncing, download all metadata and content now. * &#x60;on_demand&#x60; - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * &#x60;streamed&#x60; - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.

Returns:

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

    PythonPythonRemoteResponse data, response status code and response headers



257
258
259
260
261
262
263
264
265
266
267
268
269
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
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 257

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
  if @api_client.config.client_side_validation && name.to_s.length < 1
    fail ArgumentError, 'invalid value for "name" when calling RemotesPythonApi.from_bandersnatch, the character length must be great than or equal to 1.'
  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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

  # 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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.from_bandersnatch",
    :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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    Filter results where name matches value

  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__iexact (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

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

  • :name__iregex (String) —

    Filter results where name matches regex value

  • :name__istartswith (String) —

    Filter results where name starts with value

  • :name__regex (String) —

    Filter results where name matches regex value

  • :name__startswith (String) —

    Filter results where name starts with value

  • :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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :pulp_last_updated (Time) —

    Filter results where pulp_last_updated matches value

  • :pulp_last_updated__gt (Time) —

    Filter results where pulp_last_updated is greater than value

  • :pulp_last_updated__gte (Time) —

    Filter results where pulp_last_updated is greater than or equal to value

  • :pulp_last_updated__isnull (Boolean) —

    Filter results where pulp_last_updated has a null value

  • :pulp_last_updated__lt (Time) —

    Filter results where pulp_last_updated is less than value

  • :pulp_last_updated__lte (Time) —

    Filter results where pulp_last_updated is less than or equal to value

  • :pulp_last_updated__range (Array<Time>) —

    Filter results where pulp_last_updated is between two comma separated values

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



353
354
355
356
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 353

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

#list_roles(python_python_remote_href, opts = {}) ⇒ ObjectRolesResponse

List roles List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

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



472
473
474
475
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 472

def list_roles(python_python_remote_href, opts = {})
  data, _status_code, _headers = list_roles_with_http_info(python_python_remote_href, opts)
  data
end

#list_roles_with_http_info(python_python_remote_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>

List roles List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

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

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

    ObjectRolesResponse 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
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 485

def list_roles_with_http_info(python_python_remote_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.list_roles ...'
  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.list_roles"
  end
  # resource path
  local_var_path = '{python_python_remote_href}list_roles/'.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'] = @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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ObjectRolesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.list_roles",
    :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_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    Filter results where name matches value

  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__iexact (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

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

  • :name__iregex (String) —

    Filter results where name matches regex value

  • :name__istartswith (String) —

    Filter results where name starts with value

  • :name__regex (String) —

    Filter results where name matches regex value

  • :name__startswith (String) —

    Filter results where name starts with value

  • :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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :pulp_last_updated (Time) —

    Filter results where pulp_last_updated matches value

  • :pulp_last_updated__gt (Time) —

    Filter results where pulp_last_updated is greater than value

  • :pulp_last_updated__gte (Time) —

    Filter results where pulp_last_updated is greater than or equal to value

  • :pulp_last_updated__isnull (Boolean) —

    Filter results where pulp_last_updated has a null value

  • :pulp_last_updated__lt (Time) —

    Filter results where pulp_last_updated is less than value

  • :pulp_last_updated__lte (Time) —

    Filter results where pulp_last_updated is less than or equal to value

  • :pulp_last_updated__range (Array<Time>) —

    Filter results where pulp_last_updated is between two comma separated values

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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
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
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 389

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.list ...'
  end
  allowable_values = ["-ca_cert", "-client_cert", "-client_key", "-connect_timeout", "-download_concurrency", "-headers", "-max_retries", "-name", "-password", "-pk", "-policy", "-proxy_password", "-proxy_url", "-proxy_username", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-rate_limit", "-sock_connect_timeout", "-sock_read_timeout", "-tls_validation", "-total_timeout", "-url", "-username", "ca_cert", "client_cert", "client_key", "connect_timeout", "download_concurrency", "headers", "max_retries", "name", "password", "pk", "policy", "proxy_password", "proxy_url", "proxy_username", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "rate_limit", "sock_connect_timeout", "sock_read_timeout", "tls_validation", "total_timeout", "url", "username"]
  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/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__iexact'] = opts[:'name__iexact'] if !opts[:'name__iexact'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__iregex'] = opts[:'name__iregex'] if !opts[:'name__iregex'].nil?
  query_params[:'name__istartswith'] = opts[:'name__istartswith'] if !opts[:'name__istartswith'].nil?
  query_params[:'name__regex'] = opts[:'name__regex'] if !opts[:'name__regex'].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'] = @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_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[:'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__isnull'] = opts[:'pulp_last_updated__isnull'] if !opts[:'pulp_last_updated__isnull'].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[:'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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedpythonPythonRemoteResponseList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.list",
    :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

#my_permissions(python_python_remote_href, opts = {}) ⇒ MyPermissionsResponse

List user permissions List permissions available to the current user on this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

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



544
545
546
547
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 544

def my_permissions(python_python_remote_href, opts = {})
  data, _status_code, _headers = my_permissions_with_http_info(python_python_remote_href, opts)
  data
end

#my_permissions_with_http_info(python_python_remote_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>

List user permissions List permissions available to the current user on this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

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

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

    MyPermissionsResponse data, response status code and response headers



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 557

def my_permissions_with_http_info(python_python_remote_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.my_permissions ...'
  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.my_permissions"
  end
  # resource path
  local_var_path = '{python_python_remote_href}my_permissions/'.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'] = @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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'MyPermissionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.my_permissions",
    :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#my_permissions\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 = {}) ⇒ PythonPythonRemoteResponse

Update a python remote Update the entity partially and trigger an asynchronous task if necessary

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



615
616
617
618
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 615

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<(PythonPythonRemoteResponse, Integer, Hash)>

Update a python remote Update the entity partially and trigger an asynchronous task if necessary

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    PythonPythonRemoteResponse data, response status code and response headers



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 627

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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patchedpython_python_remote)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.partial_update",
    :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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

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



693
694
695
696
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 693

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

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

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

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

    PythonPythonRemoteResponse data, response status code and response headers



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 706

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'] = @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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.read",
    :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

#remove_role(python_python_remote_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Remove a role Remove a role for this object from users/groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



764
765
766
767
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 764

def remove_role(python_python_remote_href, nested_role, opts = {})
  data, _status_code, _headers = remove_role_with_http_info(python_python_remote_href, nested_role, opts)
  data
end

#remove_role_with_http_info(python_python_remote_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Remove a role Remove a role for this object from users/groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    NestedRoleResponse data, response status code and response headers



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 776

def remove_role_with_http_info(python_python_remote_href, nested_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.remove_role ...'
  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.remove_role"
  end
  # verify the required parameter 'nested_role' is set
  if @api_client.config.client_side_validation && nested_role.nil?
    fail ArgumentError, "Missing the required parameter 'nested_role' when calling RemotesPythonApi.remove_role"
  end
  # resource path
  local_var_path = '{python_python_remote_href}remove_role/'.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(nested_role)

  # return_type
  return_type = opts[:debug_return_type] || 'NestedRoleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.remove_role",
    :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#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_label(python_python_remote_href, set_label, opts = {}) ⇒ SetLabelResponse

Set a label Set a single pulp_label on the object to a specific value or null.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



841
842
843
844
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 841

def set_label(python_python_remote_href, set_label, opts = {})
  data, _status_code, _headers = set_label_with_http_info(python_python_remote_href, set_label, opts)
  data
end

#set_label_with_http_info(python_python_remote_href, set_label, opts = {}) ⇒ Array<(SetLabelResponse, Integer, Hash)>

Set a label Set a single pulp_label on the object to a specific value or null.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    SetLabelResponse data, response status code and response headers



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 853

def set_label_with_http_info(python_python_remote_href, set_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.set_label ...'
  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.set_label"
  end
  # verify the required parameter 'set_label' is set
  if @api_client.config.client_side_validation && set_label.nil?
    fail ArgumentError, "Missing the required parameter 'set_label' when calling RemotesPythonApi.set_label"
  end
  # resource path
  local_var_path = '{python_python_remote_href}set_label/'.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(set_label)

  # return_type
  return_type = opts[:debug_return_type] || 'SetLabelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.set_label",
    :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#set_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unset_label(python_python_remote_href, unset_label, opts = {}) ⇒ UnsetLabelResponse

Unset a label Unset a single pulp_label on the object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



918
919
920
921
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 918

def unset_label(python_python_remote_href, unset_label, opts = {})
  data, _status_code, _headers = unset_label_with_http_info(python_python_remote_href, unset_label, opts)
  data
end

#unset_label_with_http_info(python_python_remote_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, Integer, Hash)>

Unset a label Unset a single pulp_label on the object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    UnsetLabelResponse data, response status code and response headers



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 930

def unset_label_with_http_info(python_python_remote_href, unset_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesPythonApi.unset_label ...'
  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.unset_label"
  end
  # verify the required parameter 'unset_label' is set
  if @api_client.config.client_side_validation && unset_label.nil?
    fail ArgumentError, "Missing the required parameter 'unset_label' when calling RemotesPythonApi.unset_label"
  end
  # resource path
  local_var_path = '{python_python_remote_href}unset_label/'.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(unset_label)

  # return_type
  return_type = opts[:debug_return_type] || 'UnsetLabelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.unset_label",
    :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#unset_label\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 = {}) ⇒ PythonPythonRemoteResponse

Update a python remote Update the entity and trigger an asynchronous task if necessary

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



995
996
997
998
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 995

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<(PythonPythonRemoteResponse, Integer, Hash)>

Update a python remote Update the entity and trigger an asynchronous task if necessary

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    PythonPythonRemoteResponse data, response status code and response headers



1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/pulp_python_client/api/remotes_python_api.rb', line 1007

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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(python_python_remote)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"RemotesPythonApi.update",
    :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