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

  • :limit (Integer) —

    Number of results to return per page.

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



31
32
33
34
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 31

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

  • :limit (Integer) —

    Number of results to return per page.

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



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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || '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:



99
100
101
102
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 99

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



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
153
154
155
156
157
158
159
160
161
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 110

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 (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



170
171
172
173
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 170

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 (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    AccessPolicyResponse data, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 182

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'] = 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] || '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

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



237
238
239
240
 
# File 'lib/pulpcore_client/api/access_policies_api.rb', line 237

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



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

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