Class: PulpAnsibleClient::RepositoriesAnsibleVersionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RepositoriesAnsibleVersionsApi



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

def api_client
  @api_client
end

Instance Method Details

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

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

Options Hash (opts):

  • :content (String)

    content

  • :content__in (String)

    content__in

  • :number (String)

    number

  • :number__gt (String)

    number__gt

  • :number__gte (String)

    number__gte

  • :number__lt (String)

    number__lt

  • :number__lte (String)

    number__lte

  • :number__range (String)

    number__range

  • :ordering (String)

    Which field to use when ordering the results.

  • :pulp_created (String)

    pulp_created

  • :pulp_created__gt (String)

    pulp_created__gt

  • :pulp_created__gte (String)

    pulp_created__gte

  • :pulp_created__lt (String)

    pulp_created__lt

  • :pulp_created__lte (String)

    pulp_created__lte

  • :pulp_created__range (String)

    pulp_created__range



42
43
44
45
# File 'lib/pulp_ansible_client/api/repositories_ansible_versions_api.rb', line 42

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

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

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

Options Hash (opts):

  • :content (String)

    content

  • :content__in (String)

    content__in

  • :number (String)

    number

  • :number__gt (String)

    number__gt

  • :number__gte (String)

    number__gte

  • :number__lt (String)

    number__lt

  • :number__lte (String)

    number__lte

  • :number__range (String)

    number__range

  • :ordering (String)

    Which field to use when ordering the results.

  • :pulp_created (String)

    pulp_created

  • :pulp_created__gt (String)

    pulp_created__gt

  • :pulp_created__gte (String)

    pulp_created__gte

  • :pulp_created__lt (String)

    pulp_created__lt

  • :pulp_created__lte (String)

    pulp_created__lte

  • :pulp_created__range (String)

    pulp_created__range



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
# File 'lib/pulp_ansible_client/api/repositories_ansible_versions_api.rb', line 67

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

#list(ansible_ansible_repository_href, opts = {}) ⇒ InlineResponse2008

List repository versions AnsibleRepositoryVersion represents a single file repository version.

Options Hash (opts):

  • :content (String)

    content

  • :content__in (String)

    content__in

  • :limit (Integer)

    Number of results to return per page.

  • :number (String)

    number

  • :number__gt (String)

    number__gt

  • :number__gte (String)

    number__gte

  • :number__lt (String)

    number__lt

  • :number__lte (String)

    number__lte

  • :number__range (String)

    number__range

  • :offset (Integer)

    The initial index from which to return the results.

  • :ordering (String)

    Which field to use when ordering the results.

  • :pulp_created (String)

    pulp_created

  • :pulp_created__gt (String)

    pulp_created__gt

  • :pulp_created__gte (String)

    pulp_created__gte

  • :pulp_created__lt (String)

    pulp_created__lt

  • :pulp_created__lte (String)

    pulp_created__lte

  • :pulp_created__range (String)

    pulp_created__range

  • :fields (String)

    A list of fields to include in the response.

  • :exclude_fields (String)

    A list of fields to exclude from the response.



153
154
155
156
# File 'lib/pulp_ansible_client/api/repositories_ansible_versions_api.rb', line 153

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

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

List repository versions AnsibleRepositoryVersion represents a single file repository version.

Options Hash (opts):

  • :content (String)

    content

  • :content__in (String)

    content__in

  • :limit (Integer)

    Number of results to return per page.

  • :number (String)

    number

  • :number__gt (String)

    number__gt

  • :number__gte (String)

    number__gte

  • :number__lt (String)

    number__lt

  • :number__lte (String)

    number__lte

  • :number__range (String)

    number__range

  • :offset (Integer)

    The initial index from which to return the results.

  • :ordering (String)

    Which field to use when ordering the results.

  • :pulp_created (String)

    pulp_created

  • :pulp_created__gt (String)

    pulp_created__gt

  • :pulp_created__gte (String)

    pulp_created__gte

  • :pulp_created__lt (String)

    pulp_created__lt

  • :pulp_created__lte (String)

    pulp_created__lte

  • :pulp_created__range (String)

    pulp_created__range

  • :fields (String)

    A list of fields to include in the response.

  • :exclude_fields (String)

    A list of fields to exclude from the response.



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

def list_with_http_info(ansible_ansible_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleVersionsApi.list ...'
  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 RepositoriesAnsibleVersionsApi.list"
  end
  # resource path
  local_var_path = '{ansible_ansible_repository_href}versions/'.sub('{' + 'ansible_ansible_repository_href' + '}', CGI.escape(ansible_ansible_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'] = opts[:'number__range'] if !opts[:'number__range'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] 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'] = opts[:'pulp_created__range'] if !opts[:'pulp_created__range'].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] || 'InlineResponse2008' 

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

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

Inspect a repository version AnsibleRepositoryVersion represents a single file repository version.

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.



255
256
257
258
# File 'lib/pulp_ansible_client/api/repositories_ansible_versions_api.rb', line 255

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

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

Inspect a repository version AnsibleRepositoryVersion represents a single file repository version.

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.



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/pulp_ansible_client/api/repositories_ansible_versions_api.rb', line 267

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

#repair(ansible_ansible_repository_version_href, repository_version, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to repair a repositroy version.



321
322
323
324
# File 'lib/pulp_ansible_client/api/repositories_ansible_versions_api.rb', line 321

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

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

Trigger an asynchronous task to repair a repositroy version.



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_versions_api.rb', line 331

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

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