Class: PulpcoreClient::AccessPoliciesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccessPoliciesApi

Returns a new instance of AccessPoliciesApi.



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

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ PaginatedAccessPolicyResponseList

List access policys ViewSet for AccessPolicy. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customized (Boolean) —

    Filter results where customized matches value

  • :limit (Integer) —

    Number of results to return per page.

  • :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;creation_hooks&#x60; - Creation hooks * &#x60;-creation_hooks&#x60; - Creation hooks (descending) * &#x60;statements&#x60; - Statements * &#x60;-statements&#x60; - Statements (descending) * &#x60;viewset_name&#x60; - Viewset name * &#x60;-viewset_name&#x60; - Viewset name (descending) * &#x60;customized&#x60; - Customized * &#x60;-customized&#x60; - Customized (descending) * &#x60;queryset_scoping&#x60; - Queryset scoping * &#x60;-queryset_scoping&#x60; - Queryset scoping (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String)
  • :viewset_name (String) —

    Filter results where viewset_name matches value

  • :viewset_name__contains (String) —

    Filter results where viewset_name contains value

  • :viewset_name__icontains (String) —

    Filter results where viewset_name contains value

  • :viewset_name__iexact (String) —

    Filter results where viewset_name matches value

  • :viewset_name__in (Array<String>) —

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

  • :viewset_name__istartswith (String) —

    Filter results where viewset_name starts with value

  • :viewset_name__startswith (String) —

    Filter results where viewset_name starts with value

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



42
43
44
45
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 42

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

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

List access policys ViewSet for AccessPolicy. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customized (Boolean) —

    Filter results where customized matches value

  • :limit (Integer) —

    Number of results to return per page.

  • :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;creation_hooks&#x60; - Creation hooks * &#x60;-creation_hooks&#x60; - Creation hooks (descending) * &#x60;statements&#x60; - Statements * &#x60;-statements&#x60; - Statements (descending) * &#x60;viewset_name&#x60; - Viewset name * &#x60;-viewset_name&#x60; - Viewset name (descending) * &#x60;customized&#x60; - Customized * &#x60;-customized&#x60; - Customized (descending) * &#x60;queryset_scoping&#x60; - Queryset scoping * &#x60;-queryset_scoping&#x60; - Queryset scoping (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String)
  • :viewset_name (String) —

    Filter results where viewset_name matches value

  • :viewset_name__contains (String) —

    Filter results where viewset_name contains value

  • :viewset_name__icontains (String) —

    Filter results where viewset_name contains value

  • :viewset_name__iexact (String) —

    Filter results where viewset_name matches value

  • :viewset_name__in (Array<String>) —

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

  • :viewset_name__istartswith (String) —

    Filter results where viewset_name starts with value

  • :viewset_name__startswith (String) —

    Filter results where viewset_name starts with value

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



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
128
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 67

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessPoliciesApi.list ...'
  end
  allowable_values = ["-creation_hooks", "-customized", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-queryset_scoping", "-statements", "-viewset_name", "creation_hooks", "customized", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "queryset_scoping", "statements", "viewset_name"]
  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 = '/pulp/api/v3/access_policies/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'customized'] = opts[:'customized'] if !opts[:'customized'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
  query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'viewset_name'] = opts[:'viewset_name'] if !opts[:'viewset_name'].nil?
  query_params[:'viewset_name__contains'] = opts[:'viewset_name__contains'] if !opts[:'viewset_name__contains'].nil?
  query_params[:'viewset_name__icontains'] = opts[:'viewset_name__icontains'] if !opts[:'viewset_name__icontains'].nil?
  query_params[:'viewset_name__iexact'] = opts[:'viewset_name__iexact'] if !opts[:'viewset_name__iexact'].nil?
  query_params[:'viewset_name__in'] = @api_client.build_collection_param(opts[:'viewset_name__in'], :csv) if !opts[:'viewset_name__in'].nil?
  query_params[:'viewset_name__istartswith'] = opts[:'viewset_name__istartswith'] if !opts[:'viewset_name__istartswith'].nil?
  query_params[:'viewset_name__startswith'] = opts[:'viewset_name__startswith'] if !opts[:'viewset_name__startswith'].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] || 'PaginatedAccessPolicyResponseList' 

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

#partial_update(access_policy_href, patched_access_policy, opts = {}) ⇒ AccessPolicyResponse

Update an access policy ViewSet for AccessPolicy. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

  • access_policy_href (String)
  • patched_access_policy (PatchedAccessPolicy)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



136
137
138
139
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 136

def partial_update(access_policy_href, patched_access_policy, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(access_policy_href, patched_access_policy, opts)
  data
end

#partial_update_with_http_info(access_policy_href, patched_access_policy, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>

Update an access policy ViewSet for AccessPolicy. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

  • access_policy_href (String)
  • patched_access_policy (PatchedAccessPolicy)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AccessPolicyResponse data, response status code and response headers



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

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

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

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

#read(access_policy_href, opts = {}) ⇒ AccessPolicyResponse

Inspect an access policy ViewSet for AccessPolicy. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

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



207
208
209
210
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 207

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

#read_with_http_info(access_policy_href, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>

Inspect an access policy ViewSet for AccessPolicy. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

  • access_policy_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<(AccessPolicyResponse, Integer, Hash)>) —

    AccessPolicyResponse data, response status code and response headers



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

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

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

#reset(access_policy_href, opts = {}) ⇒ AccessPolicyResponse

Reset the access policy to its uncustomized default value.

Parameters:

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

    the optional parameters

Returns:



272
273
274
275
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 272

def reset(access_policy_href, opts = {})
  data, _status_code, _headers = reset_with_http_info(access_policy_href, opts)
  data
end

#reset_with_http_info(access_policy_href, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>

Reset the access policy to its uncustomized default value.

Parameters:

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

    the optional parameters

Returns:

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

    AccessPolicyResponse data, response status code and response headers



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
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 281

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

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

#update(access_policy_href, access_policy, opts = {}) ⇒ AccessPolicyResponse

Update an access policy ViewSet for AccessPolicy. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

  • access_policy_href (String)
  • access_policy (AccessPolicy)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



334
335
336
337
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 334

def update(access_policy_href, access_policy, opts = {})
  data, _status_code, _headers = update_with_http_info(access_policy_href, access_policy, opts)
  data
end

#update_with_http_info(access_policy_href, access_policy, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>

Update an access policy ViewSet for AccessPolicy. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

  • access_policy_href (String)
  • access_policy (AccessPolicy)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AccessPolicyResponse data, response status code and response headers



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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 345

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

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

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