Class: DatadogAPIClient::V2::RUMAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RUMAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Aggregate RUM events.

See Also:



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

def aggregate_rum_events(body, opts = {})
  data, _status_code, _headers = aggregate_rum_events_with_http_info(body, opts)
  data
end

#aggregate_rum_events_with_http_info(body, opts = {}) ⇒ Array<(RUMAnalyticsAggregateResponse, Integer, Hash)>

Aggregate RUM events.

The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries.

Parameters:

Returns:



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

def aggregate_rum_events_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.aggregate_rum_events ...'
  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 RUMAPI.aggregate_rum_events"
  end
  # resource path
  local_var_path = '/api/v2/rum/analytics/aggregate'

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

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

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

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

Create a new RUM application.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 96

def create_rum_application(body, opts = {})
  data, _status_code, _headers = create_rum_application_with_http_info(body, opts)
  data
end

#create_rum_application_with_http_info(body, opts = {}) ⇒ Array<(RUMApplicationResponse, Integer, Hash)>

Create a new RUM application.

Create a new RUM application in your organization.

Parameters:

Returns:

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

    RUMApplicationResponse data, response status code and response headers



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 108

def create_rum_application_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.create_rum_application ...'
  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 RUMAPI.create_rum_application"
  end
  # resource path
  local_var_path = '/api/v2/rum/applications'

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

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

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

#delete_rum_application(id, opts = {}) ⇒ Object

Delete a RUM application.

See Also:



163
164
165
166
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 163

def delete_rum_application(id, opts = {})
  delete_rum_application_with_http_info(id, opts)
  nil
end

#delete_rum_application_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a RUM application.

Delete an existing RUM application in your organization.

Parameters:

  • id (String) —

    RUM application ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
218
219
220
221
222
223
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 175

def delete_rum_application_with_http_info(id, opts = {})

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

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

#delete_sourcemaps(mapkind, dry_run, opts = {}) ⇒ Object

Delete source maps.

See Also:



228
229
230
231
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 228

def delete_sourcemaps(mapkind, dry_run, opts = {})
  data, _status_code, _headers = delete_sourcemaps_with_http_info(mapkind, dry_run, opts)
  data
end

#delete_sourcemaps_with_http_info(mapkind, dry_run, opts = {}) ⇒ Array<(SourcemapsResponse, Integer, Hash)>

Delete source maps.

Deletes source maps matching the specified filter criteria. Supports dry-run mode to preview which source maps would be deleted without performing the actual deletion.

Parameters:

  • mapkind (SourcemapMapKind) —

    The type of source map. Valid values are js, jvm, ios, react, flutter, elf, ndk, il2cpp, wasm, portable_pdb.

  • dry_run (Boolean) —

    When set to true, returns the source maps that would be deleted without performing the actual deletion. When set to false, performs the deletion.

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

    the optional parameters

Options Hash (opts):

  • :filter_service (Array<String>) —

    Filter by service names (multiple values allowed). Required for js, jvm, react, and flutter map kinds.

  • :filter_version (Array<String>) —

    Filter by version values (multiple values allowed, maximum 10). Required for js, jvm, react, and flutter map kinds.

  • :filter_variant (Array<String>) —

    Filter by variant values (multiple values allowed). Supported for jvm.

  • :filter_id (Array<String>) —

    Filter by source map ID values (multiple values allowed). Supported for all map kinds.

  • :filter_build_id (Array<String>) —

    Filter by build ID values (multiple values allowed). Supported for jvm, ndk, il2cpp, wasm, and portable_pdb.

  • :filter_uuid (Array<String>) —

    Filter by UUID values (multiple values allowed). Supported for ios.

  • :filter_platform (Array<String>) —

    Filter by platform values (multiple values allowed). Supported for react.

  • :filter_build_number (Array<String>) —

    Filter by build number values (multiple values allowed). Supported for react.

  • :filter_bundle_name (Array<String>) —

    Filter by bundle name values (multiple values allowed). Supported for react.

  • :filter_arch (Array<String>) —

    Filter by architecture values (multiple values allowed). Supported for flutter, elf, and ndk.

  • :filter_symbol_source (Array<String>) —

    Filter by symbol source values (multiple values allowed). Supported for elf.

  • :filter_origin (Array<String>) —

    Filter by origin values (multiple values allowed). Supported for elf.

  • :filter_origin_version (Array<String>) —

    Filter by origin version values (multiple values allowed). Supported for elf.

  • :filter_filename (String) —

    Filter by filename (single value). Supported for js, elf, ndk, wasm, and portable_pdb.

  • :filter_debug_id (String) —

    Filter by debug ID (single value). Supported for react.

  • :filter_gnu_build_id (String) —

    Filter by GNU build ID (single value). Supported for elf.

  • :filter_go_build_id (String) —

    Filter by Go build ID (single value). Supported for elf.

  • :filter_file_hash (String) —

    Filter by file hash (single value). Supported for elf.

Returns:

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

    SourcemapsResponse data, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.delete_sourcemaps ...'
  end
  # verify the required parameter 'mapkind' is set
  if @api_client.config.client_side_validation && mapkind.nil?
    fail ArgumentError, "Missing the required parameter 'mapkind' when calling RUMAPI.delete_sourcemaps"
  end
  # verify enum value
  allowable_values = ['js', 'jvm', 'ios', 'react', 'flutter', 'elf', 'ndk', 'il2cpp', 'wasm', 'portable_pdb']
  if @api_client.config.client_side_validation && !allowable_values.include?(mapkind)
    fail ArgumentError, "invalid value for \"mapkind\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'dry_run' is set
  if @api_client.config.client_side_validation && dry_run.nil?
    fail ArgumentError, "Missing the required parameter 'dry_run' when calling RUMAPI.delete_sourcemaps"
  end
  # resource path
  local_var_path = '/api/v2/sourcemaps'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'mapkind'] = mapkind
  query_params[:'dry_run'] = dry_run
  query_params[:'filter[service]'] = @api_client.build_collection_param(opts[:'filter_service'], :multi) if !opts[:'filter_service'].nil?
  query_params[:'filter[version]'] = @api_client.build_collection_param(opts[:'filter_version'], :multi) if !opts[:'filter_version'].nil?
  query_params[:'filter[variant]'] = @api_client.build_collection_param(opts[:'filter_variant'], :multi) if !opts[:'filter_variant'].nil?
  query_params[:'filter[id]'] = @api_client.build_collection_param(opts[:'filter_id'], :multi) if !opts[:'filter_id'].nil?
  query_params[:'filter[build_id]'] = @api_client.build_collection_param(opts[:'filter_build_id'], :multi) if !opts[:'filter_build_id'].nil?
  query_params[:'filter[uuid]'] = @api_client.build_collection_param(opts[:'filter_uuid'], :multi) if !opts[:'filter_uuid'].nil?
  query_params[:'filter[platform]'] = @api_client.build_collection_param(opts[:'filter_platform'], :multi) if !opts[:'filter_platform'].nil?
  query_params[:'filter[build_number]'] = @api_client.build_collection_param(opts[:'filter_build_number'], :multi) if !opts[:'filter_build_number'].nil?
  query_params[:'filter[bundle_name]'] = @api_client.build_collection_param(opts[:'filter_bundle_name'], :multi) if !opts[:'filter_bundle_name'].nil?
  query_params[:'filter[arch]'] = @api_client.build_collection_param(opts[:'filter_arch'], :multi) if !opts[:'filter_arch'].nil?
  query_params[:'filter[symbol_source]'] = @api_client.build_collection_param(opts[:'filter_symbol_source'], :multi) if !opts[:'filter_symbol_source'].nil?
  query_params[:'filter[origin]'] = @api_client.build_collection_param(opts[:'filter_origin'], :multi) if !opts[:'filter_origin'].nil?
  query_params[:'filter[origin_version]'] = @api_client.build_collection_param(opts[:'filter_origin_version'], :multi) if !opts[:'filter_origin_version'].nil?
  query_params[:'filter[filename]'] = opts[:'filter_filename'] if !opts[:'filter_filename'].nil?
  query_params[:'filter[debug_id]'] = opts[:'filter_debug_id'] if !opts[:'filter_debug_id'].nil?
  query_params[:'filter[gnu_build_id]'] = opts[:'filter_gnu_build_id'] if !opts[:'filter_gnu_build_id'].nil?
  query_params[:'filter[go_build_id]'] = opts[:'filter_go_build_id'] if !opts[:'filter_go_build_id'].nil?
  query_params[:'filter[file_hash]'] = opts[:'filter_file_hash'] if !opts[:'filter_file_hash'].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] || 'SourcemapsResponse'

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

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

#get_rum_application(id, opts = {}) ⇒ Object

Get a RUM application.

See Also:



350
351
352
353
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 350

def get_rum_application(id, opts = {})
  data, _status_code, _headers = get_rum_application_with_http_info(id, opts)
  data
end

#get_rum_application_with_http_info(id, opts = {}) ⇒ Array<(RUMApplicationResponse, Integer, Hash)>

Get a RUM application.

Get the RUM application with given ID in your organization.

Parameters:

  • id (String) —

    RUM application ID.

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

    the optional parameters

Returns:

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

    RUMApplicationResponse data, response status code and response headers



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/rum_api.rb', line 362

def get_rum_application_with_http_info(id, opts = {})

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

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

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

#get_rum_applications(opts = {}) ⇒ Object

List all the RUM applications.

See Also:



415
416
417
418
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 415

def get_rum_applications(opts = {})
  data, _status_code, _headers = get_rum_applications_with_http_info(opts)
  data
end

#get_rum_applications_with_http_info(opts = {}) ⇒ Array<(RUMApplicationsResponse, Integer, Hash)>

List all the RUM applications.

List all the RUM applications in your organization.

Parameters:

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

    the optional parameters

Returns:

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

    RUMApplicationsResponse data, response status code and response headers



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 426

def get_rum_applications_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.get_rum_applications ...'
  end
  # resource path
  local_var_path = '/api/v2/rum/applications'

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

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

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

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

Get service repository information.

See Also:



475
476
477
478
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 475

def get_service_repository_info(body, opts = {})
  data, _status_code, _headers = get_service_repository_info_with_http_info(body, opts)
  data
end

#get_service_repository_info_with_http_info(body, opts = {}) ⇒ Array<(ServiceRepositoryInfoResponse, Integer, Hash)>

Get service repository information.

Returns the repository URL and commit SHA associated with a given service and version.

Parameters:

Returns:



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
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 487

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.get_service_repository_info ...'
  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 RUMAPI.get_service_repository_info"
  end
  # resource path
  local_var_path = '/api/v2/sourcemaps/service_repository_info'

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

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

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

#get_sourcemaps(opts = {}) ⇒ Object

Get a JavaScript source map.

See Also:



548
549
550
551
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 548

def get_sourcemaps(opts = {})
  data, _status_code, _headers = get_sourcemaps_with_http_info(opts)
  data
end

#get_sourcemaps_with_http_info(opts = {}) ⇒ Array<(SourcemapFileResponse, Integer, Hash)>

Get a JavaScript source map.

Retrieves the content of a specific JavaScript source map file. Provide either debug_id with a UUID, or all three of filename, service, and version. When debug_id is provided, filename, service, and version are not required and are ignored.

Examples: the following commands use the US1 API host. Replace the host with the API host for your site, and the filename, service, version, and debug ID with values from your organization. Use --get so curl sends the parameters in the query string.

1. Retrieve a source map by debug ID

Provide debug_id with a UUID. No filename, service, or version is required.

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "debug_id=00000000-0000-4000-8000-000000000001"

2. Retrieve a source map by service and version

Provide filename together with service and version.

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "filename=js/bundle.min.js.map" \
  --data-urlencode "service=my-web-service" \
  --data-urlencode "version=1.0.0"

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :debug_id (UUID) —

    The debug ID of the JavaScript source map, in UUID format. When provided, filename, service, and version are not required and are ignored.

  • :filename (String) —

    The path to the source map file. Required when debug_id is omitted.

  • :service (String) —

    The service name associated with the source map. Required when debug_id is omitted.

  • :version (String) —

    The version of the service associated with the source map. Required when debug_id is omitted.

Returns:

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

    SourcemapFileResponse data, response status code and response headers



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
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
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 595

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.get_sourcemaps ...'
  end
  # resource path
  local_var_path = '/api/v2/sourcemaps'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'debug_id'] = opts[:'debug_id'] if !opts[:'debug_id'].nil?
  query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
  query_params[:'service'] = opts[:'service'] if !opts[:'service'].nil?
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].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] || 'SourcemapFileResponse'

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

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

#list_rum_events(opts = {}) ⇒ Object

Get a list of RUM events.

See Also:



654
655
656
657
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 654

def list_rum_events(opts = {})
  data, _status_code, _headers = list_rum_events_with_http_info(opts)
  data
end

#list_rum_events_with_http_info(opts = {}) ⇒ Array<(RUMEventsResponse, Integer, Hash)>

Get a list of RUM events.

List endpoint returns events that match a RUM search query. Results are paginated.

Use this endpoint to see your latest RUM events.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_query (String) —

    Search query following RUM syntax.

  • :filter_from (Time) —

    Minimum timestamp for requested events.

  • :filter_to (Time) —

    Maximum timestamp for requested events.

  • :sort (RUMSort) —

    Order of events in results.

  • :page_cursor (String) —

    List following results with a cursor provided in the previous query.

  • :page_limit (Integer) —

    Maximum number of events in the response.

Returns:

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

    RUMEventsResponse data, response status code and response headers



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 676

def list_rum_events_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.list_rum_events ...'
  end
  allowable_values = ['timestamp', '-timestamp']
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling RUMAPI.list_rum_events, must be smaller than or equal to 1000.'
  end
  # resource path
  local_var_path = '/api/v2/rum/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil?
  query_params[:'filter[from]'] = opts[:'filter_from'] if !opts[:'filter_from'].nil?
  query_params[:'filter[to]'] = opts[:'filter_to'] if !opts[:'filter_to'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].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] || 'RUMEventsResponse'

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

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

#list_rum_events_with_pagination(opts = {}) {|RUMEvent| ... } ⇒ Object

Get a list of RUM events.

Provide a paginated version of #list_rum_events, returning all items.

To use it you need to use a block: list_rum_events_with_pagination { |item| p item }

Yields:



742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 742

def list_rum_events_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_limit", 10)
    @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size)
    while true do
        response = list_rum_events(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length == 0
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_cursor", String, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end

#list_sourcemaps(opts = {}) ⇒ Object

List source maps.

See Also:



759
760
761
762
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 759

def list_sourcemaps(opts = {})
  data, _status_code, _headers = list_sourcemaps_with_http_info(opts)
  data
end

#list_sourcemaps_with_http_info(opts = {}) ⇒ Array<(ListSourcemapsResponse, Integer, Hash)>

List source maps.

Retrieves a paginated list of source maps. Send filters as query parameters, not in a JSON request body. mapkind defaults to js.

For JavaScript source maps, choose one of the three request shapes below.

Examples: the following commands use the US1 API host. Replace the host with the API host for your site, and the service, version, debug ID, and cursor with values from your organization. Use --get so curl sends the filters in the query string; -X GET with --data-urlencode sends them in the request body instead.

1. List by service and version

Provide both filter[service] and filter[version] to search source maps indexed by service and version. Omit search_by.

Pagination: prefer cursor pagination. Omit page[after] and page[number] on the first request. To get the next page, pass meta.page.next_cursor as page[after], keeping the same filters. Continue until meta.page.has_more_results is false. Do not decode or modify the cursor. Legacy page-number pagination is also supported, starting at page[number]=1.

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "mapkind=js" \
  --data-urlencode "filter[service]=my-web-service" \
  --data-urlencode "filter[version]=1.0.0" \
  --data-urlencode "page[size]=10"

2. Find a specific JavaScript debug ID

Provide filter[debug_id] with a UUID. Service and version filters are not required. Omit search_by.

Pagination: the lookup returns at most one result, so no pagination is needed. page[after] is not supported.

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "mapkind=js" \
  --data-urlencode "filter[debug_id]=00000000-0000-4000-8000-000000000001"

3. Browse source maps indexed by debug ID

Set search_by=debug_id without specifying a debug ID. Do not send service, version, or filename filters in this mode.

Pagination: this mode requires cursor pagination; page[number] is not supported. Omit page[after] on the first request. To get the next page, pass meta.page.next_cursor as page[after], keeping the same search mode and filters. Continue until meta.page.has_more_results is false. Do not decode or modify the cursor.

First page:

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "mapkind=js" \
  --data-urlencode "search_by=debug_id" \
  --data-urlencode "page[size]=10"

Next page:

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "mapkind=js" \
  --data-urlencode "search_by=debug_id" \
  --data-urlencode "page[size]=10" \
  --data-urlencode "page[after]=<meta.page.next_cursor>"

For other map kinds, use page[number], starting at 1.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_by (SourcemapSearchBy) —

    Set to debug_id to browse JavaScript source maps indexed by debug ID. Only supported for mapkind=js. Omit for service/version searches or a specific filter[debug_id] lookup. In debug-ID browse mode, service, version, and filename filters are not supported.

  • :mapkind (SourcemapMapKind) —

    The type of source map. Defaults to js.

  • :page_after (String) —

    Cursor for the next page of a JavaScript listing. Use the value from meta.page.next_cursor and keep the same search mode and filters. Omit on the first request. Not supported for other map kinds or for a specific filter[debug_id] lookup without search_by=debug_id.

  • :page_size (Integer) —

    The number of results per page. Defaults to 100. Must be at least 1; values above 1000 are capped at 1000.

  • :page_number (Integer) —

    Legacy page number, starting from 1. Prefer page[after] for JavaScript listings. Not supported with search_by=debug_id. Other map kinds default to page 1 when pagination parameters are omitted.

  • :filter_service (Array<String>) —

    Filter by service names (multiple values allowed). Required for jvm, react, and flutter map kinds. Also required for js unless searching by filter[debug_id] or browsing with search_by=debug_id.

  • :filter_version (Array<String>) —

    Filter by version values (multiple values allowed). Required for jvm, react, and flutter map kinds. Also required for js unless searching by filter[debug_id] or browsing with search_by=debug_id.

  • :filter_variant (Array<String>) —

    Filter by variant values (multiple values allowed). Supported for jvm.

  • :filter_id (Array<String>) —

    Filter by source map ID values (multiple values allowed). Supported for all map kinds.

  • :filter_build_id (Array<String>) —

    Filter by build ID values (multiple values allowed). Supported for jvm, ndk, il2cpp, wasm, and portable_pdb.

  • :filter_uuid (Array<String>) —

    Filter by UUID values (multiple values allowed). Supported for ios.

  • :filter_platform (Array<String>) —

    Filter by platform values (multiple values allowed). Supported for react.

  • :filter_build_number (Array<String>) —

    Filter by build number values (multiple values allowed). Supported for react.

  • :filter_bundle_name (Array<String>) —

    Filter by bundle name values (multiple values allowed). Supported for react.

  • :filter_arch (Array<String>) —

    Filter by architecture values (multiple values allowed). Supported for flutter, elf, and ndk.

  • :filter_symbol_source (Array<String>) —

    Filter by symbol source values (multiple values allowed). Supported for elf.

  • :filter_origin (Array<String>) —

    Filter by origin values (multiple values allowed). Supported for elf.

  • :filter_origin_version (Array<String>) —

    Filter by origin version values (multiple values allowed). Supported for elf.

  • :filter_filename (String) —

    Filter by filename (single value). Supported for js, elf, ndk, wasm, and portable_pdb.

  • :filter_debug_id (UUID) —

    Filter by a single debug ID in UUID format. Supported for js and react. For js, the lookup returns at most one result and does not require service/version filters. For react, service/version filters remain required.

  • :filter_gnu_build_id (String) —

    Filter by GNU build ID (single value). Supported for elf.

  • :filter_go_build_id (String) —

    Filter by Go build ID (single value). Supported for elf.

  • :filter_file_hash (String) —

    Filter by file hash (single value). Supported for elf.

Returns:

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

    ListSourcemapsResponse data, response status code and response headers



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 874

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.list_sourcemaps ...'
  end
  allowable_values = ['debug_id']
  if @api_client.config.client_side_validation && opts[:'search_by'] && !allowable_values.include?(opts[:'search_by'])
    fail ArgumentError, "invalid value for \"search_by\", must be one of #{allowable_values}"
  end
  allowable_values = ['js', 'jvm', 'ios', 'react', 'flutter', 'elf', 'ndk', 'il2cpp', 'wasm', 'portable_pdb']
  if @api_client.config.client_side_validation && opts[:'mapkind'] && !allowable_values.include?(opts[:'mapkind'])
    fail ArgumentError, "invalid value for \"mapkind\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling RUMAPI.list_sourcemaps, must be greater than or equal to 1.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_number'].nil? && opts[:'page_number'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_number"]" when calling RUMAPI.list_sourcemaps, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/v2/sourcemaps/list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'search_by'] = opts[:'search_by'] if !opts[:'search_by'].nil?
  query_params[:'mapkind'] = opts[:'mapkind'] if !opts[:'mapkind'].nil?
  query_params[:'page[after]'] = opts[:'page_after'] if !opts[:'page_after'].nil?
  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[service]'] = @api_client.build_collection_param(opts[:'filter_service'], :multi) if !opts[:'filter_service'].nil?
  query_params[:'filter[version]'] = @api_client.build_collection_param(opts[:'filter_version'], :multi) if !opts[:'filter_version'].nil?
  query_params[:'filter[variant]'] = @api_client.build_collection_param(opts[:'filter_variant'], :multi) if !opts[:'filter_variant'].nil?
  query_params[:'filter[id]'] = @api_client.build_collection_param(opts[:'filter_id'], :multi) if !opts[:'filter_id'].nil?
  query_params[:'filter[build_id]'] = @api_client.build_collection_param(opts[:'filter_build_id'], :multi) if !opts[:'filter_build_id'].nil?
  query_params[:'filter[uuid]'] = @api_client.build_collection_param(opts[:'filter_uuid'], :multi) if !opts[:'filter_uuid'].nil?
  query_params[:'filter[platform]'] = @api_client.build_collection_param(opts[:'filter_platform'], :multi) if !opts[:'filter_platform'].nil?
  query_params[:'filter[build_number]'] = @api_client.build_collection_param(opts[:'filter_build_number'], :multi) if !opts[:'filter_build_number'].nil?
  query_params[:'filter[bundle_name]'] = @api_client.build_collection_param(opts[:'filter_bundle_name'], :multi) if !opts[:'filter_bundle_name'].nil?
  query_params[:'filter[arch]'] = @api_client.build_collection_param(opts[:'filter_arch'], :multi) if !opts[:'filter_arch'].nil?
  query_params[:'filter[symbol_source]'] = @api_client.build_collection_param(opts[:'filter_symbol_source'], :multi) if !opts[:'filter_symbol_source'].nil?
  query_params[:'filter[origin]'] = @api_client.build_collection_param(opts[:'filter_origin'], :multi) if !opts[:'filter_origin'].nil?
  query_params[:'filter[origin_version]'] = @api_client.build_collection_param(opts[:'filter_origin_version'], :multi) if !opts[:'filter_origin_version'].nil?
  query_params[:'filter[filename]'] = opts[:'filter_filename'] if !opts[:'filter_filename'].nil?
  query_params[:'filter[debug_id]'] = opts[:'filter_debug_id'] if !opts[:'filter_debug_id'].nil?
  query_params[:'filter[gnu_build_id]'] = opts[:'filter_gnu_build_id'] if !opts[:'filter_gnu_build_id'].nil?
  query_params[:'filter[go_build_id]'] = opts[:'filter_go_build_id'] if !opts[:'filter_go_build_id'].nil?
  query_params[:'filter[file_hash]'] = opts[:'filter_file_hash'] if !opts[:'filter_file_hash'].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] || 'ListSourcemapsResponse'

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

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

#restore_sourcemaps(mapkind, dry_run, opts = {}) ⇒ Object

Restore source maps.

See Also:



967
968
969
970
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 967

def restore_sourcemaps(mapkind, dry_run, opts = {})
  data, _status_code, _headers = restore_sourcemaps_with_http_info(mapkind, dry_run, opts)
  data
end

#restore_sourcemaps_with_http_info(mapkind, dry_run, opts = {}) ⇒ Array<(SourcemapsResponse, Integer, Hash)>

Restore source maps.

Restores previously deleted source maps matching the specified filter criteria. Supports dry-run mode to preview which source maps would be restored without performing the actual restoration.

Parameters:

  • mapkind (SourcemapMapKind) —

    The type of source map. Valid values are js, jvm, ios, react, flutter, elf, ndk, il2cpp, wasm, portable_pdb.

  • dry_run (Boolean) —

    When set to true, returns the source maps that would be restored without performing the actual restoration. When set to false, performs the restoration.

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

    the optional parameters

Options Hash (opts):

  • :filter_service (Array<String>) —

    Filter by service names (multiple values allowed). Required for js, jvm, react, and flutter map kinds.

  • :filter_version (Array<String>) —

    Filter by version values (multiple values allowed, maximum 10). Required for js, jvm, react, and flutter map kinds.

  • :filter_variant (Array<String>) —

    Filter by variant values (multiple values allowed). Supported for jvm.

  • :filter_id (Array<String>) —

    Filter by source map ID values (multiple values allowed). Supported for all map kinds.

  • :filter_build_id (Array<String>) —

    Filter by build ID values (multiple values allowed). Supported for jvm, ndk, il2cpp, wasm, and portable_pdb.

  • :filter_uuid (Array<String>) —

    Filter by UUID values (multiple values allowed). Supported for ios.

  • :filter_platform (Array<String>) —

    Filter by platform values (multiple values allowed). Supported for react.

  • :filter_build_number (Array<String>) —

    Filter by build number values (multiple values allowed). Supported for react.

  • :filter_bundle_name (Array<String>) —

    Filter by bundle name values (multiple values allowed). Supported for react.

  • :filter_arch (Array<String>) —

    Filter by architecture values (multiple values allowed). Supported for flutter, elf, and ndk.

  • :filter_symbol_source (Array<String>) —

    Filter by symbol source values (multiple values allowed). Supported for elf.

  • :filter_origin (Array<String>) —

    Filter by origin values (multiple values allowed). Supported for elf.

  • :filter_origin_version (Array<String>) —

    Filter by origin version values (multiple values allowed). Supported for elf.

  • :filter_filename (String) —

    Filter by filename (single value). Supported for js, elf, ndk, wasm, and portable_pdb.

  • :filter_debug_id (String) —

    Filter by debug ID (single value). Supported for react.

  • :filter_gnu_build_id (String) —

    Filter by GNU build ID (single value). Supported for elf.

  • :filter_go_build_id (String) —

    Filter by Go build ID (single value). Supported for elf.

  • :filter_file_hash (String) —

    Filter by file hash (single value). Supported for elf.

Returns:

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

    SourcemapsResponse data, response status code and response headers



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 1000

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.restore_sourcemaps ...'
  end
  # verify the required parameter 'mapkind' is set
  if @api_client.config.client_side_validation && mapkind.nil?
    fail ArgumentError, "Missing the required parameter 'mapkind' when calling RUMAPI.restore_sourcemaps"
  end
  # verify enum value
  allowable_values = ['js', 'jvm', 'ios', 'react', 'flutter', 'elf', 'ndk', 'il2cpp', 'wasm', 'portable_pdb']
  if @api_client.config.client_side_validation && !allowable_values.include?(mapkind)
    fail ArgumentError, "invalid value for \"mapkind\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'dry_run' is set
  if @api_client.config.client_side_validation && dry_run.nil?
    fail ArgumentError, "Missing the required parameter 'dry_run' when calling RUMAPI.restore_sourcemaps"
  end
  # resource path
  local_var_path = '/api/v2/sourcemaps/restore'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'mapkind'] = mapkind
  query_params[:'dry_run'] = dry_run
  query_params[:'filter[service]'] = @api_client.build_collection_param(opts[:'filter_service'], :multi) if !opts[:'filter_service'].nil?
  query_params[:'filter[version]'] = @api_client.build_collection_param(opts[:'filter_version'], :multi) if !opts[:'filter_version'].nil?
  query_params[:'filter[variant]'] = @api_client.build_collection_param(opts[:'filter_variant'], :multi) if !opts[:'filter_variant'].nil?
  query_params[:'filter[id]'] = @api_client.build_collection_param(opts[:'filter_id'], :multi) if !opts[:'filter_id'].nil?
  query_params[:'filter[build_id]'] = @api_client.build_collection_param(opts[:'filter_build_id'], :multi) if !opts[:'filter_build_id'].nil?
  query_params[:'filter[uuid]'] = @api_client.build_collection_param(opts[:'filter_uuid'], :multi) if !opts[:'filter_uuid'].nil?
  query_params[:'filter[platform]'] = @api_client.build_collection_param(opts[:'filter_platform'], :multi) if !opts[:'filter_platform'].nil?
  query_params[:'filter[build_number]'] = @api_client.build_collection_param(opts[:'filter_build_number'], :multi) if !opts[:'filter_build_number'].nil?
  query_params[:'filter[bundle_name]'] = @api_client.build_collection_param(opts[:'filter_bundle_name'], :multi) if !opts[:'filter_bundle_name'].nil?
  query_params[:'filter[arch]'] = @api_client.build_collection_param(opts[:'filter_arch'], :multi) if !opts[:'filter_arch'].nil?
  query_params[:'filter[symbol_source]'] = @api_client.build_collection_param(opts[:'filter_symbol_source'], :multi) if !opts[:'filter_symbol_source'].nil?
  query_params[:'filter[origin]'] = @api_client.build_collection_param(opts[:'filter_origin'], :multi) if !opts[:'filter_origin'].nil?
  query_params[:'filter[origin_version]'] = @api_client.build_collection_param(opts[:'filter_origin_version'], :multi) if !opts[:'filter_origin_version'].nil?
  query_params[:'filter[filename]'] = opts[:'filter_filename'] if !opts[:'filter_filename'].nil?
  query_params[:'filter[debug_id]'] = opts[:'filter_debug_id'] if !opts[:'filter_debug_id'].nil?
  query_params[:'filter[gnu_build_id]'] = opts[:'filter_gnu_build_id'] if !opts[:'filter_gnu_build_id'].nil?
  query_params[:'filter[go_build_id]'] = opts[:'filter_go_build_id'] if !opts[:'filter_go_build_id'].nil?
  query_params[:'filter[file_hash]'] = opts[:'filter_file_hash'] if !opts[:'filter_file_hash'].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] || 'SourcemapsResponse'

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

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

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

Search RUM events.

See Also:



1089
1090
1091
1092
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 1089

def search_rum_events(body, opts = {})
  data, _status_code, _headers = search_rum_events_with_http_info(body, opts)
  data
end

#search_rum_events_with_http_info(body, opts = {}) ⇒ Array<(RUMEventsResponse, Integer, Hash)>

Search RUM events.

List endpoint returns RUM events that match a RUM search query. Results are paginated.

Use this endpoint to build complex RUM events filtering and search.

Parameters:

Returns:

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

    RUMEventsResponse data, response status code and response headers



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 1106

def search_rum_events_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMAPI.search_rum_events ...'
  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 RUMAPI.search_rum_events"
  end
  # resource path
  local_var_path = '/api/v2/rum/events/search'

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

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

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

#search_rum_events_with_pagination(body, opts = {}) {|RUMEvent| ... } ⇒ Object

Search RUM events.

Provide a paginated version of #search_rum_events, returning all items.

To use it you need to use a block: search_rum_events_with_pagination { |item| p item }

Yields:



1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 1165

def search_rum_events_with_pagination(body, opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(body, "page.limit", 10)
    @api_client.set_attribute_from_path(api_version, body, "page.limit", RUMQueryPageOptions, page_size)
    while true do
        response = search_rum_events(body, opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length == 0
          break
        end
        @api_client.set_attribute_from_path(api_version, body, "page.cursor", RUMQueryPageOptions, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end

#update_rum_application(id, body, opts = {}) ⇒ Object

Update a RUM application.

See Also:



1182
1183
1184
1185
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 1182

def update_rum_application(id, body, opts = {})
  data, _status_code, _headers = update_rum_application_with_http_info(id, body, opts)
  data
end

#update_rum_application_with_http_info(id, body, opts = {}) ⇒ Array<(RUMApplicationResponse, Integer, Hash)>

Update a RUM application.

Update the RUM application with given ID in your organization.

Parameters:

Returns:

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

    RUMApplicationResponse data, response status code and response headers



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/datadog_api_client/v2/api/rum_api.rb', line 1195

def update_rum_application_with_http_info(id, body, opts = {})

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

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

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