Class: PulpcoreClient::UpstreamPulpsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UpstreamPulpsApi

Returns a new instance of UpstreamPulpsApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

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

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

Parameters:

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 28

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    NestedRoleResponse data, response status code and response headers



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
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 39

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

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

#create(upstream_pulp, opts = {}) ⇒ UpstreamPulpResponse

Create an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Returns:



101
102
103
104
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 101

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

#create_with_http_info(upstream_pulp, opts = {}) ⇒ Array<(UpstreamPulpResponse, Integer, Hash)>

Create an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Returns:

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

    UpstreamPulpResponse data, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 111

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

  # 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

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

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

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

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

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

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

Delete an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


169
170
171
172
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 169

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

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

Delete an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
222
223
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 179

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#list(opts = {}) ⇒ PaginatedUpstreamPulpResponseList

List upstream pulps API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :base_url (String) —

    Filter results where base_url matches value

  • :base_url__contains (String) —

    Filter results where base_url contains value

  • :base_url__icontains (String) —

    Filter results where base_url contains value

  • :base_url__iexact (String) —

    Filter results where base_url matches value

  • :base_url__in (Array<String>) —

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

  • :base_url__iregex (String) —

    Filter results where base_url matches regex value

  • :base_url__istartswith (String) —

    Filter results where base_url starts with value

  • :base_url__regex (String) —

    Filter results where base_url matches regex value

  • :base_url__startswith (String) —

    Filter results where base_url starts with value

  • :last_replication (Time) —

    Filter results where last_replication matches value

  • :last_replication__gt (Time) —

    Filter results where last_replication is greater than value

  • :last_replication__gte (Time) —

    Filter results where last_replication is greater than or equal to value

  • :last_replication__isnull (Boolean) —

    Filter results where last_replication has a null value

  • :last_replication__lt (Time) —

    Filter results where last_replication is less than value

  • :last_replication__lte (Time) —

    Filter results where last_replication is less than or equal to value

  • :last_replication__range (Array<Time>) —

    Filter results where last_replication is between two comma separated values

  • :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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;base_url&#x60; - Base url * &#x60;-base_url&#x60; - Base url (descending) * &#x60;api_root&#x60; - Api root * &#x60;-api_root&#x60; - Api root (descending) * &#x60;domain&#x60; - Domain * &#x60;-domain&#x60; - Domain (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;q_select&#x60; - Q select * &#x60;-q_select&#x60; - Q select (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;last_replication&#x60; - Last replication * &#x60;-last_replication&#x60; - Last replication (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.

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



263
264
265
266
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 263

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

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

List roles List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



395
396
397
398
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 395

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

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

List roles List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    ObjectRolesResponse data, response status code and response headers



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
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 407

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

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

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

List upstream pulps API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :base_url (String) —

    Filter results where base_url matches value

  • :base_url__contains (String) —

    Filter results where base_url contains value

  • :base_url__icontains (String) —

    Filter results where base_url contains value

  • :base_url__iexact (String) —

    Filter results where base_url matches value

  • :base_url__in (Array<String>) —

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

  • :base_url__iregex (String) —

    Filter results where base_url matches regex value

  • :base_url__istartswith (String) —

    Filter results where base_url starts with value

  • :base_url__regex (String) —

    Filter results where base_url matches regex value

  • :base_url__startswith (String) —

    Filter results where base_url starts with value

  • :last_replication (Time) —

    Filter results where last_replication matches value

  • :last_replication__gt (Time) —

    Filter results where last_replication is greater than value

  • :last_replication__gte (Time) —

    Filter results where last_replication is greater than or equal to value

  • :last_replication__isnull (Boolean) —

    Filter results where last_replication has a null value

  • :last_replication__lt (Time) —

    Filter results where last_replication is less than value

  • :last_replication__lte (Time) —

    Filter results where last_replication is less than or equal to value

  • :last_replication__range (Array<Time>) —

    Filter results where last_replication is between two comma separated values

  • :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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;base_url&#x60; - Base url * &#x60;-base_url&#x60; - Base url (descending) * &#x60;api_root&#x60; - Api root * &#x60;-api_root&#x60; - Api root (descending) * &#x60;domain&#x60; - Domain * &#x60;-domain&#x60; - Domain (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;q_select&#x60; - Q select * &#x60;-q_select&#x60; - Q select (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;last_replication&#x60; - Last replication * &#x60;-last_replication&#x60; - Last replication (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.

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
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
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 306

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UpstreamPulpsApi.list ...'
  end
  allowable_values = ["-api_root", "-base_url", "-ca_cert", "-client_cert", "-client_key", "-domain", "-last_replication", "-name", "-password", "-pk", "-policy", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-q_select", "-tls_validation", "-username", "api_root", "base_url", "ca_cert", "client_cert", "client_key", "domain", "last_replication", "name", "password", "pk", "policy", "pulp_created", "pulp_id", "pulp_last_updated", "q_select", "tls_validation", "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/upstream-pulps/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'base_url'] = opts[:'base_url'] if !opts[:'base_url'].nil?
  query_params[:'base_url__contains'] = opts[:'base_url__contains'] if !opts[:'base_url__contains'].nil?
  query_params[:'base_url__icontains'] = opts[:'base_url__icontains'] if !opts[:'base_url__icontains'].nil?
  query_params[:'base_url__iexact'] = opts[:'base_url__iexact'] if !opts[:'base_url__iexact'].nil?
  query_params[:'base_url__in'] = @api_client.build_collection_param(opts[:'base_url__in'], :csv) if !opts[:'base_url__in'].nil?
  query_params[:'base_url__iregex'] = opts[:'base_url__iregex'] if !opts[:'base_url__iregex'].nil?
  query_params[:'base_url__istartswith'] = opts[:'base_url__istartswith'] if !opts[:'base_url__istartswith'].nil?
  query_params[:'base_url__regex'] = opts[:'base_url__regex'] if !opts[:'base_url__regex'].nil?
  query_params[:'base_url__startswith'] = opts[:'base_url__startswith'] if !opts[:'base_url__startswith'].nil?
  query_params[:'last_replication'] = opts[:'last_replication'] if !opts[:'last_replication'].nil?
  query_params[:'last_replication__gt'] = opts[:'last_replication__gt'] if !opts[:'last_replication__gt'].nil?
  query_params[:'last_replication__gte'] = opts[:'last_replication__gte'] if !opts[:'last_replication__gte'].nil?
  query_params[:'last_replication__isnull'] = opts[:'last_replication__isnull'] if !opts[:'last_replication__isnull'].nil?
  query_params[:'last_replication__lt'] = opts[:'last_replication__lt'] if !opts[:'last_replication__lt'].nil?
  query_params[:'last_replication__lte'] = opts[:'last_replication__lte'] if !opts[:'last_replication__lte'].nil?
  query_params[:'last_replication__range'] = @api_client.build_collection_param(opts[:'last_replication__range'], :csv) if !opts[:'last_replication__range'].nil?
  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[:'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']

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

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

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

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

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

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

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



464
465
466
467
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 464

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

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

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    MyPermissionsResponse data, response status code and response headers



476
477
478
479
480
481
482
483
484
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
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 476

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

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

#partial_update(upstream_pulp_href, patched_upstream_pulp, opts = {}) ⇒ UpstreamPulpResponse

Update an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

  • upstream_pulp_href (String)
  • patched_upstream_pulp (PatchedUpstreamPulp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



532
533
534
535
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 532

def partial_update(upstream_pulp_href, patched_upstream_pulp, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(upstream_pulp_href, patched_upstream_pulp, opts)
  data
end

#partial_update_with_http_info(upstream_pulp_href, patched_upstream_pulp, opts = {}) ⇒ Array<(UpstreamPulpResponse, Integer, Hash)>

Update an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

  • upstream_pulp_href (String)
  • patched_upstream_pulp (PatchedUpstreamPulp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    UpstreamPulpResponse data, response status code and response headers



543
544
545
546
547
548
549
550
551
552
553
554
555
556
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
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 543

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

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

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

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

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

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

#read(upstream_pulp_href, opts = {}) ⇒ UpstreamPulpResponse

Inspect an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



607
608
609
610
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 607

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

#read_with_http_info(upstream_pulp_href, opts = {}) ⇒ Array<(UpstreamPulpResponse, Integer, Hash)>

Inspect an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    UpstreamPulpResponse data, response status code and response headers



619
620
621
622
623
624
625
626
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
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 619

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

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

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

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

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

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

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

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

Parameters:

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

    the optional parameters

Returns:



675
676
677
678
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 675

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    NestedRoleResponse data, response status code and response headers



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
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
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 686

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

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

#replicate(upstream_pulp_href, opts = {}) ⇒ TaskGroupOperationResponse

Replicate Trigger an asynchronous repository replication task group. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Returns:



748
749
750
751
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 748

def replicate(upstream_pulp_href, opts = {})
  data, _status_code, _headers = replicate_with_http_info(upstream_pulp_href, opts)
  data
end

#replicate_with_http_info(upstream_pulp_href, opts = {}) ⇒ Array<(TaskGroupOperationResponse, Integer, Hash)>

Replicate Trigger an asynchronous repository replication task group. This API is provided as a tech preview.

Parameters:

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

    the optional parameters

Returns:

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

    TaskGroupOperationResponse data, response status code and response headers



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
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
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 758

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

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

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

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

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

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

#update(upstream_pulp_href, upstream_pulp, opts = {}) ⇒ UpstreamPulpResponse

Update an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

  • upstream_pulp_href (String)
  • upstream_pulp (UpstreamPulp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



812
813
814
815
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 812

def update(upstream_pulp_href, upstream_pulp, opts = {})
  data, _status_code, _headers = update_with_http_info(upstream_pulp_href, upstream_pulp, opts)
  data
end

#update_with_http_info(upstream_pulp_href, upstream_pulp, opts = {}) ⇒ Array<(UpstreamPulpResponse, Integer, Hash)>

Update an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Parameters:

  • upstream_pulp_href (String)
  • upstream_pulp (UpstreamPulp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    UpstreamPulpResponse data, response status code and response headers



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
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
 
# File 'lib/pulpcore_client/api/upstream_pulps_api.rb', line 823

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

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

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

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

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

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