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 = 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/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:



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

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



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/v1/api/logs_indexes_api.rb', line 41

def create_logs_index_with_http_info(body, opts = {})

  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,
    :api_version => "V1"
  )

  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: 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:



96
97
98
99
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 96

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:



161
162
163
164
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 161

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



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

def get_logs_index_order_with_http_info(opts = {})

  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] || [: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,
    :api_version => "V1"
  )

  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: 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



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/v1/api/logs_indexes_api.rb', line 108

def get_logs_index_with_http_info(name, opts = {})

  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).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] || '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,
    :api_version => "V1"
  )

  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: 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:



221
222
223
224
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 221

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



233
234
235
236
237
238
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
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 233

def list_log_indexes_with_http_info(opts = {})

  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] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  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,
    :api_version => "V1"
  )

  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: 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:



282
283
284
285
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 282

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:



358
359
360
361
 
# File 'lib/datadog_api_client/v1/api/logs_indexes_api.rb', line 358

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



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

def update_logs_index_order_with_http_info(body, opts = {})

  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,
    :api_version => "V1"
  )

  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: 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



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

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

  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).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] || '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,
    :api_version => "V1"
  )

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