Class: PulpcoreClient::AccessPoliciesApi
- Inherits:
-
Object
- Object
- PulpcoreClient::AccessPoliciesApi
- Defined in:
- lib/pulpcore_client/api/access_policies_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ AccessPoliciesApi
constructor
A new instance of AccessPoliciesApi.
-
#list(opts = {}) ⇒ PaginatedAccessPolicyResponseList
List access policys ViewSet for AccessPolicy.
-
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedAccessPolicyResponseList, Integer, Hash)>
List access policys ViewSet for AccessPolicy.
-
#partial_update(access_policy_href, patched_access_policy, opts = {}) ⇒ AccessPolicyResponse
Update an access policy ViewSet for AccessPolicy.
-
#partial_update_with_http_info(access_policy_href, patched_access_policy, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>
Update an access policy ViewSet for AccessPolicy.
-
#read(access_policy_href, opts = {}) ⇒ AccessPolicyResponse
Inspect an access policy ViewSet for AccessPolicy.
-
#read_with_http_info(access_policy_href, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>
Inspect an access policy ViewSet for AccessPolicy.
-
#reset(access_policy_href, opts = {}) ⇒ AccessPolicyResponse
Reset the access policy to its uncustomized default value.
-
#reset_with_http_info(access_policy_href, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>
Reset the access policy to its uncustomized default value.
-
#update(access_policy_href, access_policy, opts = {}) ⇒ AccessPolicyResponse
Update an access policy ViewSet for AccessPolicy.
-
#update_with_http_info(access_policy_href, access_policy, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>
Update an access policy ViewSet for AccessPolicy.
Constructor Details
permalink #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
permalink #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
permalink #list(opts = {}) ⇒ PaginatedAccessPolicyResponseList
List access policys ViewSet for AccessPolicy.
45 46 47 48 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 45 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
permalink #list_with_http_info(opts = {}) ⇒ Array<(PaginatedAccessPolicyResponseList, Integer, Hash)>
List access policys ViewSet for AccessPolicy.
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 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 73 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[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].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__iregex'] = opts[:'viewset_name__iregex'] if !opts[:'viewset_name__iregex'].nil? query_params[:'viewset_name__istartswith'] = opts[:'viewset_name__istartswith'] if !opts[:'viewset_name__istartswith'].nil? query_params[:'viewset_name__regex'] = opts[:'viewset_name__regex'] if !opts[:'viewset_name__regex'].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']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PaginatedAccessPolicyResponseList' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccessPoliciesApi.list", :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, ) 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 |
permalink #partial_update(access_policy_href, patched_access_policy, opts = {}) ⇒ AccessPolicyResponse
Update an access policy ViewSet for AccessPolicy.
146 147 148 149 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 146 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 |
permalink #partial_update_with_http_info(access_policy_href, patched_access_policy, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>
Update an access policy ViewSet for AccessPolicy.
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 157 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(patched_access_policy) # return_type return_type = opts[:debug_return_type] || 'AccessPolicyResponse' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccessPoliciesApi.partial_update", :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, ) 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 |
permalink #read(access_policy_href, opts = {}) ⇒ AccessPolicyResponse
Inspect an access policy ViewSet for AccessPolicy.
221 222 223 224 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 221 def read(access_policy_href, opts = {}) data, _status_code, _headers = read_with_http_info(access_policy_href, opts) data end |
permalink #read_with_http_info(access_policy_href, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>
Inspect an access policy ViewSet for AccessPolicy.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 233 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']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AccessPolicyResponse' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccessPoliciesApi.read", :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, ) 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 |
permalink #reset(access_policy_href, opts = {}) ⇒ AccessPolicyResponse
Reset the access policy to its uncustomized default value.
287 288 289 290 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 287 def reset(access_policy_href, opts = {}) data, _status_code, _headers = reset_with_http_info(access_policy_href, opts) data end |
permalink #reset_with_http_info(access_policy_href, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>
Reset the access policy to its uncustomized default value.
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 296 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']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AccessPolicyResponse' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccessPoliciesApi.reset", :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, ) 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 |
permalink #update(access_policy_href, access_policy, opts = {}) ⇒ AccessPolicyResponse
Update an access policy ViewSet for AccessPolicy.
350 351 352 353 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 350 def update(access_policy_href, access_policy, opts = {}) data, _status_code, _headers = update_with_http_info(access_policy_href, access_policy, opts) data end |
permalink #update_with_http_info(access_policy_href, access_policy, opts = {}) ⇒ Array<(AccessPolicyResponse, Integer, Hash)>
Update an access policy ViewSet for AccessPolicy.
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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 361 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(access_policy) # return_type return_type = opts[:debug_return_type] || 'AccessPolicyResponse' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccessPoliciesApi.update", :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, ) 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 |