Class: DatadogAPIClient::V2::LogsArchivesAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of LogsArchivesAPI.



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

def initialize(api_client = 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/logs_archives_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#add_read_role_to_archive(archive_id, body, opts = {}) ⇒ Object

Grant role to an archive.

See Also:



31
32
33
34
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 31

def add_read_role_to_archive(archive_id, body, opts = {})
  add_read_role_to_archive_with_http_info(archive_id, body, opts)
  nil
end

#add_read_role_to_archive_with_http_info(archive_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Grant role to an archive.

Adds a read role to an archive. (Roles API)

Parameters:

  • archive_id (String) —

    The ID of the archive.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
99
100
101
102
103
104
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 42

def add_read_role_to_archive_with_http_info(archive_id, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:add_read_role_to_archive)
    unstable_enabled = @api_client.config.unstable_operations[:add_read_role_to_archive]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "add_read_role_to_archive")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "add_read_role_to_archive"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.add_read_role_to_archive ...'
  end
  # verify the required parameter 'archive_id' is set
  if @api_client.config.client_side_validation && archive_id.nil?
    fail ArgumentError, "Missing the required parameter 'archive_id' when calling LogsArchivesAPI.add_read_role_to_archive"
  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 LogsArchivesAPI.add_read_role_to_archive"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archives/{archive_id}/readers'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :add_read_role_to_archive,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

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

Create an archive.

See Also:



111
112
113
114
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 111

def create_logs_archive(body, opts = {})
  data, _status_code, _headers = create_logs_archive_with_http_info(body, opts)
  data
end

#create_logs_archive_with_http_info(body, opts = {}) ⇒ Array<(LogsArchive, Integer, Hash)>

Create an archive.

Create an archive in your organization.

Parameters:

  • body (LogsArchiveCreateRequest) —

    The definition of the new archive.

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

    the optional parameters

Returns:

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

    LogsArchive data, response status code and response headers



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
176
177
178
179
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 121

def create_logs_archive_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_logs_archive)
    unstable_enabled = @api_client.config.unstable_operations[:create_logs_archive]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_logs_archive")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_logs_archive"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.create_logs_archive ...'
  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 LogsArchivesAPI.create_logs_archive"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archives'

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

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

  new_options = opts.merge(
    :operation => :create_logs_archive,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#delete_logs_archive(archive_id, opts = {}) ⇒ Object

Delete an archive.

See Also:



186
187
188
189
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 186

def delete_logs_archive(archive_id, opts = {})
  delete_logs_archive_with_http_info(archive_id, opts)
  nil
end

#delete_logs_archive_with_http_info(archive_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an archive.

Delete a given archive from your organization.

Parameters:

  • archive_id (String) —

    The ID of the archive.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
247
248
249
250
251
252
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 196

def delete_logs_archive_with_http_info(archive_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_logs_archive)
    unstable_enabled = @api_client.config.unstable_operations[:delete_logs_archive]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_logs_archive")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_logs_archive"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.delete_logs_archive ...'
  end
  # verify the required parameter 'archive_id' is set
  if @api_client.config.client_side_validation && archive_id.nil?
    fail ArgumentError, "Missing the required parameter 'archive_id' when calling LogsArchivesAPI.delete_logs_archive"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archives/{archive_id}'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :delete_logs_archive,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_logs_archive(archive_id, opts = {}) ⇒ Object

Get an archive.

See Also:



259
260
261
262
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 259

def get_logs_archive(archive_id, opts = {})
  data, _status_code, _headers = get_logs_archive_with_http_info(archive_id, opts)
  data
end

#get_logs_archive_order(opts = {}) ⇒ Object

Get archive order.

See Also:



331
332
333
334
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 331

def get_logs_archive_order(opts = {})
  data, _status_code, _headers = get_logs_archive_order_with_http_info(opts)
  data
end

#get_logs_archive_order_with_http_info(opts = {}) ⇒ Array<(LogsArchiveOrder, Integer, Hash)>

Get archive order.

Get the current order of your archives. This endpoint takes no JSON arguments.

Parameters:

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

    the optional parameters

Returns:

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

    LogsArchiveOrder data, response status code and response headers



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/logs_archives_api.rb', line 340

def get_logs_archive_order_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_logs_archive_order)
    unstable_enabled = @api_client.config.unstable_operations[:get_logs_archive_order]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_logs_archive_order")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_logs_archive_order"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.get_logs_archive_order ...'
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archive-order'

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

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

  new_options = opts.merge(
    :operation => :get_logs_archive_order,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_logs_archive_with_http_info(archive_id, opts = {}) ⇒ Array<(LogsArchive, Integer, Hash)>

Get an archive.

Get a specific archive from your organization.

Parameters:

  • archive_id (String) —

    The ID of the archive.

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

    the optional parameters

Returns:

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

    LogsArchive data, response status code and response headers



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

def get_logs_archive_with_http_info(archive_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_logs_archive)
    unstable_enabled = @api_client.config.unstable_operations[:get_logs_archive]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_logs_archive")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_logs_archive"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.get_logs_archive ...'
  end
  # verify the required parameter 'archive_id' is set
  if @api_client.config.client_side_validation && archive_id.nil?
    fail ArgumentError, "Missing the required parameter 'archive_id' when calling LogsArchivesAPI.get_logs_archive"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archives/{archive_id}'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :get_logs_archive,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#list_archive_read_roles(archive_id, opts = {}) ⇒ Object

List read roles for an archive.

See Also:



399
400
401
402
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 399

def list_archive_read_roles(archive_id, opts = {})
  data, _status_code, _headers = list_archive_read_roles_with_http_info(archive_id, opts)
  data
end

#list_archive_read_roles_with_http_info(archive_id, opts = {}) ⇒ Array<(RolesResponse, Integer, Hash)>

List read roles for an archive.

Returns all read roles a given archive is restricted to.

Parameters:

  • archive_id (String) —

    The ID of the archive.

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

    the optional parameters

Returns:

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

    RolesResponse data, response status code and response headers



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
462
463
464
465
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 409

def list_archive_read_roles_with_http_info(archive_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_archive_read_roles)
    unstable_enabled = @api_client.config.unstable_operations[:list_archive_read_roles]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_archive_read_roles")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_archive_read_roles"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.list_archive_read_roles ...'
  end
  # verify the required parameter 'archive_id' is set
  if @api_client.config.client_side_validation && archive_id.nil?
    fail ArgumentError, "Missing the required parameter 'archive_id' when calling LogsArchivesAPI.list_archive_read_roles"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archives/{archive_id}/readers'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :list_archive_read_roles,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#list_logs_archives(opts = {}) ⇒ Object

Get all archives.

See Also:



471
472
473
474
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 471

def list_logs_archives(opts = {})
  data, _status_code, _headers = list_logs_archives_with_http_info(opts)
  data
end

#list_logs_archives_with_http_info(opts = {}) ⇒ Array<(LogsArchives, Integer, Hash)>

Get all archives.

Get the list of configured logs archives with their definitions.

Parameters:

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

    the optional parameters

Returns:

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

    LogsArchives data, response status code and response headers



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 480

def list_logs_archives_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_logs_archives)
    unstable_enabled = @api_client.config.unstable_operations[:list_logs_archives]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_logs_archives")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_logs_archives"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.list_logs_archives ...'
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archives'

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

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

  new_options = opts.merge(
    :operation => :list_logs_archives,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#remove_role_from_archive(archive_id, body, opts = {}) ⇒ Object

Revoke role from an archive.

See Also:



540
541
542
543
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 540

def remove_role_from_archive(archive_id, body, opts = {})
  remove_role_from_archive_with_http_info(archive_id, body, opts)
  nil
end

#remove_role_from_archive_with_http_info(archive_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Revoke role from an archive.

Removes a role from an archive. (Roles API)

Parameters:

  • archive_id (String) —

    The ID of the archive.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 551

def remove_role_from_archive_with_http_info(archive_id, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:remove_role_from_archive)
    unstable_enabled = @api_client.config.unstable_operations[:remove_role_from_archive]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "remove_role_from_archive")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "remove_role_from_archive"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.remove_role_from_archive ...'
  end
  # verify the required parameter 'archive_id' is set
  if @api_client.config.client_side_validation && archive_id.nil?
    fail ArgumentError, "Missing the required parameter 'archive_id' when calling LogsArchivesAPI.remove_role_from_archive"
  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 LogsArchivesAPI.remove_role_from_archive"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archives/{archive_id}/readers'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :remove_role_from_archive,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#update_logs_archive(archive_id, body, opts = {}) ⇒ Object

Update an archive.

See Also:



621
622
623
624
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 621

def update_logs_archive(archive_id, body, opts = {})
  data, _status_code, _headers = update_logs_archive_with_http_info(archive_id, body, opts)
  data
end

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

Update archive order.

See Also:



701
702
703
704
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 701

def update_logs_archive_order(body, opts = {})
  data, _status_code, _headers = update_logs_archive_order_with_http_info(body, opts)
  data
end

#update_logs_archive_order_with_http_info(body, opts = {}) ⇒ Array<(LogsArchiveOrder, Integer, Hash)>

Update archive order.

Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives.

Note: Using the PUT method updates your archive's order by replacing the current order with the new one.

Parameters:

  • body (LogsArchiveOrder) —

    An object containing the new ordered list of archive IDs.

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

    the optional parameters

Returns:

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

    LogsArchiveOrder data, response status code and response headers



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
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
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 711

def update_logs_archive_order_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_logs_archive_order)
    unstable_enabled = @api_client.config.unstable_operations[:update_logs_archive_order]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_logs_archive_order")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_logs_archive_order"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.update_logs_archive_order ...'
  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 LogsArchivesAPI.update_logs_archive_order"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archive-order'

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

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

  new_options = opts.merge(
    :operation => :update_logs_archive_order,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#update_logs_archive_with_http_info(archive_id, body, opts = {}) ⇒ Array<(LogsArchive, Integer, Hash)>

Update an archive.

Update a given archive configuration.

Note: Using this method updates your archive configuration by replacing your current configuration with the new one sent to your Datadog organization.

Parameters:

  • archive_id (String) —

    The ID of the archive.

  • body (LogsArchiveCreateRequest) —

    New definition of the archive.

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

    the optional parameters

Returns:

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

    LogsArchive data, response status code and response headers



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/datadog_api_client/v2/api/logs_archives_api.rb', line 632

def update_logs_archive_with_http_info(archive_id, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_logs_archive)
    unstable_enabled = @api_client.config.unstable_operations[:update_logs_archive]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_logs_archive")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_logs_archive"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchivesAPI.update_logs_archive ...'
  end
  # verify the required parameter 'archive_id' is set
  if @api_client.config.client_side_validation && archive_id.nil?
    fail ArgumentError, "Missing the required parameter 'archive_id' when calling LogsArchivesAPI.update_logs_archive"
  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 LogsArchivesAPI.update_logs_archive"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/archives/{archive_id}'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :update_logs_archive,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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