Class: DatadogAPIClient::V1::LogsIndexesAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of LogsIndexesAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create an index.

See Also:



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

def create_logs_index(body, opts = {})
  data, _status_code, _headers = create_logs_index_with_http_info(body, opts)
  data
end

#create_logs_index_with_http_info(body, opts = {}) ⇒ Array<(LogsIndex, Integer, Hash)>

Create an index.

Creates a new index. Returns the Index object passed in the request body when the request is successful.

Parameters:

  • body (LogsIndex) —

    Object containing the new index.

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

    the optional parameters

Returns:

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

    LogsIndex 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_indexes_api.rb', line 40

def create_logs_index_with_http_info(body, opts = {})

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

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

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

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

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

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

Get an index.

See Also:



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

def get_logs_index(name, opts = {})
  data, _status_code, _headers = get_logs_index_with_http_info(name, opts)
  data
end

#get_logs_index_order(opts = {}) ⇒ Object

Get indexes order.

See Also:



177
178
179
180
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 177

def get_logs_index_order(opts = {})
  data, _status_code, _headers = get_logs_index_order_with_http_info(opts)
  data
end

#get_logs_index_order_with_http_info(opts = {}) ⇒ Array<(LogsIndexesOrder, Integer, Hash)>

Get indexes order.

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

Parameters:

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

    the optional parameters

Returns:

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

    LogsIndexesOrder data, response status code and response headers



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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 186

def get_logs_index_order_with_http_info(opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsIndexesAPI.get_logs_index_order ...'
  end
  # resource path
  local_var_path = '/api/v1/logs/config/index-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] || 'LogsIndexesOrder'

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

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

#get_logs_index_with_http_info(name, opts = {}) ⇒ Array<(LogsIndex, Integer, Hash)>

Get an index.

Get one log index from your organization. This endpoint takes no JSON arguments.

Parameters:

  • name (String) —

    Name of the log index.

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

    the optional parameters

Returns:

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

    LogsIndex data, 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_indexes_api.rb', line 115

def get_logs_index_with_http_info(name, opts = {})

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

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

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

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

#list_log_indexes(opts = {}) ⇒ Object

Get all indexes.

See Also:



244
245
246
247
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 244

def list_log_indexes(opts = {})
  data, _status_code, _headers = list_log_indexes_with_http_info(opts)
  data
end

#list_log_indexes_with_http_info(opts = {}) ⇒ Array<(LogsIndexListResponse, Integer, Hash)>

Get all indexes.

The Index object describes the configuration of a log index. This endpoint returns an array of the LogIndex objects of your organization.

Parameters:

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

    the optional parameters

Returns:

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

    LogsIndexListResponse data, response status code and response headers



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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 253

def list_log_indexes_with_http_info(opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsIndexesAPI.list_log_indexes ...'
  end
  # resource path
  local_var_path = '/api/v1/logs/config/indexes'

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

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

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

#update_logs_index(name, body, opts = {}) ⇒ Object

Update an index.

See Also:



313
314
315
316
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 313

def update_logs_index(name, body, opts = {})
  data, _status_code, _headers = update_logs_index_with_http_info(name, body, opts)
  data
end

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

Update indexes order.

See Also:



393
394
395
396
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 393

def update_logs_index_order(body, opts = {})
  data, _status_code, _headers = update_logs_index_order_with_http_info(body, opts)
  data
end

#update_logs_index_order_with_http_info(body, opts = {}) ⇒ Array<(LogsIndexesOrder, Integer, Hash)>

Update indexes order.

This endpoint updates the index order of your organization. It returns the index order object passed in the request body when the request is successful.

Parameters:

  • body (LogsIndexesOrder) —

    Object containing the new ordered list of index names

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

    the optional parameters

Returns:

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

    LogsIndexesOrder data, response status code and response headers



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
460
461
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 403

def update_logs_index_order_with_http_info(body, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsIndexesAPI.update_logs_index_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 LogsIndexesAPI.update_logs_index_order"
  end
  # resource path
  local_var_path = '/api/v1/logs/config/index-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] || 'LogsIndexesOrder'

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

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

#update_logs_index_with_http_info(name, body, opts = {}) ⇒ Array<(LogsIndex, Integer, Hash)>

Update an index.

Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful.

Using the PUT method updates your index’s configuration by replacing your current configuration with the new one sent to your Datadog organization.

Parameters:

  • name (String) —

    Name of the log index.

  • body (LogsIndexUpdateRequest) —

    Object containing the new LogsIndexUpdateRequest.

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

    the optional parameters

Returns:

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

    LogsIndex data, response status code and response headers



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

def update_logs_index_with_http_info(name, body, opts = {})

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

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

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

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