Class: PulpAnsibleClient::RemotesRoleApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RemotesRoleApi

Returns a new instance of RemotesRoleApi.



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

def api_client
  @api_client
end

Instance Method Details

#create(ansible_role_remote, opts = {}) ⇒ AnsibleRoleRemoteResponse

Create a role remote ViewSet for Role Remotes.

Parameters:

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

    the optional parameters

Returns:



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

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

#create_with_http_info(ansible_role_remote, opts = {}) ⇒ Array<(AnsibleRoleRemoteResponse, Integer, Hash)>

Create a role remote ViewSet for Role Remotes.

Parameters:

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

    the optional parameters

Returns:

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

    AnsibleRoleRemoteResponse 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_ansible_client/api/remotes_role_api.rb', line 37

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

  # 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_role_remote) 

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

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

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

Delete a role remote Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_last_updated (String) —

    pulp_last_updated

  • :pulp_last_updated__gt (String) —

    pulp_last_updated__gt

  • :pulp_last_updated__gte (String) —

    pulp_last_updated__gte

  • :pulp_last_updated__lt (String) —

    pulp_last_updated__lt

  • :pulp_last_updated__lte (String) —

    pulp_last_updated__lte

  • :pulp_last_updated__range (String) —

    pulp_last_updated__range

Returns:



100
101
102
103
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 100

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

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

Delete a role remote Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_last_updated (String) —

    pulp_last_updated

  • :pulp_last_updated__gt (String) —

    pulp_last_updated__gt

  • :pulp_last_updated__gte (String) —

    pulp_last_updated__gte

  • :pulp_last_updated__lt (String) —

    pulp_last_updated__lt

  • :pulp_last_updated__lte (String) —

    pulp_last_updated__lte

  • :pulp_last_updated__range (String) —

    pulp_last_updated__range

Returns:

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

    AsyncOperationResponse data, response status code and response headers



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 119

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].nil?
  query_params[:'pulp_last_updated__gt'] = opts[:'pulp_last_updated__gt'] if !opts[:'pulp_last_updated__gt'].nil?
  query_params[:'pulp_last_updated__gte'] = opts[:'pulp_last_updated__gte'] if !opts[:'pulp_last_updated__gte'].nil?
  query_params[:'pulp_last_updated__lt'] = opts[:'pulp_last_updated__lt'] if !opts[:'pulp_last_updated__lt'].nil?
  query_params[:'pulp_last_updated__lte'] = opts[:'pulp_last_updated__lte'] if !opts[:'pulp_last_updated__lte'].nil?
  query_params[:'pulp_last_updated__range'] = opts[:'pulp_last_updated__range'] if !opts[:'pulp_last_updated__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: RemotesRoleApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ InlineResponse2006

List role remotes ViewSet for Role Remotes.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_last_updated (String) —

    pulp_last_updated

  • :pulp_last_updated__gt (String) —

    pulp_last_updated__gt

  • :pulp_last_updated__gte (String) —

    pulp_last_updated__gte

  • :pulp_last_updated__lt (String) —

    pulp_last_updated__lt

  • :pulp_last_updated__lte (String) —

    pulp_last_updated__lte

  • :pulp_last_updated__range (String) —

    pulp_last_updated__range

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



192
193
194
195
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 192

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

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

List role remotes ViewSet for Role Remotes.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_last_updated (String) —

    pulp_last_updated

  • :pulp_last_updated__gt (String) —

    pulp_last_updated__gt

  • :pulp_last_updated__gte (String) —

    pulp_last_updated__gte

  • :pulp_last_updated__lt (String) —

    pulp_last_updated__lt

  • :pulp_last_updated__lte (String) —

    pulp_last_updated__lte

  • :pulp_last_updated__range (String) —

    pulp_last_updated__range

  • :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<(InlineResponse2006, Integer, Hash)>) —

    InlineResponse2006 data, response status code and response headers



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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 214

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

  # 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__in'] = opts[:'name__in'] if !opts[:'name__in'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].nil?
  query_params[:'pulp_last_updated__gt'] = opts[:'pulp_last_updated__gt'] if !opts[:'pulp_last_updated__gt'].nil?
  query_params[:'pulp_last_updated__gte'] = opts[:'pulp_last_updated__gte'] if !opts[:'pulp_last_updated__gte'].nil?
  query_params[:'pulp_last_updated__lt'] = opts[:'pulp_last_updated__lt'] if !opts[:'pulp_last_updated__lt'].nil?
  query_params[:'pulp_last_updated__lte'] = opts[:'pulp_last_updated__lte'] if !opts[:'pulp_last_updated__lte'].nil?
  query_params[:'pulp_last_updated__range'] = opts[:'pulp_last_updated__range'] if !opts[:'pulp_last_updated__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] || 'InlineResponse2006' 

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

#partial_update(ansible_role_remote_href, patchedansible_role_remote, opts = {}) ⇒ AsyncOperationResponse

Update a role remote Trigger an asynchronous partial update task

Parameters:

  • ansible_role_remote_href (String)
  • patchedansible_role_remote (PatchedansibleRoleRemote)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_last_updated (String) —

    pulp_last_updated

  • :pulp_last_updated__gt (String) —

    pulp_last_updated__gt

  • :pulp_last_updated__gte (String) —

    pulp_last_updated__gte

  • :pulp_last_updated__lt (String) —

    pulp_last_updated__lt

  • :pulp_last_updated__lte (String) —

    pulp_last_updated__lte

  • :pulp_last_updated__range (String) —

    pulp_last_updated__range

Returns:



285
286
287
288
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 285

def partial_update(ansible_role_remote_href, patchedansible_role_remote, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(ansible_role_remote_href, patchedansible_role_remote, opts)
  data
end

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

Update a role remote Trigger an asynchronous partial update task

Parameters:

  • ansible_role_remote_href (String)
  • patchedansible_role_remote (PatchedansibleRoleRemote)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_last_updated (String) —

    pulp_last_updated

  • :pulp_last_updated__gt (String) —

    pulp_last_updated__gt

  • :pulp_last_updated__gte (String) —

    pulp_last_updated__gte

  • :pulp_last_updated__lt (String) —

    pulp_last_updated__lt

  • :pulp_last_updated__lte (String) —

    pulp_last_updated__lte

  • :pulp_last_updated__range (String) —

    pulp_last_updated__range

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 305

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].nil?
  query_params[:'pulp_last_updated__gt'] = opts[:'pulp_last_updated__gt'] if !opts[:'pulp_last_updated__gt'].nil?
  query_params[:'pulp_last_updated__gte'] = opts[:'pulp_last_updated__gte'] if !opts[:'pulp_last_updated__gte'].nil?
  query_params[:'pulp_last_updated__lt'] = opts[:'pulp_last_updated__lt'] if !opts[:'pulp_last_updated__lt'].nil?
  query_params[:'pulp_last_updated__lte'] = opts[:'pulp_last_updated__lte'] if !opts[:'pulp_last_updated__lte'].nil?
  query_params[:'pulp_last_updated__range'] = opts[:'pulp_last_updated__range'] if !opts[:'pulp_last_updated__range'].nil?

  # 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_role_remote) 

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

#read(ansible_role_remote_href, opts = {}) ⇒ AnsibleRoleRemoteResponse

Inspect a role remote ViewSet for Role Remotes.

Parameters:

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



374
375
376
377
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 374

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

#read_with_http_info(ansible_role_remote_href, opts = {}) ⇒ Array<(AnsibleRoleRemoteResponse, Integer, Hash)>

Inspect a role remote ViewSet for Role Remotes.

Parameters:

  • ansible_role_remote_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<(AnsibleRoleRemoteResponse, Integer, Hash)>) —

    AnsibleRoleRemoteResponse data, response status code and response headers



386
387
388
389
390
391
392
393
394
395
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
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 386

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

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

#update(ansible_role_remote_href, ansible_role_remote, opts = {}) ⇒ AsyncOperationResponse

Update a role remote Trigger an asynchronous update task

Parameters:

  • ansible_role_remote_href (String)
  • ansible_role_remote (AnsibleRoleRemote)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_last_updated (String) —

    pulp_last_updated

  • :pulp_last_updated__gt (String) —

    pulp_last_updated__gt

  • :pulp_last_updated__gte (String) —

    pulp_last_updated__gte

  • :pulp_last_updated__lt (String) —

    pulp_last_updated__lt

  • :pulp_last_updated__lte (String) —

    pulp_last_updated__lte

  • :pulp_last_updated__range (String) —

    pulp_last_updated__range

Returns:



450
451
452
453
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 450

def update(ansible_role_remote_href, ansible_role_remote, opts = {})
  data, _status_code, _headers = update_with_http_info(ansible_role_remote_href, ansible_role_remote, opts)
  data
end

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

Update a role remote Trigger an asynchronous update task

Parameters:

  • ansible_role_remote_href (String)
  • ansible_role_remote (AnsibleRoleRemote)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    name

  • :name__in (String) —

    name__in

  • :ordering (String) —

    Which field to use when ordering the results.

  • :pulp_last_updated (String) —

    pulp_last_updated

  • :pulp_last_updated__gt (String) —

    pulp_last_updated__gt

  • :pulp_last_updated__gte (String) —

    pulp_last_updated__gte

  • :pulp_last_updated__lt (String) —

    pulp_last_updated__lt

  • :pulp_last_updated__lte (String) —

    pulp_last_updated__lte

  • :pulp_last_updated__range (String) —

    pulp_last_updated__range

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/pulp_ansible_client/api/remotes_role_api.rb', line 470

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].nil?
  query_params[:'pulp_last_updated__gt'] = opts[:'pulp_last_updated__gt'] if !opts[:'pulp_last_updated__gt'].nil?
  query_params[:'pulp_last_updated__gte'] = opts[:'pulp_last_updated__gte'] if !opts[:'pulp_last_updated__gte'].nil?
  query_params[:'pulp_last_updated__lt'] = opts[:'pulp_last_updated__lt'] if !opts[:'pulp_last_updated__lt'].nil?
  query_params[:'pulp_last_updated__lte'] = opts[:'pulp_last_updated__lte'] if !opts[:'pulp_last_updated__lte'].nil?
  query_params[:'pulp_last_updated__range'] = opts[:'pulp_last_updated__range'] if !opts[:'pulp_last_updated__range'].nil?

  # 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_role_remote) 

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