Class: DatadogAPIClient::V2::RUMOperationsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RUMOperationsAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create a RUM operation.

See Also:



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

def create_rum_operation(body, opts = {})
  data, _status_code, _headers = create_rum_operation_with_http_info(body, opts)
  data
end

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

Create a RUM operation strong link.

See Also:



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

def create_rum_operation_strong_link(body, opts = {})
  data, _status_code, _headers = create_rum_operation_strong_link_with_http_info(body, opts)
  data
end

#create_rum_operation_strong_link_with_http_info(body, opts = {}) ⇒ Array<(RUMOperationStrongLinkResponse, Integer, Hash)>

Create a RUM operation strong link.

Create a strong link between a RUM operation and a feature, confirming that the feature belongs to the operation. The operation can be identified by operation_id or operation_name; if operation_name does not match an existing operation, a stub operation is created.

Parameters:

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 116

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

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

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

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

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

#create_rum_operation_with_http_info(body, opts = {}) ⇒ Array<(RUMOperationResponse, Integer, Hash)>

Create a RUM operation.

Create a new RUM operation, defining the journey used to detect it from RUM events.

Parameters:

Returns:

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

    RUMOperationResponse data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 41

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

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

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

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

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

#delete_rum_operation(rum_operation_id, opts = {}) ⇒ Object

Delete a RUM operation.

See Also:



177
178
179
180
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 177

def delete_rum_operation(rum_operation_id, opts = {})
  delete_rum_operation_with_http_info(rum_operation_id, opts)
  nil
end

#delete_rum_operation_strong_link(rum_operation_id, feature_id, opts = {}) ⇒ Object

Delete a RUM operation strong link.

See Also:



248
249
250
251
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 248

def delete_rum_operation_strong_link(rum_operation_id, feature_id, opts = {})
  delete_rum_operation_strong_link_with_http_info(rum_operation_id, feature_id, opts)
  nil
end

#delete_rum_operation_strong_link_with_http_info(rum_operation_id, feature_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a RUM operation strong link.

Delete the strong link between a RUM operation and a feature.

Parameters:

  • rum_operation_id (String) —

    The unique identifier of the RUM operation.

  • feature_id (String) —

    The unique identifier of the feature.

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

    the optional parameters

Returns:

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

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

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

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

#delete_rum_operation_with_http_info(rum_operation_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a RUM operation.

Delete a RUM operation.

Parameters:

  • rum_operation_id (String) —

    The unique identifier of the RUM operation to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMOperationsAPI.delete_rum_operation ...'
  end
  # verify the required parameter 'rum_operation_id' is set
  if @api_client.config.client_side_validation && rum_operation_id.nil?
    fail ArgumentError, "Missing the required parameter 'rum_operation_id' when calling RUMOperationsAPI.delete_rum_operation"
  end
  # resource path
  local_var_path = '/api/v2/rum/operations/{rum_operation_id}'.sub('{rum_operation_id}', CGI.escape(rum_operation_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_rum_operation,
    :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: RUMOperationsAPI#delete_rum_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rum_operation(rum_operation_id, opts = {}) ⇒ Object

Get a RUM operation.

See Also:



324
325
326
327
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 324

def get_rum_operation(rum_operation_id, opts = {})
  data, _status_code, _headers = get_rum_operation_with_http_info(rum_operation_id, opts)
  data
end

#get_rum_operation_by_name(name, opts = {}) ⇒ Object

Get a RUM operation by name.

See Also:



395
396
397
398
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 395

def get_rum_operation_by_name(name, opts = {})
  data, _status_code, _headers = get_rum_operation_by_name_with_http_info(name, opts)
  data
end

#get_rum_operation_by_name_with_http_info(name, opts = {}) ⇒ Array<(RUMOperationResponse, Integer, Hash)>

Get a RUM operation by name.

Retrieve a specific RUM operation by its unique name.

Parameters:

  • name (String) —

    The unique name of the RUM operation.

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

    the optional parameters

Returns:

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

    RUMOperationResponse data, response status code and response headers



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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 407

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

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

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

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

#get_rum_operation_with_http_info(rum_operation_id, opts = {}) ⇒ Array<(RUMOperationResponse, Integer, Hash)>

Get a RUM operation.

Retrieve a specific RUM operation by its unique identifier.

Parameters:

  • rum_operation_id (String) —

    The unique identifier of the RUM operation.

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

    the optional parameters

Returns:

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

    RUMOperationResponse data, response status code and response headers



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
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 336

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

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

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

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

#list_rum_operation_strong_links(opts = {}) ⇒ Object

List RUM operation strong links.

See Also:



555
556
557
558
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 555

def list_rum_operation_strong_links(opts = {})
  data, _status_code, _headers = list_rum_operation_strong_links_with_http_info(opts)
  data
end

#list_rum_operation_strong_links_with_http_info(opts = {}) ⇒ Array<(RUMOperationStrongLinksListResponse, Integer, Hash)>

List RUM operation strong links.

List strong links between RUM operations and features. A strong link confirms that a feature belongs to an operation. Provide operation_id, feature_id, or both to filter results; at least one is required.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :operation_id (String) —

    Filter strong links by RUM operation ID.

  • :feature_id (String) —

    Filter strong links by feature ID.

  • :page_offset (Integer) —

    Offset for pagination.

  • :page_limit (Integer) —

    Number of items per page. Maximum of 200.

Returns:



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

def list_rum_operation_strong_links_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMOperationsAPI.list_rum_operation_strong_links ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_offset'].nil? && opts[:'page_offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page_offset"]" when calling RUMOperationsAPI.list_rum_operation_strong_links, must be greater than or equal to 0.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 200
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling RUMOperationsAPI.list_rum_operation_strong_links, must be smaller than or equal to 200.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling RUMOperationsAPI.list_rum_operation_strong_links, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/v2/rum/operations/strong_links'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'operation_id'] = opts[:'operation_id'] if !opts[:'operation_id'].nil?
  query_params[:'feature_id'] = opts[:'feature_id'] if !opts[:'feature_id'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].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] || 'RUMOperationStrongLinksListResponse'

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

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

#list_rum_operations(opts = {}) ⇒ Object

Search RUM operations.

See Also:



466
467
468
469
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 466

def list_rum_operations(opts = {})
  data, _status_code, _headers = list_rum_operations_with_http_info(opts)
  data
end

#list_rum_operations_with_http_info(opts = {}) ⇒ Array<(RUMOperationsListResponse, Integer, Hash)>

Search RUM operations.

Search RUM operations for your organization. Supports filtering by query, creator, team, feature, and application.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :query (String) —

    A search query to filter operations by name.

  • :page_offset (Integer) —

    Offset for pagination.

  • :page_limit (Integer) —

    Number of items per page. Maximum of 100.

  • :creator (String) —

    Filter operations by the email of their creator.

  • :team (String) —

    Filter operations by team. Accepts a comma-separated list of teams.

  • :feature_id (String) —

    Filter operations by feature ID. Accepts a comma-separated list of feature IDs.

  • :application_id (UUID) —

    Filter operations by RUM application ID.

Returns:

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

    RUMOperationsListResponse data, response status code and response headers



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
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
544
545
546
547
548
549
550
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 484

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMOperationsAPI.list_rum_operations ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_offset'].nil? && opts[:'page_offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page_offset"]" when calling RUMOperationsAPI.list_rum_operations, must be greater than or equal to 0.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling RUMOperationsAPI.list_rum_operations, must be smaller than or equal to 100.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling RUMOperationsAPI.list_rum_operations, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/v2/rum/operations/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'creator'] = opts[:'creator'] if !opts[:'creator'].nil?
  query_params[:'team'] = opts[:'team'] if !opts[:'team'].nil?
  query_params[:'feature_id'] = opts[:'feature_id'] if !opts[:'feature_id'].nil?
  query_params[:'application_id'] = opts[:'application_id'] if !opts[:'application_id'].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] || 'RUMOperationsListResponse'

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

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

#update_rum_operation(rum_operation_id, body, opts = {}) ⇒ Object

Update a RUM operation.

See Also:



634
635
636
637
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 634

def update_rum_operation(rum_operation_id, body, opts = {})
  data, _status_code, _headers = update_rum_operation_with_http_info(rum_operation_id, body, opts)
  data
end

#update_rum_operation_strong_link(rum_operation_id, feature_id, body, opts = {}) ⇒ Object

Update a RUM operation strong link.

See Also:



713
714
715
716
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 713

def update_rum_operation_strong_link(rum_operation_id, feature_id, body, opts = {})
  data, _status_code, _headers = update_rum_operation_strong_link_with_http_info(rum_operation_id, feature_id, body, opts)
  data
end

#update_rum_operation_strong_link_with_http_info(rum_operation_id, feature_id, body, opts = {}) ⇒ Array<(RUMOperationStrongLinkResponse, Integer, Hash)>

Update a RUM operation strong link.

Update the status of a strong link between a RUM operation and a feature.

Parameters:

  • rum_operation_id (String) —

    The unique identifier of the RUM operation.

  • feature_id (String) —

    The unique identifier of the feature.

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

    the optional parameters

Returns:



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
 
# File 'lib/datadog_api_client/v2/api/rum_operations_api.rb', line 727

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RUMOperationsAPI.update_rum_operation_strong_link ...'
  end
  # verify the required parameter 'rum_operation_id' is set
  if @api_client.config.client_side_validation && rum_operation_id.nil?
    fail ArgumentError, "Missing the required parameter 'rum_operation_id' when calling RUMOperationsAPI.update_rum_operation_strong_link"
  end
  # verify the required parameter 'feature_id' is set
  if @api_client.config.client_side_validation && feature_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_id' when calling RUMOperationsAPI.update_rum_operation_strong_link"
  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 RUMOperationsAPI.update_rum_operation_strong_link"
  end
  # resource path
  local_var_path = '/api/v2/rum/operations/strong_links/{rum_operation_id}/{feature_id}'.sub('{rum_operation_id}', CGI.escape(rum_operation_id.to_s).gsub('%2F', '/')).sub('{feature_id}', CGI.escape(feature_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] || 'RUMOperationStrongLinkResponse'

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

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

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

#update_rum_operation_with_http_info(rum_operation_id, body, opts = {}) ⇒ Array<(RUMOperationResponse, Integer, Hash)>

Update a RUM operation.

Update an existing RUM operation. Fields omitted from the request body keep their existing value, with the exception of journey_rum, which is required and fully replaced on every update.

Parameters:

  • rum_operation_id (String) —

    The unique identifier of the RUM operation to update.

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

    the optional parameters

Returns:

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

    RUMOperationResponse data, response status code and response headers



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

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

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

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

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

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