Class: DatadogAPIClient::V2::RumTeamsOwnershipAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RumTeamsOwnershipAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create a teams ownership mapping.

See Also:



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

def create_teams_ownership_mapping(body, opts = {})
  data, _status_code, _headers = create_teams_ownership_mapping_with_http_info(body, opts)
  data
end

#create_teams_ownership_mapping_with_http_info(body, opts = {}) ⇒ Array<(TeamsOwnershipMappingResponse, Integer, Hash)>

Create a teams ownership mapping.

Create a teams ownership mapping for your organization. Returns the teams ownership mapping object from the request body when the request is successful.

Parameters:

Returns:



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.create_teams_ownership_mapping ...'
  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 RumTeamsOwnershipAPI.create_teams_ownership_mapping"
  end
  # resource path
  local_var_path = '/api/v2/rum/config/teams-ownership/mappings'

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

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

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

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

Bulk create and remove teams ownership mappings.

See Also:



103
104
105
106
 
# File 'lib/datadog_api_client/v2/api/rum_teams_ownership_api.rb', line 103

def create_teams_ownership_mappings_batch(body, opts = {})
  data, _status_code, _headers = create_teams_ownership_mappings_batch_with_http_info(body, opts)
  data
end

#create_teams_ownership_mappings_batch_with_http_info(body, opts = {}) ⇒ Array<(TeamsOwnershipMappingBatchResponse, Integer, Hash)>

Bulk create and remove teams ownership mappings.

Add and remove teams ownership mappings for your organization in a single atomic request, following the JSON:API atomic operations extension. Operations are applied together: if any operation is invalid, none of the operations are applied. Add operations are processed before remove operations, so results may not appear in the same order as the request.

Parameters:

Returns:



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
173
174
175
 
# File 'lib/datadog_api_client/v2/api/rum_teams_ownership_api.rb', line 119

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.create_teams_ownership_mappings_batch ...'
  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 RumTeamsOwnershipAPI.create_teams_ownership_mappings_batch"
  end
  # resource path
  local_var_path = '/api/v2/rum/config/teams-ownership/mappings/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] || 'TeamsOwnershipMappingBatchResponse'

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

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

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

Delete a teams ownership mapping.

See Also:



180
181
182
183
 
# File 'lib/datadog_api_client/v2/api/rum_teams_ownership_api.rb', line 180

def delete_teams_ownership_mapping(id, opts = {})
  delete_teams_ownership_mapping_with_http_info(id, opts)
  nil
end

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

Delete a teams ownership mapping.

Delete a specific teams ownership mapping from your organization.

Parameters:

  • id (String) —

    The ID of the teams ownership mapping.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
244
245
246
 
# File 'lib/datadog_api_client/v2/api/rum_teams_ownership_api.rb', line 192

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.delete_teams_ownership_mapping ...'
  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 RumTeamsOwnershipAPI.delete_teams_ownership_mapping"
  end
  # resource path
  local_var_path = '/api/v2/rum/config/teams-ownership/mappings/{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_teams_ownership_mapping,
    :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: RumTeamsOwnershipAPI#delete_teams_ownership_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a teams ownership mapping.

See Also:



251
252
253
254
 
# File 'lib/datadog_api_client/v2/api/rum_teams_ownership_api.rb', line 251

def get_teams_ownership_mapping(id, opts = {})
  data, _status_code, _headers = get_teams_ownership_mapping_with_http_info(id, opts)
  data
end

#get_teams_ownership_mapping_with_http_info(id, opts = {}) ⇒ Array<(TeamsOwnershipMappingResponse, Integer, Hash)>

Get a teams ownership mapping.

Get a specific teams ownership mapping from your organization.

Parameters:

  • id (String) —

    The ID of the teams ownership mapping.

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

    the optional parameters

Returns:



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.get_teams_ownership_mapping ...'
  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 RumTeamsOwnershipAPI.get_teams_ownership_mapping"
  end
  # resource path
  local_var_path = '/api/v2/rum/config/teams-ownership/mappings/{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] || 'TeamsOwnershipMappingResponse'

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

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

#list_teams_ownership_mappings(opts = {}) ⇒ Object

List teams ownership mappings.

See Also:



322
323
324
325
 
# File 'lib/datadog_api_client/v2/api/rum_teams_ownership_api.rb', line 322

def list_teams_ownership_mappings(opts = {})
  data, _status_code, _headers = list_teams_ownership_mappings_with_http_info(opts)
  data
end

#list_teams_ownership_mappings_with_http_info(opts = {}) ⇒ Array<(TeamsOwnershipMappingsResponse, Integer, Hash)>

List teams ownership mappings.

Get the list of teams ownership mappings for your organization, optionally filtered.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_view_name (Array<String>) —

    Filter mappings by RUM view name.

  • :filter_team_handle (Array<String>) —

    Filter mappings by owning team handle.

  • :filter_application_id (Array<UUID>) —

    Filter mappings by RUM application ID. Each value must be a valid UUID.

  • :filter_service (Array<String>) —

    Filter mappings by RUM application service name.

Returns:



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
391
392
 
# File 'lib/datadog_api_client/v2/api/rum_teams_ownership_api.rb', line 337

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.list_teams_ownership_mappings ...'
  end
  # resource path
  local_var_path = '/api/v2/rum/config/teams-ownership/mappings'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[view_name]'] = @api_client.build_collection_param(opts[:'filter_view_name'], :multi) if !opts[:'filter_view_name'].nil?
  query_params[:'filter[team_handle]'] = @api_client.build_collection_param(opts[:'filter_team_handle'], :multi) if !opts[:'filter_team_handle'].nil?
  query_params[:'filter[application_id]'] = @api_client.build_collection_param(opts[:'filter_application_id'], :multi) if !opts[:'filter_application_id'].nil?
  query_params[:'filter[service]'] = @api_client.build_collection_param(opts[:'filter_service'], :multi) if !opts[:'filter_service'].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] || 'TeamsOwnershipMappingsResponse'

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

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

#list_teams_ownership_rules(opts = {}) ⇒ Object

List teams ownership rules.

See Also:



397
398
399
400
 
# File 'lib/datadog_api_client/v2/api/rum_teams_ownership_api.rb', line 397

def list_teams_ownership_rules(opts = {})
  data, _status_code, _headers = list_teams_ownership_rules_with_http_info(opts)
  data
end

#list_teams_ownership_rules_with_http_info(opts = {}) ⇒ Array<(TeamsOwnershipRulesResponse, Integer, Hash)>

List teams ownership rules.

Get the list of teams ownership rules for your organization, optionally filtered. Rules group the underlying mappings by view_name, application_id, service, and match_type, collapsing every team that owns the same view into a single entry.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_view_name (Array<String>) —

    Filter mappings by RUM view name.

  • :filter_team_handle (Array<String>) —

    Filter mappings by owning team handle.

  • :filter_application_id (Array<UUID>) —

    Filter mappings by RUM application ID. Each value must be a valid UUID.

  • :filter_service (Array<String>) —

    Filter mappings by RUM application service name.

Returns:

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

    TeamsOwnershipRulesResponse data, response status code and response headers



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
462
463
464
465
466
467
468
469
 
# File 'lib/datadog_api_client/v2/api/rum_teams_ownership_api.rb', line 414

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.list_teams_ownership_rules ...'
  end
  # resource path
  local_var_path = '/api/v2/rum/config/teams-ownership/rules'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[view_name]'] = @api_client.build_collection_param(opts[:'filter_view_name'], :multi) if !opts[:'filter_view_name'].nil?
  query_params[:'filter[team_handle]'] = @api_client.build_collection_param(opts[:'filter_team_handle'], :multi) if !opts[:'filter_team_handle'].nil?
  query_params[:'filter[application_id]'] = @api_client.build_collection_param(opts[:'filter_application_id'], :multi) if !opts[:'filter_application_id'].nil?
  query_params[:'filter[service]'] = @api_client.build_collection_param(opts[:'filter_service'], :multi) if !opts[:'filter_service'].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] || 'TeamsOwnershipRulesResponse'

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

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