Class: DatadogAPIClient::V1::LogsPipelinesAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/logs_pipelines_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of LogsPipelinesAPI.



22
23
24
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_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/v1/api/logs_pipelines_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Create a pipeline.

See Also:



30
31
32
33
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 30

def create_logs_pipeline(body, opts = {})
  data, _status_code, _headers = create_logs_pipeline_with_http_info(body, opts)
  data
end

#create_logs_pipeline_with_http_info(body, opts = {}) ⇒ Array<(LogsPipeline, Integer, Hash)>

Create a pipeline.

Create a pipeline in your organization.

Parameters:

  • body (LogsPipeline) —

    Definition of the new pipeline.

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

    the optional parameters

Returns:

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

    LogsPipeline data, response status code and response headers



40
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
98
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 40

def create_logs_pipeline_with_http_info(body, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsPipelinesAPI.create_logs_pipeline ...'
  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 LogsPipelinesAPI.create_logs_pipeline"
  end
  # resource path
  local_var_path = '/api/v1/logs/config/pipelines'

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

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

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

#delete_logs_pipeline(pipeline_id, opts = {}) ⇒ Object

Delete a pipeline.

See Also:



105
106
107
108
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 105

def delete_logs_pipeline(pipeline_id, opts = {})
  delete_logs_pipeline_with_http_info(pipeline_id, opts)
  nil
end

#delete_logs_pipeline_with_http_info(pipeline_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a pipeline.

Delete a given pipeline from your organization. This endpoint takes no JSON arguments.

Parameters:

  • pipeline_id (String) —

    ID of the pipeline to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_logs_pipeline_with_http_info(pipeline_id, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsPipelinesAPI.delete_logs_pipeline ...'
  end
  # verify the required parameter 'pipeline_id' is set
  if @api_client.config.client_side_validation && pipeline_id.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_id' when calling LogsPipelinesAPI.delete_logs_pipeline"
  end
  # resource path
  local_var_path = '/api/v1/logs/config/pipelines/{pipeline_id}'.sub('{' + 'pipeline_id' + '}', CGI.escape(pipeline_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_pipeline,
    :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: LogsPipelinesAPI#delete_logs_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_logs_pipeline(pipeline_id, opts = {}) ⇒ Object

Get a pipeline.

See Also:



178
179
180
181
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 178

def get_logs_pipeline(pipeline_id, opts = {})
  data, _status_code, _headers = get_logs_pipeline_with_http_info(pipeline_id, opts)
  data
end

#get_logs_pipeline_order(opts = {}) ⇒ Object

Get pipeline order.

See Also:



250
251
252
253
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 250

def get_logs_pipeline_order(opts = {})
  data, _status_code, _headers = get_logs_pipeline_order_with_http_info(opts)
  data
end

#get_logs_pipeline_order_with_http_info(opts = {}) ⇒ Array<(LogsPipelinesOrder, Integer, Hash)>

Get pipeline order.

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

Parameters:

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

    the optional parameters

Returns:

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

    LogsPipelinesOrder data, response status code and response headers



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 259

def get_logs_pipeline_order_with_http_info(opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsPipelinesAPI.get_logs_pipeline_order ...'
  end
  # resource path
  local_var_path = '/api/v1/logs/config/pipeline-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] || 'LogsPipelinesOrder'

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

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

#get_logs_pipeline_with_http_info(pipeline_id, opts = {}) ⇒ Array<(LogsPipeline, Integer, Hash)>

Get a pipeline.

Get a specific pipeline from your organization. This endpoint takes no JSON arguments.

Parameters:

  • pipeline_id (String) —

    ID of the pipeline to get.

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

    the optional parameters

Returns:

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

    LogsPipeline data, response status code and response headers



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 188

def get_logs_pipeline_with_http_info(pipeline_id, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsPipelinesAPI.get_logs_pipeline ...'
  end
  # verify the required parameter 'pipeline_id' is set
  if @api_client.config.client_side_validation && pipeline_id.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_id' when calling LogsPipelinesAPI.get_logs_pipeline"
  end
  # resource path
  local_var_path = '/api/v1/logs/config/pipelines/{pipeline_id}'.sub('{' + 'pipeline_id' + '}', CGI.escape(pipeline_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] || 'LogsPipeline'

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

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

#list_logs_pipelines(opts = {}) ⇒ Object

Get all pipelines.

See Also:



317
318
319
320
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 317

def list_logs_pipelines(opts = {})
  data, _status_code, _headers = list_logs_pipelines_with_http_info(opts)
  data
end

#list_logs_pipelines_with_http_info(opts = {}) ⇒ Array<(Array<LogsPipeline>, Integer, Hash)>

Get all pipelines.

Get all pipelines from your organization. This endpoint takes no JSON arguments.

Parameters:

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

    the optional parameters

Returns:

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

    Array data, response status code and response headers



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 326

def list_logs_pipelines_with_http_info(opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsPipelinesAPI.list_logs_pipelines ...'
  end
  # resource path
  local_var_path = '/api/v1/logs/config/pipelines'

  # 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] || 'Array<LogsPipeline>'

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

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

#update_logs_pipeline(pipeline_id, body, opts = {}) ⇒ Object

Update a pipeline.

See Also:



386
387
388
389
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 386

def update_logs_pipeline(pipeline_id, body, opts = {})
  data, _status_code, _headers = update_logs_pipeline_with_http_info(pipeline_id, body, opts)
  data
end

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

Update pipeline order.

See Also:



466
467
468
469
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 466

def update_logs_pipeline_order(body, opts = {})
  data, _status_code, _headers = update_logs_pipeline_order_with_http_info(body, opts)
  data
end

#update_logs_pipeline_order_with_http_info(body, opts = {}) ⇒ Array<(LogsPipelinesOrder, Integer, Hash)>

Update pipeline order.

Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change the structure and content of the data processed by other pipelines and their processors.

Note: Using the PUT method updates your pipeline order by replacing your current order with the new one sent to your Datadog organization.

Parameters:

  • body (LogsPipelinesOrder) —

    Object containing the new ordered list of pipeline IDs.

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

    the optional parameters

Returns:

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

    LogsPipelinesOrder data, response status code and response headers



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

def update_logs_pipeline_order_with_http_info(body, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsPipelinesAPI.update_logs_pipeline_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 LogsPipelinesAPI.update_logs_pipeline_order"
  end
  # resource path
  local_var_path = '/api/v1/logs/config/pipeline-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] || 'LogsPipelinesOrder'

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

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

#update_logs_pipeline_with_http_info(pipeline_id, body, opts = {}) ⇒ Array<(LogsPipeline, Integer, Hash)>

Update a pipeline.

Update a given pipeline configuration to change it’s processors or their order.

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

Parameters:

  • pipeline_id (String) —

    ID of the pipeline to delete.

  • body (LogsPipeline) —

    New definition of the pipeline.

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

    the optional parameters

Returns:

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

    LogsPipeline data, response status code and response headers



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/datadog_api_client/v1/api/logs_pipelines_api.rb', line 397

def update_logs_pipeline_with_http_info(pipeline_id, body, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsPipelinesAPI.update_logs_pipeline ...'
  end
  # verify the required parameter 'pipeline_id' is set
  if @api_client.config.client_side_validation && pipeline_id.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_id' when calling LogsPipelinesAPI.update_logs_pipeline"
  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 LogsPipelinesAPI.update_logs_pipeline"
  end
  # resource path
  local_var_path = '/api/v1/logs/config/pipelines/{pipeline_id}'.sub('{' + 'pipeline_id' + '}', CGI.escape(pipeline_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] || 'LogsPipeline'

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

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