Class: PulpFileClient::RepositoriesFileVersionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RepositoriesFileVersionsApi

Returns a new instance of RepositoriesFileVersionsApi.



19
20
21
 
# File 'lib/pulp_file_client/api/repositories_file_versions_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_file_client/api/repositories_file_versions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Delete a repository version Trigger an asynchronous task to delete a repository version.

Parameters:

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

    the optional parameters

Returns:



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

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

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

Delete a repository version Trigger an asynchronous task to delete a repository version.

Parameters:

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

    the optional parameters

Returns:

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

    AsyncOperationResponse 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
 
# File 'lib/pulp_file_client/api/repositories_file_versions_api.rb', line 37

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

#list(file_file_repository_href, opts = {}) ⇒ PaginatedRepositoryVersionResponseList

List repository versions

FileRepositoryVersion represents a single file repository version.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :content (String) —

    Content Unit referenced by HREF

  • :content__in (String) —

    Content Unit referenced by HREF

  • :limit (Integer) —

    Number of results to return per page.

  • :number (Integer) —

    Filter results where number matches value

  • :number__gt (Integer) —

    Filter results where number is greater than value

  • :number__gte (Integer) —

    Filter results where number is greater than or equal to value

  • :number__lt (Integer) —

    Filter results where number is less than value

  • :number__lte (Integer) —

    Filter results where number is less than or equal to value

  • :number__range (Array<Integer>) —

    Filter results where number is between two comma separated values

  • :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;number&#x60; - Number * &#x60;-number&#x60; - Number (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;info&#x60; - Info * &#x60;-info&#x60; - Info (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :pulp_created (DateTime) —

    Filter results where pulp_created matches value

  • :pulp_created__gt (DateTime) —

    Filter results where pulp_created is greater than value

  • :pulp_created__gte (DateTime) —

    Filter results where pulp_created is greater than or equal to value

  • :pulp_created__lt (DateTime) —

    Filter results where pulp_created is less than value

  • :pulp_created__lte (DateTime) —

    Filter results where pulp_created is less than or equal to value

  • :pulp_created__range (Array<DateTime>) —

    Filter results where pulp_created is between two comma separated values

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String)
  • :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:



110
111
112
113
 
# File 'lib/pulp_file_client/api/repositories_file_versions_api.rb', line 110

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

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

List repository versions

FileRepositoryVersion represents a single file repository version.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :content (String) —

    Content Unit referenced by HREF

  • :content__in (String) —

    Content Unit referenced by HREF

  • :limit (Integer) —

    Number of results to return per page.

  • :number (Integer) —

    Filter results where number matches value

  • :number__gt (Integer) —

    Filter results where number is greater than value

  • :number__gte (Integer) —

    Filter results where number is greater than or equal to value

  • :number__lt (Integer) —

    Filter results where number is less than value

  • :number__lte (Integer) —

    Filter results where number is less than or equal to value

  • :number__range (Array<Integer>) —

    Filter results where number is between two comma separated values

  • :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;number&#x60; - Number * &#x60;-number&#x60; - Number (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;info&#x60; - Info * &#x60;-info&#x60; - Info (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :pulp_created (DateTime) —

    Filter results where pulp_created matches value

  • :pulp_created__gt (DateTime) —

    Filter results where pulp_created is greater than value

  • :pulp_created__gte (DateTime) —

    Filter results where pulp_created is greater than or equal to value

  • :pulp_created__lt (DateTime) —

    Filter results where pulp_created is less than value

  • :pulp_created__lte (DateTime) —

    Filter results where pulp_created is less than or equal to value

  • :pulp_created__range (Array<DateTime>) —

    Filter results where pulp_created is between two comma separated values

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String)
  • :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:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/pulp_file_client/api/repositories_file_versions_api.rb', line 141

def list_with_http_info(file_file_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesFileVersionsApi.list ...'
  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 RepositoriesFileVersionsApi.list"
  end
  allowable_values = ["-complete", "-info", "-number", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "complete", "info", "number", "pk", "pulp_created", "pulp_id", "pulp_last_updated"]
  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 = '{file_file_repository_href}versions/'.sub('{' + 'file_file_repository_href' + '}', CGI.escape(file_file_repository_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
  query_params[:'content__in'] = opts[:'content__in'] if !opts[:'content__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
  query_params[:'number__gt'] = opts[:'number__gt'] if !opts[:'number__gt'].nil?
  query_params[:'number__gte'] = opts[:'number__gte'] if !opts[:'number__gte'].nil?
  query_params[:'number__lt'] = opts[:'number__lt'] if !opts[:'number__lt'].nil?
  query_params[:'number__lte'] = opts[:'number__lte'] if !opts[:'number__lte'].nil?
  query_params[:'number__range'] = @api_client.build_collection_param(opts[:'number__range'], :csv) if !opts[:'number__range'].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_created'] = opts[:'pulp_created'] if !opts[:'pulp_created'].nil?
  query_params[:'pulp_created__gt'] = opts[:'pulp_created__gt'] if !opts[:'pulp_created__gt'].nil?
  query_params[:'pulp_created__gte'] = opts[:'pulp_created__gte'] if !opts[:'pulp_created__gte'].nil?
  query_params[:'pulp_created__lt'] = opts[:'pulp_created__lt'] if !opts[:'pulp_created__lt'].nil?
  query_params[:'pulp_created__lte'] = opts[:'pulp_created__lte'] if !opts[:'pulp_created__lte'].nil?
  query_params[:'pulp_created__range'] = @api_client.build_collection_param(opts[:'pulp_created__range'], :csv) if !opts[:'pulp_created__range'].nil?
  query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__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'])

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

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

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

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

#read(file_file_repository_version_href, opts = {}) ⇒ RepositoryVersionResponse

Inspect a repository version

FileRepositoryVersion represents a single file repository version.

Parameters:

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



220
221
222
223
 
# File 'lib/pulp_file_client/api/repositories_file_versions_api.rb', line 220

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

#read_with_http_info(file_file_repository_version_href, opts = {}) ⇒ Array<(RepositoryVersionResponse, Integer, Hash)>

Inspect a repository version

FileRepositoryVersion represents a single file repository version.

Parameters:

  • file_file_repository_version_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<(RepositoryVersionResponse, Integer, Hash)>) —

    RepositoryVersionResponse data, response status code and response headers



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
 
# File 'lib/pulp_file_client/api/repositories_file_versions_api.rb', line 232

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

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

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

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

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

#repair(file_file_repository_version_href, repair, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to repair a repository version.

Parameters:

  • file_file_repository_version_href (String)
  • repair (Repair)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



286
287
288
289
 
# File 'lib/pulp_file_client/api/repositories_file_versions_api.rb', line 286

def repair(file_file_repository_version_href, repair, opts = {})
  data, _status_code, _headers = repair_with_http_info(file_file_repository_version_href, repair, opts)
  data
end

#repair_with_http_info(file_file_repository_version_href, repair, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Trigger an asynchronous task to repair a repository version.

Parameters:

  • file_file_repository_version_href (String)
  • repair (Repair)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/pulp_file_client/api/repositories_file_versions_api.rb', line 296

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

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