Class: PulpcoreClient::ContentguardsRbacApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/contentguards_rbac_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentguardsRbacApi

Returns a new instance of ContentguardsRbacApi.



19
20
21
 
# File 'lib/pulpcore_client/api/contentguards_rbac_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/pulpcore_client/api/contentguards_rbac_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_role(r_b_a_c_content_guard_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Add a role for this object to users/groups.

Parameters:

  • r_b_a_c_content_guard_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 27

def add_role(r_b_a_c_content_guard_href, nested_role, opts = {})
  data, _status_code, _headers = add_role_with_http_info(r_b_a_c_content_guard_href, nested_role, opts)
  data
end

#add_role_with_http_info(r_b_a_c_content_guard_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Add a role for this object to users/groups.

Parameters:

  • r_b_a_c_content_guard_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    NestedRoleResponse 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
85
86
87
88
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 37

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

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

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

#create(rbac_content_guard, opts = {}) ⇒ RBACContentGuardResponse

Create a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 95

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

#create_with_http_info(rbac_content_guard, opts = {}) ⇒ Array<(RBACContentGuardResponse, Integer, Hash)>

Create a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

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

    the optional parameters

Returns:

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

    RBACContentGuardResponse data, response status code and response headers



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
147
148
149
150
151
152
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 105

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

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

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

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

#delete(r_b_a_c_content_guard_href, opts = {}) ⇒ nil

Delete a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


159
160
161
162
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 159

def delete(r_b_a_c_content_guard_href, opts = {})
  delete_with_http_info(r_b_a_c_content_guard_href, opts)
  nil
end

#delete_with_http_info(r_b_a_c_content_guard_href, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
212
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 169

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

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

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

#list(opts = {}) ⇒ PaginatedRBACContentGuardResponseList

List rbac content guards Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

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.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



228
229
230
231
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 228

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

#list_roles(r_b_a_c_content_guard_href, opts = {}) ⇒ ObjectRolesResponse

List roles assigned to this object.

Parameters:

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



306
307
308
309
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 306

def list_roles(r_b_a_c_content_guard_href, opts = {})
  data, _status_code, _headers = list_roles_with_http_info(r_b_a_c_content_guard_href, opts)
  data
end

#list_roles_with_http_info(r_b_a_c_content_guard_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>

List roles assigned to this object.

Parameters:

  • r_b_a_c_content_guard_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<(ObjectRolesResponse, Integer, Hash)>) —

    ObjectRolesResponse data, response status code and response headers



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
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 317

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

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

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

List rbac content guards Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

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.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 247

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

  # 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[:'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] || 'PaginatedRBACContentGuardResponseList' 

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

#my_permissions(r_b_a_c_content_guard_href, opts = {}) ⇒ MyPermissionsResponse

List permissions available to the current user on this object.

Parameters:

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



372
373
374
375
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 372

def my_permissions(r_b_a_c_content_guard_href, opts = {})
  data, _status_code, _headers = my_permissions_with_http_info(r_b_a_c_content_guard_href, opts)
  data
end

#my_permissions_with_http_info(r_b_a_c_content_guard_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>

List permissions available to the current user on this object.

Parameters:

  • r_b_a_c_content_guard_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<(MyPermissionsResponse, Integer, Hash)>) —

    MyPermissionsResponse data, response status code and response headers



383
384
385
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
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 383

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

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

#partial_update(r_b_a_c_content_guard_href, patched_rbac_content_guard, opts = {}) ⇒ RBACContentGuardResponse

Update a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

  • r_b_a_c_content_guard_href (String)
  • patched_rbac_content_guard (PatchedRBACContentGuard)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



438
439
440
441
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 438

def partial_update(r_b_a_c_content_guard_href, patched_rbac_content_guard, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(r_b_a_c_content_guard_href, patched_rbac_content_guard, opts)
  data
end

#partial_update_with_http_info(r_b_a_c_content_guard_href, patched_rbac_content_guard, opts = {}) ⇒ Array<(RBACContentGuardResponse, Integer, Hash)>

Update a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

  • r_b_a_c_content_guard_href (String)
  • patched_rbac_content_guard (PatchedRBACContentGuard)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    RBACContentGuardResponse data, response status code and response headers



449
450
451
452
453
454
455
456
457
458
459
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
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 449

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

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

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

#read(r_b_a_c_content_guard_href, opts = {}) ⇒ RBACContentGuardResponse

Inspect a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

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



509
510
511
512
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 509

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

#read_with_http_info(r_b_a_c_content_guard_href, opts = {}) ⇒ Array<(RBACContentGuardResponse, Integer, Hash)>

Inspect a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

  • r_b_a_c_content_guard_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<(RBACContentGuardResponse, Integer, Hash)>) —

    RBACContentGuardResponse data, response status code and response headers



521
522
523
524
525
526
527
528
529
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
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 521

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

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

#remove_role(r_b_a_c_content_guard_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Remove a role for this object from users/groups.

Parameters:

  • r_b_a_c_content_guard_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



575
576
577
578
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 575

def remove_role(r_b_a_c_content_guard_href, nested_role, opts = {})
  data, _status_code, _headers = remove_role_with_http_info(r_b_a_c_content_guard_href, nested_role, opts)
  data
end

#remove_role_with_http_info(r_b_a_c_content_guard_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Remove a role for this object from users/groups.

Parameters:

  • r_b_a_c_content_guard_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    NestedRoleResponse data, response status code and response headers



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 585

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

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

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

#update(r_b_a_c_content_guard_href, rbac_content_guard, opts = {}) ⇒ RBACContentGuardResponse

Update a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

  • r_b_a_c_content_guard_href (String)
  • rbac_content_guard (RBACContentGuard)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



644
645
646
647
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 644

def update(r_b_a_c_content_guard_href, rbac_content_guard, opts = {})
  data, _status_code, _headers = update_with_http_info(r_b_a_c_content_guard_href, rbac_content_guard, opts)
  data
end

#update_with_http_info(r_b_a_c_content_guard_href, rbac_content_guard, opts = {}) ⇒ Array<(RBACContentGuardResponse, Integer, Hash)>

Update a rbac content guard Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Parameters:

  • r_b_a_c_content_guard_href (String)
  • rbac_content_guard (RBACContentGuard)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    RBACContentGuardResponse data, response status code and response headers



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/pulpcore_client/api/contentguards_rbac_api.rb', line 655

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

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

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