Class: PulpFileClient::RepositoriesFileApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_file_client/api/repositories_file_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RepositoriesFileApi

Returns a new instance of RepositoriesFileApi.



19
20
21
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(file_file_repository, opts = {}) ⇒ FileFileRepositoryResponse

Create a file repository

FileRepository represents a single file repository, to which content can be synced, added, or removed.

Parameters:

  • file_file_repository (FileFileRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



27
28
29
30
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 27

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

#create_with_http_info(file_file_repository, opts = {}) ⇒ Array<(FileFileRepositoryResponse, Integer, Hash)>

Create a file repository

FileRepository represents a single file repository, to which content can be synced, added, or removed.

Parameters:

  • file_file_repository (FileFileRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(FileFileRepositoryResponse, Integer, Hash)>)

    FileFileRepositoryResponse data, response status code and response headers



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

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

  # 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(file_file_repository) 

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

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

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

Delete a file repository Trigger an asynchronous delete task

Parameters:

  • file_file_repository_href (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



91
92
93
94
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 91

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

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

Delete a file repository Trigger an asynchronous delete task

Parameters:

  • file_file_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_file_client/api/repositories_file_api.rb', line 101

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

#list(opts = {}) ⇒ PaginatedfileFileRepositoryResponseList

List file repositorys

FileRepository represents a single file repository, to which content can be synced, added, or removed.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)

    Number of results to return per page.

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

    Filter results where name contains value

  • :name__icontains (String)

    Filter results where name contains value

  • :name__in (Array<String>)

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

  • :name__startswith (String)

    Filter results where name starts with value

  • :offset (Integer)

    The initial index from which to return the results.

  • :ordering (String)

    Which field to use when ordering the results.

  • :pulp_label_select (String)

    Filter labels by search string

  • :fields (String)

    A list of fields to include in the response.

  • :exclude_fields (String)

    A list of fields to exclude from the response.

Returns:



163
164
165
166
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 163

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

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

List file repositorys

FileRepository represents a single file repository, to which content can be synced, added, or removed.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)

    Number of results to return per page.

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

    Filter results where name contains value

  • :name__icontains (String)

    Filter results where name contains value

  • :name__in (Array<String>)

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

  • :name__startswith (String)

    Filter results where name starts with value

  • :offset (Integer)

    The initial index from which to return the results.

  • :ordering (String)

    Which field to use when ordering the results.

  • :pulp_label_select (String)

    Filter labels by search string

  • :fields (String)

    A list of fields to include in the response.

  • :exclude_fields (String)

    A list of fields to exclude from the response.

Returns:



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
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 183

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

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

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

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

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

Parameters:

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

    the optional parameters

Returns:



243
244
245
246
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 243

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

#modify_with_http_info(file_file_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:

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



254
255
256
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
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 254

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

#partial_update(file_file_repository_href, patchedfile_file_repository, opts = {}) ⇒ AsyncOperationResponse

Update a file repository Trigger an asynchronous partial update task

Parameters:

  • file_file_repository_href (String)
  • patchedfile_file_repository (PatchedfileFileRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



313
314
315
316
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 313

def partial_update(file_file_repository_href, patchedfile_file_repository, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(file_file_repository_href, patchedfile_file_repository, opts)
  data
end

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

Update a file repository Trigger an asynchronous partial update task

Parameters:

  • file_file_repository_href (String)
  • patchedfile_file_repository (PatchedfileFileRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 324

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

#read(file_file_repository_href, opts = {}) ⇒ FileFileRepositoryResponse

Inspect a file repository

FileRepository represents a single file repository, to which content can be synced, added, or removed.

Parameters:

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



384
385
386
387
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 384

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

#read_with_http_info(file_file_repository_href, opts = {}) ⇒ Array<(FileFileRepositoryResponse, Integer, Hash)>

Inspect a file repository

FileRepository represents a single file repository, to which content can be synced, added, or removed.

Parameters:

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

  • (Array<(FileFileRepositoryResponse, Integer, Hash)>)

    FileFileRepositoryResponse data, response status code and response headers



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
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 396

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

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

#sync(file_file_repository_href, repository_sync_url, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to sync file content.

Parameters:

  • file_file_repository_href (String)
  • repository_sync_url (RepositorySyncURL)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



450
451
452
453
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 450

def sync(file_file_repository_href, repository_sync_url, opts = {})
  data, _status_code, _headers = sync_with_http_info(file_file_repository_href, repository_sync_url, opts)
  data
end

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

Trigger an asynchronous task to sync file content.

Parameters:

  • file_file_repository_href (String)
  • repository_sync_url (RepositorySyncURL)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



460
461
462
463
464
465
466
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
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 460

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

#update(file_file_repository_href, file_file_repository, opts = {}) ⇒ AsyncOperationResponse

Update a file repository Trigger an asynchronous update task

Parameters:

  • file_file_repository_href (String)
  • file_file_repository (FileFileRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



519
520
521
522
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 519

def update(file_file_repository_href, file_file_repository, opts = {})
  data, _status_code, _headers = update_with_http_info(file_file_repository_href, file_file_repository, opts)
  data
end

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

Update a file repository Trigger an asynchronous update task

Parameters:

  • file_file_repository_href (String)
  • file_file_repository (FileFileRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



530
531
532
533
534
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
# File 'lib/pulp_file_client/api/repositories_file_api.rb', line 530

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