Class: DatadogAPIClient::V2::RumRetentionFiltersAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RumRetentionFiltersAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_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/rum_retention_filters_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_retention_filter(app_id, body, opts = {}) ⇒ Object

Create a RUM retention filter.

See Also:



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

def create_retention_filter(app_id, body, opts = {})
  data, _status_code, _headers = create_retention_filter_with_http_info(app_id, body, opts)
  data
end

#create_retention_filter_with_http_info(app_id, body, opts = {}) ⇒ Array<(RumRetentionFilterResponse, Integer, Hash)>

Create a RUM retention filter.

Create a RUM retention filter for a RUM application. Returns RUM retention filter objects from the request body when the request is successful.

Parameters:

  • app_id (String) —

    RUM application ID.

  • body (RumRetentionFilterCreateRequest) —

    The definition of the new RUM retention filter.

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

    the optional parameters

Returns:

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

    RumRetentionFilterResponse data, response status code and response headers



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/rum_retention_filters_api.rb', line 43

def create_retention_filter_with_http_info(app_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRetentionFiltersAPI.create_retention_filter ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RumRetentionFiltersAPI.create_retention_filter"
  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 RumRetentionFiltersAPI.create_retention_filter"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/retention_filters'.sub('{app_id}', CGI.escape(app_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] || 'RumRetentionFilterResponse'

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

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

#delete_retention_filter(app_id, rf_id, opts = {}) ⇒ Object

Delete a RUM retention filter.

See Also:



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

def delete_retention_filter(app_id, rf_id, opts = {})
  delete_retention_filter_with_http_info(app_id, rf_id, opts)
  nil
end

#delete_retention_filter_with_http_info(app_id, rf_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a RUM retention filter.

Delete a RUM retention filter for a RUM application.

Parameters:

  • app_id (String) —

    RUM application ID.

  • rf_id (String) —

    Retention filter ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_retention_filter_with_http_info(app_id, rf_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRetentionFiltersAPI.delete_retention_filter ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RumRetentionFiltersAPI.delete_retention_filter"
  end
  # verify the required parameter 'rf_id' is set
  if @api_client.config.client_side_validation && rf_id.nil?
    fail ArgumentError, "Missing the required parameter 'rf_id' when calling RumRetentionFiltersAPI.delete_retention_filter"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')).sub('{rf_id}', CGI.escape(rf_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_retention_filter,
    :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: RumRetentionFiltersAPI#delete_retention_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_permanent_retention_filter(app_id, permanent_rf_id, opts = {}) ⇒ Object

Get a permanent RUM retention filter.

See Also:



172
173
174
175
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 172

def get_permanent_retention_filter(app_id, permanent_rf_id, opts = {})
  data, _status_code, _headers = get_permanent_retention_filter_with_http_info(app_id, permanent_rf_id, opts)
  data
end

#get_permanent_retention_filter_with_http_info(app_id, permanent_rf_id, opts = {}) ⇒ Array<(RumPermanentRetentionFilterResponse, Integer, Hash)>

Get a permanent RUM retention filter.

Get a permanent RUM retention filter for a RUM application by its identifier.

Parameters:

  • app_id (String) —

    RUM application ID.

  • permanent_rf_id (RumPermanentRetentionFilterID) —

    The identifier of the permanent RUM retention filter.

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

    the optional parameters

Returns:



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
240
241
242
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 185

def get_permanent_retention_filter_with_http_info(app_id, permanent_rf_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRetentionFiltersAPI.get_permanent_retention_filter ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RumRetentionFiltersAPI.get_permanent_retention_filter"
  end
  # verify the required parameter 'permanent_rf_id' is set
  if @api_client.config.client_side_validation && permanent_rf_id.nil?
    fail ArgumentError, "Missing the required parameter 'permanent_rf_id' when calling RumRetentionFiltersAPI.get_permanent_retention_filter"
  end
  # verify enum value
  allowable_values = ['rum_apm_flat_sampling', 'synthetics_sessions', 'forced_replay_sessions']
  if @api_client.config.client_side_validation && !allowable_values.include?(permanent_rf_id)
    fail ArgumentError, "invalid value for \"permanent_rf_id\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/retention_filters/permanent/{permanent_rf_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')).sub('{permanent_rf_id}', CGI.escape(permanent_rf_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] || 'RumPermanentRetentionFilterResponse'

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

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

#get_retention_filter(app_id, rf_id, opts = {}) ⇒ Object

Get a RUM retention filter.

See Also:



247
248
249
250
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 247

def get_retention_filter(app_id, rf_id, opts = {})
  data, _status_code, _headers = get_retention_filter_with_http_info(app_id, rf_id, opts)
  data
end

#get_retention_filter_with_http_info(app_id, rf_id, opts = {}) ⇒ Array<(RumRetentionFilterResponse, Integer, Hash)>

Get a RUM retention filter.

Get a RUM retention filter for a RUM application.

Parameters:

  • app_id (String) —

    RUM application ID.

  • rf_id (String) —

    Retention filter ID.

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

    the optional parameters

Returns:

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

    RumRetentionFilterResponse data, response status code and response headers



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
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 260

def get_retention_filter_with_http_info(app_id, rf_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRetentionFiltersAPI.get_retention_filter ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RumRetentionFiltersAPI.get_retention_filter"
  end
  # verify the required parameter 'rf_id' is set
  if @api_client.config.client_side_validation && rf_id.nil?
    fail ArgumentError, "Missing the required parameter 'rf_id' when calling RumRetentionFiltersAPI.get_retention_filter"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')).sub('{rf_id}', CGI.escape(rf_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] || 'RumRetentionFilterResponse'

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

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

#list_permanent_retention_filters(app_id, opts = {}) ⇒ Object

Get all permanent RUM retention filters.

See Also:



317
318
319
320
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 317

def list_permanent_retention_filters(app_id, opts = {})
  data, _status_code, _headers = list_permanent_retention_filters_with_http_info(app_id, opts)
  data
end

#list_permanent_retention_filters_with_http_info(app_id, opts = {}) ⇒ Array<(RumPermanentRetentionFiltersResponse, Integer, Hash)>

Get all permanent RUM retention filters.

Get the list of permanent RUM retention filters for a RUM application. Permanent retention filters are predefined filters that cannot be created or deleted. For each filter, the editability block indicates which cross-product fields can be updated.

Parameters:

  • app_id (String) —

    RUM application ID.

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

    the optional parameters

Returns:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
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
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 331

def list_permanent_retention_filters_with_http_info(app_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRetentionFiltersAPI.list_permanent_retention_filters ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RumRetentionFiltersAPI.list_permanent_retention_filters"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/retention_filters/permanent'.sub('{app_id}', CGI.escape(app_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] || 'RumPermanentRetentionFiltersResponse'

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

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

#list_retention_filters(app_id, opts = {}) ⇒ Object

Get all RUM retention filters.

See Also:



384
385
386
387
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 384

def list_retention_filters(app_id, opts = {})
  data, _status_code, _headers = list_retention_filters_with_http_info(app_id, opts)
  data
end

#list_retention_filters_with_http_info(app_id, opts = {}) ⇒ Array<(RumRetentionFiltersResponse, Integer, Hash)>

Get all RUM retention filters.

Get the list of RUM retention filters for a RUM application.

Parameters:

  • app_id (String) —

    RUM application ID.

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

    the optional parameters

Returns:

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

    RumRetentionFiltersResponse data, response status code and response headers



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 396

def list_retention_filters_with_http_info(app_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRetentionFiltersAPI.list_retention_filters ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RumRetentionFiltersAPI.list_retention_filters"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/retention_filters'.sub('{app_id}', CGI.escape(app_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] || 'RumRetentionFiltersResponse'

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

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

#order_retention_filters(app_id, body, opts = {}) ⇒ Object

Order RUM retention filters.

See Also:



449
450
451
452
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 449

def order_retention_filters(app_id, body, opts = {})
  data, _status_code, _headers = order_retention_filters_with_http_info(app_id, body, opts)
  data
end

#order_retention_filters_with_http_info(app_id, body, opts = {}) ⇒ Array<(RumRetentionFiltersOrderResponse, Integer, Hash)>

Order RUM retention filters.

Order RUM retention filters for a RUM application. Returns RUM retention filter objects without attributes from the request body when the request is successful.

Parameters:

  • app_id (String) —

    RUM application ID.

  • body (RumRetentionFiltersOrderRequest) —

    New definition of the RUM retention filter.

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

    the optional parameters

Returns:



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 463

def order_retention_filters_with_http_info(app_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRetentionFiltersAPI.order_retention_filters ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RumRetentionFiltersAPI.order_retention_filters"
  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 RumRetentionFiltersAPI.order_retention_filters"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/relationships/retention_filters'.sub('{app_id}', CGI.escape(app_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] || 'RumRetentionFiltersOrderResponse'

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

  new_options = opts.merge(
    :operation => :order_retention_filters,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RumRetentionFiltersAPI#order_retention_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_permanent_retention_filter(app_id, permanent_rf_id, body, opts = {}) ⇒ Object

Update a permanent RUM retention filter.

See Also:



522
523
524
525
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 522

def update_permanent_retention_filter(app_id, permanent_rf_id, body, opts = {})
  data, _status_code, _headers = update_permanent_retention_filter_with_http_info(app_id, permanent_rf_id, body, opts)
  data
end

#update_permanent_retention_filter_with_http_info(app_id, permanent_rf_id, body, opts = {}) ⇒ Array<(RumPermanentRetentionFilterResponse, Integer, Hash)>

Update a permanent RUM retention filter.

Update the cross-product sampling configuration of a permanent RUM retention filter for a RUM application. Only fields marked as editable in the editability block of the filter can be updated. Updating a non-editable field returns a 400 response.

Parameters:

Returns:



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 538

def update_permanent_retention_filter_with_http_info(app_id, permanent_rf_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRetentionFiltersAPI.update_permanent_retention_filter ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RumRetentionFiltersAPI.update_permanent_retention_filter"
  end
  # verify the required parameter 'permanent_rf_id' is set
  if @api_client.config.client_side_validation && permanent_rf_id.nil?
    fail ArgumentError, "Missing the required parameter 'permanent_rf_id' when calling RumRetentionFiltersAPI.update_permanent_retention_filter"
  end
  # verify enum value
  allowable_values = ['rum_apm_flat_sampling', 'synthetics_sessions', 'forced_replay_sessions']
  if @api_client.config.client_side_validation && !allowable_values.include?(permanent_rf_id)
    fail ArgumentError, "invalid value for \"permanent_rf_id\", must be one of #{allowable_values}"
  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 RumRetentionFiltersAPI.update_permanent_retention_filter"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/retention_filters/permanent/{permanent_rf_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')).sub('{permanent_rf_id}', CGI.escape(permanent_rf_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] || 'RumPermanentRetentionFilterResponse'

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

  new_options = opts.merge(
    :operation => :update_permanent_retention_filter,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RumRetentionFiltersAPI#update_permanent_retention_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_retention_filter(app_id, rf_id, body, opts = {}) ⇒ Object

Update a RUM retention filter.

See Also:



606
607
608
609
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 606

def update_retention_filter(app_id, rf_id, body, opts = {})
  data, _status_code, _headers = update_retention_filter_with_http_info(app_id, rf_id, body, opts)
  data
end

#update_retention_filter_with_http_info(app_id, rf_id, body, opts = {}) ⇒ Array<(RumRetentionFilterResponse, Integer, Hash)>

Update a RUM retention filter.

Update a RUM retention filter for a RUM application. Returns RUM retention filter objects from the request body when the request is successful.

Parameters:

  • app_id (String) —

    RUM application ID.

  • rf_id (String) —

    Retention filter ID.

  • body (RumRetentionFilterUpdateRequest) —

    New definition of the RUM retention filter.

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

    the optional parameters

Returns:

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

    RumRetentionFilterResponse data, response status code and response headers



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/datadog_api_client/v2/api/rum_retention_filters_api.rb', line 621

def update_retention_filter_with_http_info(app_id, rf_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumRetentionFiltersAPI.update_retention_filter ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling RumRetentionFiltersAPI.update_retention_filter"
  end
  # verify the required parameter 'rf_id' is set
  if @api_client.config.client_side_validation && rf_id.nil?
    fail ArgumentError, "Missing the required parameter 'rf_id' when calling RumRetentionFiltersAPI.update_retention_filter"
  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 RumRetentionFiltersAPI.update_retention_filter"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/')).sub('{rf_id}', CGI.escape(rf_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] || 'RumRetentionFilterResponse'

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

  new_options = opts.merge(
    :operation => :update_retention_filter,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RumRetentionFiltersAPI#update_retention_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end