Class: DatadogAPIClient::V2::ReferenceTablesAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ReferenceTablesAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create reference table.

See Also:



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

def create_reference_table(body, opts = {})
  data, _status_code, _headers = create_reference_table_with_http_info(body, opts)
  data
end

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

Create reference table upload.

See Also:



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

def create_reference_table_upload(body, opts = {})
  data, _status_code, _headers = create_reference_table_upload_with_http_info(body, opts)
  data
end

#create_reference_table_upload_with_http_info(body, opts = {}) ⇒ Array<(CreateUploadResponse, Integer, Hash)>

Create reference table upload.

Create a reference table upload for bulk data ingestion

Parameters:

Returns:

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

    CreateUploadResponse 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
157
158
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 108

def create_reference_table_upload_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReferenceTablesAPI.create_reference_table_upload ...'
  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 ReferenceTablesAPI.create_reference_table_upload"
  end
  # resource path
  local_var_path = '/api/v2/reference-tables/uploads'

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

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

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

#create_reference_table_with_http_info(body, opts = {}) ⇒ Array<(TableResultV2, Integer, Hash)>

Create reference table.

Create a new reference table. You can provide data in two ways: 1) Call POST api/v2/reference-tables/upload first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this POST endpoint with the upload_id in file_metadata, OR 2) Provide access_details in file_metadata pointing to a CSV file in cloud storage (Amazon S3, Azure Blob Storage, or GCP Cloud Storage).

Parameters:

Returns:

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

    TableResultV2 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/reference_tables_api.rb', line 41

def create_reference_table_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReferenceTablesAPI.create_reference_table ...'
  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 ReferenceTablesAPI.create_reference_table"
  end
  # resource path
  local_var_path = '/api/v2/reference-tables/tables'

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

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

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

#delete_table(id, opts = {}) ⇒ Object

Delete table.

See Also:



163
164
165
166
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 163

def delete_table(id, opts = {})
  delete_table_with_http_info(id, opts)
  nil
end

#delete_table_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete table.

Delete a reference table by ID

Parameters:

  • id (String) —

    The ID of the reference table to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
222
223
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 175

def delete_table_with_http_info(id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReferenceTablesAPI.delete_table ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ReferenceTablesAPI.delete_table"
  end
  # resource path
  local_var_path = '/api/v2/reference-tables/tables/{id}'.sub('{id}', CGI.escape(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, :AuthZ]

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

#get_rows_by_id(id, row_id, opts = {}) ⇒ Object

Get rows by id.

See Also:



228
229
230
231
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 228

def get_rows_by_id(id, row_id, opts = {})
  data, _status_code, _headers = get_rows_by_id_with_http_info(id, row_id, opts)
  data
end

#get_rows_by_id_with_http_info(id, row_id, opts = {}) ⇒ Array<(TableRowResourceArray, Integer, Hash)>

Get rows by id.

Get reference table rows by their primary key values.

Parameters:

  • id (String) —

    The ID of the reference table

  • row_id (Array<String>) —

    List of row IDs (primary key values) to retrieve from the reference table.

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

    the optional parameters

Returns:

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

    TableRowResourceArray data, response status code and response headers



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
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 241

def get_rows_by_id_with_http_info(id, row_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReferenceTablesAPI.get_rows_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ReferenceTablesAPI.get_rows_by_id"
  end
  # verify the required parameter 'row_id' is set
  if @api_client.config.client_side_validation && row_id.nil?
    fail ArgumentError, "Missing the required parameter 'row_id' when calling ReferenceTablesAPI.get_rows_by_id"
  end
  # resource path
  local_var_path = '/api/v2/reference-tables/tables/{id}/rows'.sub('{id}', CGI.escape(id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'row_id'] = @api_client.build_collection_param(row_id, :multi)

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

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

  new_options = opts.merge(
    :operation => :get_rows_by_id,
    :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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

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

#get_table(id, opts = {}) ⇒ Object

Get table.

See Also:



300
301
302
303
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 300

def get_table(id, opts = {})
  data, _status_code, _headers = get_table_with_http_info(id, opts)
  data
end

#get_table_with_http_info(id, opts = {}) ⇒ Array<(TableResultV2, Integer, Hash)>

Get table.

Get a reference table by ID

Parameters:

  • id (String) —

    The ID of the reference table to retrieve

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

    the optional parameters

Returns:

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

    TableResultV2 data, response status code and response headers



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
358
359
360
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 312

def get_table_with_http_info(id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReferenceTablesAPI.get_table ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ReferenceTablesAPI.get_table"
  end
  # resource path
  local_var_path = '/api/v2/reference-tables/tables/{id}'.sub('{id}', CGI.escape(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] || 'TableResultV2'

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

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

#list_tables(opts = {}) ⇒ Object

List tables.

See Also:



365
366
367
368
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 365

def list_tables(opts = {})
  data, _status_code, _headers = list_tables_with_http_info(opts)
  data
end

#list_tables_with_http_info(opts = {}) ⇒ Array<(TableResultV2Array, Integer, Hash)>

List tables.

List all reference tables in this organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of tables to return.

  • :offset (Integer) —

    Number of tables to skip for pagination.

  • :sort (ReferenceTableSortType) —

    Sort field and direction. Use field name for ascending, prefix with "-" for descending.

  • :filter_status (String) —

    Filter by table status.

  • :filter_table_name_exact (String) —

    Filter by exact table name match.

  • :filter_table_name_contains (String) —

    Filter by table name containing substring.

Returns:

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

    TableResultV2Array data, response status code and response headers



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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 382

def list_tables_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReferenceTablesAPI.list_tables ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ReferenceTablesAPI.list_tables, must be smaller than or equal to 100.'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ReferenceTablesAPI.list_tables, must be greater than or equal to 1.'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ReferenceTablesAPI.list_tables, must be greater than or equal to 0.'
  end
  allowable_values = ['updated_at', 'table_name', 'status', '-updated_at', '-table_name', '-status']
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/reference-tables/tables'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'filter[table_name][exact]'] = opts[:'filter_table_name_exact'] if !opts[:'filter_table_name_exact'].nil?
  query_params[:'filter[table_name][contains]'] = opts[:'filter_table_name_contains'] if !opts[:'filter_table_name_contains'].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] || 'TableResultV2Array'

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

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

#update_reference_table(id, body, opts = {}) ⇒ Object

Update reference table.

See Also:



450
451
452
453
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 450

def update_reference_table(id, body, opts = {})
  update_reference_table_with_http_info(id, body, opts)
  nil
end

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

Update reference table.

Update a reference table by ID. You can update the table's data, description, and tags. Note: The source type cannot be changed after table creation. For data updates: For existing tables of type source:LOCAL_FILE, call POST api/v2/reference-tables/uploads first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this PATCH endpoint with the upload_id in file_metadata. For existing tables with source: types of S3, GCS, or AZURE, provide updated access_details in file_metadata pointing to a CSV file in the same type of cloud storage.

Parameters:

  • id (String) —

    The ID of the reference table to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



463
464
465
466
467
468
469
470
471
472
473
474
475
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
 
# File 'lib/datadog_api_client/v2/api/reference_tables_api.rb', line 463

def update_reference_table_with_http_info(id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReferenceTablesAPI.update_reference_table ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ReferenceTablesAPI.update_reference_table"
  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 ReferenceTablesAPI.update_reference_table"
  end
  # resource path
  local_var_path = '/api/v2/reference-tables/tables/{id}'.sub('{id}', CGI.escape(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(['*/*'])
  # 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, :AuthZ]

  new_options = opts.merge(
    :operation => :update_reference_table,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReferenceTablesAPI#update_reference_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end