Class: PulpAnsibleClient::RepositoriesAnsibleApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_ansible_client/api/repositories_ansible_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RepositoriesAnsibleApi

Returns a new instance of RepositoriesAnsibleApi.



19
20
21
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_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_ansible_client/api/repositories_ansible_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(ansible_ansible_repository, opts = {}) ⇒ AnsibleAnsibleRepositoryResponse

Create an ansible repository ViewSet for Ansible Repositories.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 27

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

#create_with_http_info(ansible_ansible_repository, opts = {}) ⇒ Array<(AnsibleAnsibleRepositoryResponse, Integer, Hash)>

Create an ansible repository ViewSet for Ansible Repositories.

Parameters:

Returns:



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

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an ansible repository Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 91

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

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

Delete an ansible repository Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 101

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ PaginatedansibleAnsibleRepositoryResponseList

List ansible repositorys ViewSet for Ansible Repositories.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

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

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__in (Array<String>) —

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

  • :name__startswith (String) —

    Filter results where name starts with value

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering

  • :pulp_label_select (String) —

    Filter labels by search string

  • :remote (String) —

    Foreign Key referenced by HREF

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



164
165
166
167
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 164

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

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

List ansible repositorys ViewSet for Ansible Repositories.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

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

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__in (Array<String>) —

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

  • :name__startswith (String) —

    Filter results where name starts with value

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering

  • :pulp_label_select (String) —

    Filter labels by search string

  • :remote (String) —

    Foreign Key referenced by HREF

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 185

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleApi.list ...'
  end
  allowable_values = ["-alternatecontentsourcepath", "-ansible_ansiblerepository", "-content", "-core_pulp_exporter", "-description", "-distributions", "-download_logs", "-group_roles", "-name", "-next_version", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-pulpimporterrepository", "-remote", "-repositorycontent", "-retain_repo_versions", "-user_hidden", "-user_roles", "-versions", "alternatecontentsourcepath", "ansible_ansiblerepository", "content", "core_pulp_exporter", "description", "distributions", "download_logs", "group_roles", "name", "next_version", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "pulpimporterrepository", "remote", "repositorycontent", "retain_repo_versions", "user_hidden", "user_roles", "versions"]
  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/repositories/ansible/ansible/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
  query_params[:'remote'] = opts[:'remote'] if !opts[:'remote'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#modify(ansible_ansible_repository_href, repository_add_remove_content, opts = {}) ⇒ AsyncOperationResponse

Modify Repository Content Trigger an asynchronous task to create a new repository version.

Parameters:

  • ansible_ansible_repository_href (String)
  • repository_add_remove_content (RepositoryAddRemoveContent)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



250
251
252
253
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 250

def modify(ansible_ansible_repository_href, repository_add_remove_content, opts = {})
  data, _status_code, _headers = modify_with_http_info(ansible_ansible_repository_href, repository_add_remove_content, opts)
  data
end

#modify_with_http_info(ansible_ansible_repository_href, repository_add_remove_content, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Modify Repository Content Trigger an asynchronous task to create a new repository version.

Parameters:

  • ansible_ansible_repository_href (String)
  • repository_add_remove_content (RepositoryAddRemoveContent)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 261

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#modify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#partial_update(ansible_ansible_repository_href, patchedansible_ansible_repository, opts = {}) ⇒ AsyncOperationResponse

Update an ansible repository Trigger an asynchronous partial update task

Parameters:

  • ansible_ansible_repository_href (String)
  • patchedansible_ansible_repository (PatchedansibleAnsibleRepository)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



320
321
322
323
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 320

def partial_update(ansible_ansible_repository_href, patchedansible_ansible_repository, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(ansible_ansible_repository_href, patchedansible_ansible_repository, opts)
  data
end

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

Update an ansible repository Trigger an asynchronous partial update task

Parameters:

  • ansible_ansible_repository_href (String)
  • patchedansible_ansible_repository (PatchedansibleAnsibleRepository)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 331

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(ansible_ansible_repository_href, opts = {}) ⇒ AnsibleAnsibleRepositoryResponse

Inspect an ansible repository ViewSet for Ansible Repositories.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



391
392
393
394
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 391

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

#read_with_http_info(ansible_ansible_repository_href, opts = {}) ⇒ Array<(AnsibleAnsibleRepositoryResponse, Integer, Hash)>

Inspect an ansible repository ViewSet for Ansible Repositories.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 403

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rebuild_metadata(ansible_ansible_repository_href, ansible_repository_rebuild, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to rebuild Ansible content meta.

Parameters:

  • ansible_ansible_repository_href (String)
  • ansible_repository_rebuild (AnsibleRepositoryRebuild)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



457
458
459
460
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 457

def rebuild_metadata(ansible_ansible_repository_href, ansible_repository_rebuild, opts = {})
  data, _status_code, _headers = rebuild_metadata_with_http_info(ansible_ansible_repository_href, ansible_repository_rebuild, opts)
  data
end

#rebuild_metadata_with_http_info(ansible_ansible_repository_href, ansible_repository_rebuild, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Trigger an asynchronous task to rebuild Ansible content meta.

Parameters:

  • ansible_ansible_repository_href (String)
  • ansible_repository_rebuild (AnsibleRepositoryRebuild)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



467
468
469
470
471
472
473
474
475
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
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 467

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#rebuild_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sign(ansible_ansible_repository_href, ansible_repository_signature, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to sign Ansible content.

Parameters:

  • ansible_ansible_repository_href (String)
  • ansible_repository_signature (AnsibleRepositorySignature)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



525
526
527
528
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 525

def sign(ansible_ansible_repository_href, ansible_repository_signature, opts = {})
  data, _status_code, _headers = sign_with_http_info(ansible_ansible_repository_href, ansible_repository_signature, opts)
  data
end

#sign_with_http_info(ansible_ansible_repository_href, ansible_repository_signature, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Trigger an asynchronous task to sign Ansible content.

Parameters:

  • ansible_ansible_repository_href (String)
  • ansible_repository_signature (AnsibleRepositorySignature)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



535
536
537
538
539
540
541
542
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
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 535

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#sign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync(ansible_ansible_repository_href, ansible_repository_sync_url, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to sync Ansible content.

Parameters:

  • ansible_ansible_repository_href (String)
  • ansible_repository_sync_url (AnsibleRepositorySyncURL)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



593
594
595
596
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 593

def sync(ansible_ansible_repository_href, ansible_repository_sync_url, opts = {})
  data, _status_code, _headers = sync_with_http_info(ansible_ansible_repository_href, ansible_repository_sync_url, opts)
  data
end

#sync_with_http_info(ansible_ansible_repository_href, ansible_repository_sync_url, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Trigger an asynchronous task to sync Ansible content.

Parameters:

  • ansible_ansible_repository_href (String)
  • ansible_repository_sync_url (AnsibleRepositorySyncURL)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
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
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 603

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(ansible_ansible_repository_href, ansible_ansible_repository, opts = {}) ⇒ AsyncOperationResponse

Update an ansible repository Trigger an asynchronous update task

Parameters:

  • ansible_ansible_repository_href (String)
  • ansible_ansible_repository (AnsibleAnsibleRepository)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



662
663
664
665
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 662

def update(ansible_ansible_repository_href, ansible_ansible_repository, opts = {})
  data, _status_code, _headers = update_with_http_info(ansible_ansible_repository_href, ansible_ansible_repository, opts)
  data
end

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

Update an ansible repository Trigger an asynchronous update task

Parameters:

  • ansible_ansible_repository_href (String)
  • ansible_ansible_repository (AnsibleAnsibleRepository)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



673
674
675
676
677
678
679
680
681
682
683
684
685
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
 
# File 'lib/pulp_ansible_client/api/repositories_ansible_api.rb', line 673

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesAnsibleApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end