Class: DatadogAPIClient::V2::ExecutionPolicyAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/execution_policy_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ ExecutionPolicyAPI

Returns a new instance of ExecutionPolicyAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_execution_policy(body, opts = {}) ⇒ Object

Create an execution policy.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 29

def create_execution_policy(body, opts = {})
  data, _status_code, _headers = create_execution_policy_with_http_info(body, opts)
  data
end

#create_execution_policy_with_http_info(body, opts = {}) ⇒ Array<(ExecutionPolicyResponse, Integer, Hash)>

Create an execution policy.

Create a new execution policy.

Parameters:

Returns:

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

    ExecutionPolicyResponse 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
96
97
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 41

def create_execution_policy_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_execution_policy".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_execution_policy")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_execution_policy"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExecutionPolicyAPI.create_execution_policy ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ExecutionPolicyAPI.create_execution_policy"
  end
  # resource path
  local_var_path = '/api/v2/actions/execution-policies'

  # 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'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_execution_policy,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExecutionPolicyAPI#create_execution_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_execution_policy(policy_id, opts = {}) ⇒ Object

Delete an execution policy.

See Also:



102
103
104
105
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 102

def delete_execution_policy(policy_id, opts = {})
  delete_execution_policy_with_http_info(policy_id, opts)
  nil
end

#delete_execution_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an execution policy.

Delete a specific execution policy.

Parameters:

  • policy_id (String) —

    The ID of the execution policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
162
163
164
165
166
167
168
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 114

def delete_execution_policy_with_http_info(policy_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_execution_policy".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_execution_policy")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_execution_policy"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExecutionPolicyAPI.delete_execution_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 ExecutionPolicyAPI.delete_execution_policy"
  end
  # resource path
  local_var_path = '/api/v2/actions/execution-policies/{policy_id}'.sub('{policy_id}', CGI.escape(policy_id.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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_execution_policy,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExecutionPolicyAPI#delete_execution_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_execution_policy(policy_id, opts = {}) ⇒ Object

Get an execution policy.

See Also:



173
174
175
176
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 173

def get_execution_policy(policy_id, opts = {})
  data, _status_code, _headers = get_execution_policy_with_http_info(policy_id, opts)
  data
end

#get_execution_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(ExecutionPolicyResponse, Integer, Hash)>

Get an execution policy.

Retrieve an existing execution policy by ID.

Parameters:

  • policy_id (String) —

    The ID of the execution policy.

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

    the optional parameters

Returns:

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

    ExecutionPolicyResponse data, response status code and response headers



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
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 185

def get_execution_policy_with_http_info(policy_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_execution_policy".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_execution_policy")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_execution_policy"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExecutionPolicyAPI.get_execution_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 ExecutionPolicyAPI.get_execution_policy"
  end
  # resource path
  local_var_path = '/api/v2/actions/execution-policies/{policy_id}'.sub('{policy_id}', CGI.escape(policy_id.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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_execution_policy,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExecutionPolicyAPI#get_execution_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_execution_policies(opts = {}) ⇒ Object

List execution policies.

See Also:



244
245
246
247
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 244

def list_execution_policies(opts = {})
  data, _status_code, _headers = list_execution_policies_with_http_info(opts)
  data
end

#list_execution_policies_with_http_info(opts = {}) ⇒ Array<(ExecutionPolicyListResponse, Integer, Hash)>

List execution policies.

Retrieve a list of execution policies for the current organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of execution policies to return per page.

  • :page_number (Integer) —

    The page number to return.

  • :filter_name (String) —

    Filter execution policies by name.

  • :filter_ids (Array<String>) —

    Filter execution policies by a list of IDs.

  • :filter_integration (Array<ExecutionPolicyIntegration>) —

    Filter execution policies by a list of integrations.

  • :filter_effects (Array<ExecutionPolicyEffect>) —

    Filter execution policies by a list of effects.

  • :filter_creator_ids (Array<String>) —

    Filter execution policies by a list of creator IDs.

  • :sort (Array<String>) —

    The sort order for the results. Prefix a field with - to sort in descending order. Valid fields are name, effect, integration, created_at, and updated_at.

Returns:

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

    ExecutionPolicyListResponse data, response status code and response headers



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
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
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 263

def list_execution_policies_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_execution_policies".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_execution_policies")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_execution_policies"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExecutionPolicyAPI.list_execution_policies ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ExecutionPolicyAPI.list_execution_policies, must be smaller than or equal to 100.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_number'].nil? && opts[:'page_number'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_number"]" when calling ExecutionPolicyAPI.list_execution_policies, must be smaller than or equal to 1000.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_number'].nil? && opts[:'page_number'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page_number"]" when calling ExecutionPolicyAPI.list_execution_policies, must be greater than or equal to 0.'
  end
  # resource path
  local_var_path = '/api/v2/actions/execution-policies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'filter[name]'] = opts[:'filter_name'] if !opts[:'filter_name'].nil?
  query_params[:'filter[ids]'] = @api_client.build_collection_param(opts[:'filter_ids'], :multi) if !opts[:'filter_ids'].nil?
  query_params[:'filter[integration]'] = @api_client.build_collection_param(opts[:'filter_integration'], :multi) if !opts[:'filter_integration'].nil?
  query_params[:'filter[effects]'] = @api_client.build_collection_param(opts[:'filter_effects'], :multi) if !opts[:'filter_effects'].nil?
  query_params[:'filter[creator_ids]'] = @api_client.build_collection_param(opts[:'filter_creator_ids'], :multi) if !opts[:'filter_creator_ids'].nil?
  query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].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] || 'ExecutionPolicyListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_execution_policies,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExecutionPolicyAPI#list_execution_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_execution_policy(policy_id, body, opts = {}) ⇒ Object

Update an execution policy.

See Also:



336
337
338
339
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 336

def update_execution_policy(policy_id, body, opts = {})
  data, _status_code, _headers = update_execution_policy_with_http_info(policy_id, body, opts)
  data
end

#update_execution_policy_with_http_info(policy_id, body, opts = {}) ⇒ Array<(ExecutionPolicyResponse, Integer, Hash)>

Update an execution policy.

Update an existing execution policy. Returns the execution policy object when the request is successful.

Parameters:

  • policy_id (String) —

    The ID of the execution policy.

  • body (ExecutionPolicyUpdateRequest) —

    The new execution policy.

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

    the optional parameters

Returns:

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

    ExecutionPolicyResponse data, response status code and response headers



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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/datadog_api_client/v2/api/execution_policy_api.rb', line 350

def update_execution_policy_with_http_info(policy_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_execution_policy".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_execution_policy")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_execution_policy"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExecutionPolicyAPI.update_execution_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 ExecutionPolicyAPI.update_execution_policy"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ExecutionPolicyAPI.update_execution_policy"
  end
  # resource path
  local_var_path = '/api/v2/actions/execution-policies/{policy_id}'.sub('{policy_id}', CGI.escape(policy_id.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'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_execution_policy,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExecutionPolicyAPI#update_execution_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end