Class: DatadogAPIClient::V2::ObservabilityPipelinesAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ObservabilityPipelinesAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create a new pipeline.

See Also:



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

def create_pipeline(body, opts = {})
  data, _status_code, _headers = create_pipeline_with_http_info(body, opts)
  data
end

#create_pipeline_with_http_info(body, opts = {}) ⇒ Array<(ObservabilityPipeline, Integer, Hash)>

Create a new pipeline.

Create a new pipeline.

Parameters:

Returns:

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

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

def create_pipeline_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityPipelinesAPI.create_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 ObservabilityPipelinesAPI.create_pipeline"
  end
  # resource path
  local_var_path = '/api/v2/obs-pipelines/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] || 'ObservabilityPipeline'

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

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

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

Delete a pipeline.

See Also:



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

def delete_pipeline(pipeline_id, opts = {})
  delete_pipeline_with_http_info(pipeline_id, opts)
  nil
end

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

Delete a pipeline.

Delete a pipeline.

Parameters:

  • pipeline_id (String) —

    The 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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/datadog_api_client/v2/api/observability_pipelines_api.rb', line 108

def delete_pipeline_with_http_info(pipeline_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityPipelinesAPI.delete_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 ObservabilityPipelinesAPI.delete_pipeline"
  end
  # resource path
  local_var_path = '/api/v2/obs-pipelines/pipelines/{pipeline_id}'.sub('{pipeline_id}', CGI.escape(pipeline_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_pipeline,
    :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: ObservabilityPipelinesAPI#delete_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a specific pipeline.

See Also:



161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/observability_pipelines_api.rb', line 161

def get_pipeline(pipeline_id, opts = {})
  data, _status_code, _headers = get_pipeline_with_http_info(pipeline_id, opts)
  data
end

#get_pipeline_with_http_info(pipeline_id, opts = {}) ⇒ Array<(ObservabilityPipeline, Integer, Hash)>

Get a specific pipeline.

Get a specific pipeline by its ID.

Parameters:

  • pipeline_id (String) —

    The ID of the pipeline to retrieve.

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

    the optional parameters

Returns:

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

    ObservabilityPipeline data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/datadog_api_client/v2/api/observability_pipelines_api.rb', line 173

def get_pipeline_with_http_info(pipeline_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityPipelinesAPI.get_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 ObservabilityPipelinesAPI.get_pipeline"
  end
  # resource path
  local_var_path = '/api/v2/obs-pipelines/pipelines/{pipeline_id}'.sub('{pipeline_id}', CGI.escape(pipeline_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] || 'ObservabilityPipeline'

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

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

#list_pipelines(opts = {}) ⇒ Object

List pipelines.

See Also:



226
227
228
229
 
# File 'lib/datadog_api_client/v2/api/observability_pipelines_api.rb', line 226

def list_pipelines(opts = {})
  data, _status_code, _headers = list_pipelines_with_http_info(opts)
  data
end

#list_pipelines_with_http_info(opts = {}) ⇒ Array<(ListPipelinesResponse, Integer, Hash)>

List pipelines.

Retrieve a list of pipelines.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Size for a given page. The maximum allowed value is 100.

  • :page_number (Integer) —

    Specific page number to return.

Returns:

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

    ListPipelinesResponse data, response status code and response headers



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
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
 
# File 'lib/datadog_api_client/v2/api/observability_pipelines_api.rb', line 239

def list_pipelines_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityPipelinesAPI.list_pipelines ...'
  end
  # resource path
  local_var_path = '/api/v2/obs-pipelines/pipelines'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].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] || 'ListPipelinesResponse'

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

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

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

Update a pipeline.

See Also:



290
291
292
293
 
# File 'lib/datadog_api_client/v2/api/observability_pipelines_api.rb', line 290

def update_pipeline(pipeline_id, body, opts = {})
  data, _status_code, _headers = update_pipeline_with_http_info(pipeline_id, body, opts)
  data
end

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

Update a pipeline.

Update a pipeline.

Parameters:

  • pipeline_id (String) —

    The ID of the pipeline to update.

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

    the optional parameters

Returns:

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

    ObservabilityPipeline data, response status code and response headers



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/datadog_api_client/v2/api/observability_pipelines_api.rb', line 303

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityPipelinesAPI.update_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 ObservabilityPipelinesAPI.update_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 ObservabilityPipelinesAPI.update_pipeline"
  end
  # resource path
  local_var_path = '/api/v2/obs-pipelines/pipelines/{pipeline_id}'.sub('{pipeline_id}', CGI.escape(pipeline_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] || 'ObservabilityPipeline'

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

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

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

Validate an observability pipeline.

See Also:



362
363
364
365
 
# File 'lib/datadog_api_client/v2/api/observability_pipelines_api.rb', line 362

def validate_pipeline(body, opts = {})
  data, _status_code, _headers = validate_pipeline_with_http_info(body, opts)
  data
end

#validate_pipeline_with_http_info(body, opts = {}) ⇒ Array<(ValidationResponse, Integer, Hash)>

Validate an observability pipeline.

Validates a pipeline configuration without creating or updating any resources. Returns a list of validation errors, if any.

Parameters:

Returns:

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

    ValidationResponse data, response status code and response headers



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/datadog_api_client/v2/api/observability_pipelines_api.rb', line 375

def validate_pipeline_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityPipelinesAPI.validate_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 ObservabilityPipelinesAPI.validate_pipeline"
  end
  # resource path
  local_var_path = '/api/v2/obs-pipelines/pipelines/validate'

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

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

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