Class: Metronome::PolicyManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/metronome/api/policy_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PolicyManagementApi

Returns a new instance of PolicyManagementApi.



19
20
21
 
# File 'lib/metronome/api/policy_management_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/metronome/api/policy_management_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_many_policies(opts = {}) ⇒ GetManyPolicies200Response

Read many policies alphanumerically sorted

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :prefix (String)
  • :offset (Integer) —

    The number of policies to drop from the start

  • :limit (Integer) —

    The number of policies to include

  • :include_data (Boolean) —

    Whether to include aging-strategy, aging-offset-amount, aging-offset-unit etc.

Returns:



29
30
31
32
 
# File 'lib/metronome/api/policy_management_api.rb', line 29

def get_many_policies(opts = {})
  data, _status_code, _headers = get_many_policies_with_http_info(opts)
  data
end

#get_many_policies_with_http_info(opts = {}) ⇒ Array<(GetManyPolicies200Response, Integer, Hash)>

Read many policies alphanumerically sorted

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :prefix (String)
  • :offset (Integer) —

    The number of policies to drop from the start

  • :limit (Integer) —

    The number of policies to include

  • :include_data (Boolean) —

    Whether to include aging-strategy, aging-offset-amount, aging-offset-unit etc.

Returns:

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

    GetManyPolicies200Response data, response status code and response headers



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
89
90
91
92
93
94
95
 
# File 'lib/metronome/api/policy_management_api.rb', line 41

def get_many_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyManagementApi.get_many_policies ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 1
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling PolicyManagementApi.get_many_policies, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PolicyManagementApi.get_many_policies, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/metronome/policies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'prefix'] = opts[:'prefix'] if !opts[:'prefix'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'include-data'] = opts[:'include_data'] if !opts[:'include_data'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetManyPolicies200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PolicyManagementApi.get_many_policies",
    :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: PolicyManagementApi#get_many_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_policy(policy_id, opts = {}) ⇒ PolicyData

Read a specific policy

Parameters:

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

    the optional parameters

Returns:



101
102
103
104
 
# File 'lib/metronome/api/policy_management_api.rb', line 101

def get_policy(policy_id, opts = {})
  data, _status_code, _headers = get_policy_with_http_info(policy_id, opts)
  data
end

#get_policy_log(policy_id, opts = {}) ⇒ PolicyData

Read a specific policy’s access log

Parameters:

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

    the optional parameters

Returns:



162
163
164
165
 
# File 'lib/metronome/api/policy_management_api.rb', line 162

def get_policy_log(policy_id, opts = {})
  data, _status_code, _headers = get_policy_log_with_http_info(policy_id, opts)
  data
end

#get_policy_log_with_http_info(policy_id, opts = {}) ⇒ Array<(PolicyData, Integer, Hash)>

Read a specific policy&#39;s access log

Parameters:

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

    the optional parameters

Returns:

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

    PolicyData data, response status code and response headers



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
213
214
215
216
217
 
# File 'lib/metronome/api/policy_management_api.rb', line 171

def get_policy_log_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyManagementApi.get_policy_log ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling PolicyManagementApi.get_policy_log"
  end
  # resource path
  local_var_path = '/v1/metronome/policies/{policy-id}/log'.sub('{' + 'policy-id' + '}', CGI.escape(policy_id.to_s))

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

  # return_type
  return_type = opts[:debug_return_type] || 'PolicyData'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PolicyManagementApi.get_policy_log",
    :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: PolicyManagementApi#get_policy_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_policy_members(policy_id, opts = {}) ⇒ PolicyData

Read the items and sub-items that have been used for a specific policy

Parameters:

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

    the optional parameters

Returns:



223
224
225
226
 
# File 'lib/metronome/api/policy_management_api.rb', line 223

def get_policy_members(policy_id, opts = {})
  data, _status_code, _headers = get_policy_members_with_http_info(policy_id, opts)
  data
end

#get_policy_members_with_http_info(policy_id, opts = {}) ⇒ Array<(PolicyData, Integer, Hash)>

Read the items and sub-items that have been used for a specific policy

Parameters:

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

    the optional parameters

Returns:

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

    PolicyData data, response status code and response headers



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/metronome/api/policy_management_api.rb', line 232

def get_policy_members_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyManagementApi.get_policy_members ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling PolicyManagementApi.get_policy_members"
  end
  # resource path
  local_var_path = '/v1/metronome/policies/{policy-id}/members'.sub('{' + 'policy-id' + '}', CGI.escape(policy_id.to_s))

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

  # return_type
  return_type = opts[:debug_return_type] || 'PolicyData'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PolicyManagementApi.get_policy_members",
    :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: PolicyManagementApi#get_policy_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(PolicyData, Integer, Hash)>

Read a specific policy

Parameters:

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

    the optional parameters

Returns:

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

    PolicyData 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
 
# File 'lib/metronome/api/policy_management_api.rb', line 110

def get_policy_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyManagementApi.get_policy ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling PolicyManagementApi.get_policy"
  end
  # resource path
  local_var_path = '/v1/metronome/policies/{policy-id}'.sub('{' + 'policy-id' + '}', CGI.escape(policy_id.to_s))

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

  # return_type
  return_type = opts[:debug_return_type] || 'PolicyData'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PolicyManagementApi.get_policy",
    :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: PolicyManagementApi#get_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_policy(policy_id, opts = {}) ⇒ CreateOrModifyPolicyResponse

Create or modify a policy

Parameters:

  • policy_id (String) —

    The name of the policy to be created

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

    the optional parameters

Options Hash (opts):

Returns:



285
286
287
288
 
# File 'lib/metronome/api/policy_management_api.rb', line 285

def put_policy(policy_id, opts = {})
  data, _status_code, _headers = put_policy_with_http_info(policy_id, opts)
  data
end

#put_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(CreateOrModifyPolicyResponse, Integer, Hash)>

Create or modify a policy

Parameters:

  • policy_id (String) —

    The name of the policy to be created

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

    the optional parameters

Options Hash (opts):

Returns:



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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/metronome/api/policy_management_api.rb', line 295

def put_policy_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyManagementApi.put_policy ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling PolicyManagementApi.put_policy"
  end
  # resource path
  local_var_path = '/v1/metronome/policies/{policy-id}'.sub('{' + 'policy-id' + '}', CGI.escape(policy_id.to_s))

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  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(opts[:'create_or_modify_policy_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CreateOrModifyPolicyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PolicyManagementApi.put_policy",
    :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: PolicyManagementApi#put_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end