@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class ReferenceTablesApi extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
ReferenceTablesApi.ListReferenceTableRowsOptionalParameters
Manage optional parameters to listReferenceTableRows.
|
static class |
ReferenceTablesApi.ListTablesOptionalParameters
Manage optional parameters to listTables.
|
| Constructor and Description |
|---|
ReferenceTablesApi() |
ReferenceTablesApi(ApiClient apiClient) |
public ReferenceTablesApi()
public ReferenceTablesApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
apiClient - an instance of API clientpublic BatchRowsQueryResponse batchRowsQuery(BatchRowsQueryRequest body) throws ApiException
See batchRowsQueryWithHttpInfo(com.datadog.api.client.v2.model.BatchRowsQueryRequest).
body - (required)ApiException - if fails to make API callpublic CompletableFuture<BatchRowsQueryResponse> batchRowsQueryAsync(BatchRowsQueryRequest body)
See batchRowsQueryWithHttpInfoAsync(com.datadog.api.client.v2.model.BatchRowsQueryRequest).
body - (required)public ApiResponse<BatchRowsQueryResponse> batchRowsQueryWithHttpInfo(BatchRowsQueryRequest body) throws ApiException
body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Successfully retrieved rows. Some or all requested rows were found. Response includes found rows in the included section. | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
| 500 | Internal Server Error | - |
public CompletableFuture<ApiResponse<BatchRowsQueryResponse>> batchRowsQueryWithHttpInfoAsync(BatchRowsQueryRequest body)
See batchRowsQueryWithHttpInfo(com.datadog.api.client.v2.model.BatchRowsQueryRequest).
body - (required)public TableResultV2 createReferenceTable(CreateTableRequest body) throws ApiException
See createReferenceTableWithHttpInfo(com.datadog.api.client.v2.model.CreateTableRequest).
body - (required)ApiException - if fails to make API callpublic CompletableFuture<TableResultV2> createReferenceTableAsync(CreateTableRequest body)
See createReferenceTableWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateTableRequest).
body - (required)public ApiResponse<TableResultV2> createReferenceTableWithHttpInfo(CreateTableRequest body) throws ApiException
upload_id in file_metadata. 2. Provide access_details in
file_metadata pointing to a CSV file in cloud storage.body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 201 | Created | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<TableResultV2>> createReferenceTableWithHttpInfoAsync(CreateTableRequest body)
See createReferenceTableWithHttpInfo(com.datadog.api.client.v2.model.CreateTableRequest).
body - (required)public CreateUploadResponse createReferenceTableUpload(CreateUploadRequest body) throws ApiException
See createReferenceTableUploadWithHttpInfo(com.datadog.api.client.v2.model.CreateUploadRequest).
body - (required)ApiException - if fails to make API callpublic CompletableFuture<CreateUploadResponse> createReferenceTableUploadAsync(CreateUploadRequest body)
See createReferenceTableUploadWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateUploadRequest).
body - (required)public ApiResponse<CreateUploadResponse> createReferenceTableUploadWithHttpInfo(CreateUploadRequest body) throws ApiException
body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 201 | Created | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<CreateUploadResponse>> createReferenceTableUploadWithHttpInfoAsync(CreateUploadRequest body)
See createReferenceTableUploadWithHttpInfo(com.datadog.api.client.v2.model.CreateUploadRequest).
body - (required)public void deleteRows(String id, BatchDeleteRowsRequestArray body) throws ApiException
id - Unique identifier of the reference table to delete rows from (required)body - (required)ApiException - if fails to make API callpublic CompletableFuture<Void> deleteRowsAsync(String id, BatchDeleteRowsRequestArray body)
id - Unique identifier of the reference table to delete rows from (required)body - (required)public ApiResponse<Void> deleteRowsWithHttpInfo(String id, BatchDeleteRowsRequestArray body) throws ApiException
id - Unique identifier of the reference table to delete rows from (required)body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Rows deleted successfully | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
| 500 | Internal Server Error | - |
public CompletableFuture<ApiResponse<Void>> deleteRowsWithHttpInfoAsync(String id, BatchDeleteRowsRequestArray body)
id - Unique identifier of the reference table to delete rows from (required)body - (required)public void deleteTable(String id) throws ApiException
id - Unique identifier of the reference table to delete (required)ApiException - if fails to make API callpublic CompletableFuture<Void> deleteTableAsync(String id)
id - Unique identifier of the reference table to delete (required)public ApiResponse<Void> deleteTableWithHttpInfo(String id) throws ApiException
id - Unique identifier of the reference table to delete (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<Void>> deleteTableWithHttpInfoAsync(String id)
id - Unique identifier of the reference table to delete (required)public TableRowResourceArray getRowsByID(String id, List<String> rowId) throws ApiException
See getRowsByIDWithHttpInfo(java.lang.String, java.util.List<java.lang.String>).
id - Unique identifier of the reference table to get rows from (required)rowId - List of row IDs (primary key values) to retrieve from the reference table.
(required)ApiException - if fails to make API callpublic CompletableFuture<TableRowResourceArray> getRowsByIDAsync(String id, List<String> rowId)
See getRowsByIDWithHttpInfoAsync(java.lang.String, java.util.List<java.lang.String>).
id - Unique identifier of the reference table to get rows from (required)rowId - List of row IDs (primary key values) to retrieve from the reference table.
(required)public ApiResponse<TableRowResourceArray> getRowsByIDWithHttpInfo(String id, List<String> rowId) throws ApiException
id - Unique identifier of the reference table to get rows from (required)rowId - List of row IDs (primary key values) to retrieve from the reference table.
(required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Some or all requested rows were found. | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<TableRowResourceArray>> getRowsByIDWithHttpInfoAsync(String id, List<String> rowId)
See getRowsByIDWithHttpInfo(java.lang.String, java.util.List<java.lang.String>).
id - Unique identifier of the reference table to get rows from (required)rowId - List of row IDs (primary key values) to retrieve from the reference table.
(required)public TableResultV2 getTable(String id) throws ApiException
id - Unique identifier of the reference table to retrieve (required)ApiException - if fails to make API callpublic CompletableFuture<TableResultV2> getTableAsync(String id)
id - Unique identifier of the reference table to retrieve (required)public ApiResponse<TableResultV2> getTableWithHttpInfo(String id) throws ApiException
id - Unique identifier of the reference table to retrieve (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<TableResultV2>> getTableWithHttpInfoAsync(String id)
id - Unique identifier of the reference table to retrieve (required)public ListRowsResponse listReferenceTableRows(String id) throws ApiException
id - Unique identifier of the reference table to list rows from. (required)ApiException - if fails to make API callpublic CompletableFuture<ListRowsResponse> listReferenceTableRowsAsync(String id)
id - Unique identifier of the reference table to list rows from. (required)public ListRowsResponse listReferenceTableRows(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) throws ApiException
id - Unique identifier of the reference table to list rows from. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<ListRowsResponse> listReferenceTableRowsAsync(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters)
id - Unique identifier of the reference table to list rows from. (required)parameters - Optional parameters for the request.public ApiResponse<ListRowsResponse> listReferenceTableRowsWithHttpInfo(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) throws ApiException
page[continuation_token] from the previous response to fetch the next page on the same
consistent snapshot. Returns 400 for tables with more than 10,000,000 rows.id - Unique identifier of the reference table to list rows from. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<ListRowsResponse>> listReferenceTableRowsWithHttpInfoAsync(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters)
id - Unique identifier of the reference table to list rows from. (required)parameters - Optional parameters for the request.public TableResultV2Array listTables() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<TableResultV2Array> listTablesAsync()
public TableResultV2Array listTables(ReferenceTablesApi.ListTablesOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<TableResultV2Array> listTablesAsync(ReferenceTablesApi.ListTablesOptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<TableResultV2Array> listTablesWithHttpInfo(ReferenceTablesApi.ListTablesOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<TableResultV2Array>> listTablesWithHttpInfoAsync(ReferenceTablesApi.ListTablesOptionalParameters parameters)
parameters - Optional parameters for the request.public void updateReferenceTable(String id, PatchTableRequest body) throws ApiException
id - Unique identifier of the reference table to update (required)body - (required)ApiException - if fails to make API callpublic CompletableFuture<Void> updateReferenceTableAsync(String id, PatchTableRequest body)
id - Unique identifier of the reference table to update (required)body - (required)public ApiResponse<Void> updateReferenceTableWithHttpInfo(String id, PatchTableRequest body) throws ApiException
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.id - Unique identifier of the reference table to update (required)body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<Void>> updateReferenceTableWithHttpInfoAsync(String id, PatchTableRequest body)
id - Unique identifier of the reference table to update (required)body - (required)public void upsertRows(String id, BatchUpsertRowsRequestArray body) throws ApiException
id - Unique identifier of the reference table to upsert rows into (required)body - (required)ApiException - if fails to make API callpublic CompletableFuture<Void> upsertRowsAsync(String id, BatchUpsertRowsRequestArray body)
id - Unique identifier of the reference table to upsert rows into (required)body - (required)public ApiResponse<Void> upsertRowsWithHttpInfo(String id, BatchUpsertRowsRequestArray body) throws ApiException
id - Unique identifier of the reference table to upsert rows into (required)body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Rows created or updated successfully | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
| 500 | Internal Server Error | - |
public CompletableFuture<ApiResponse<Void>> upsertRowsWithHttpInfoAsync(String id, BatchUpsertRowsRequestArray body)
id - Unique identifier of the reference table to upsert rows into (required)body - (required)Copyright © 2026. All rights reserved.