Class ReferenceTablesApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to listReferenceTableRows.static classManage optional parameters to listTables. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionBatch rows query.Batch rows query.Batch query reference table rows by their primary key values.Batch rows query.Create reference table.Create reference table.Create reference table upload.Create reference table upload.Create a reference table upload for bulk data ingestionCreate reference table upload.Creates a reference table.Create reference table.voiddeleteRows(String id, BatchDeleteRowsRequestArray body) Delete rows.deleteRowsAsync(String id, BatchDeleteRowsRequestArray body) Delete rows.Delete multiple rows from a Reference Table by their primary key values.Delete rows.voiddeleteTable(String id) Delete table.Delete table.Delete a reference table by IDDelete table.Get the API client.getRowsByID(String id, List<String> rowId) Get rows by id.getRowsByIDAsync(String id, List<String> rowId) Get rows by id.getRowsByIDWithHttpInfo(String id, List<String> rowId) Get reference table rows by their primary key values.getRowsByIDWithHttpInfoAsync(String id, List<String> rowId) Get rows by id.Get table.getTableAsync(String id) Get table.Get a reference table by IDGet table.List rows.listReferenceTableRows(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) List rows.List rows.listReferenceTableRowsAsync(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) List rows.listReferenceTableRowsWithHttpInfo(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) List all rows in a reference table using cursor-based pagination.listReferenceTableRowsWithHttpInfoAsync(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) List rows.List tables.List tables.List tables.List tables.List all reference tables in this organization.List tables.voidsetApiClient(ApiClient apiClient) Set the API client.voidupdateReferenceTable(String id, PatchTableRequest body) Update reference table.updateReferenceTableAsync(String id, PatchTableRequest body) Update reference table.Update a reference table by ID.Update reference table.voidupsertRows(String id, BatchUpsertRowsRequestArray body) Upsert rows.upsertRowsAsync(String id, BatchUpsertRowsRequestArray body) Upsert rows.Create or update rows in a Reference Table by their primary key values.Upsert rows.
-
Constructor Details
-
ReferenceTablesApi
public ReferenceTablesApi() -
ReferenceTablesApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
batchRowsQuery
Batch rows query.See
batchRowsQueryWithHttpInfo(com.datadog.api.client.v2.model.BatchRowsQueryRequest).- Parameters:
body- (required)- Returns:
- BatchRowsQueryResponse
- Throws:
ApiException- if fails to make API call
-
batchRowsQueryAsync
Batch rows query.See
batchRowsQueryWithHttpInfoAsync(com.datadog.api.client.v2.model.BatchRowsQueryRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<BatchRowsQueryResponse>
-
batchRowsQueryWithHttpInfo
public ApiResponse<BatchRowsQueryResponse> batchRowsQueryWithHttpInfo(BatchRowsQueryRequest body) throws ApiException Batch query reference table rows by their primary key values. Returns only found rows in the included array.- Parameters:
body- (required)- Returns:
- ApiResponse<BatchRowsQueryResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details 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 -
-
batchRowsQueryWithHttpInfoAsync
public CompletableFuture<ApiResponse<BatchRowsQueryResponse>> batchRowsQueryWithHttpInfoAsync(BatchRowsQueryRequest body) Batch rows query.See
batchRowsQueryWithHttpInfo(com.datadog.api.client.v2.model.BatchRowsQueryRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<BatchRowsQueryResponse>>
-
createReferenceTable
Create reference table.See
createReferenceTableWithHttpInfo(com.datadog.api.client.v2.model.CreateTableRequest).- Parameters:
body- (required)- Returns:
- TableResultV2
- Throws:
ApiException- if fails to make API call
-
createReferenceTableAsync
Create reference table.See
createReferenceTableWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateTableRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<TableResultV2>
-
createReferenceTableWithHttpInfo
public ApiResponse<TableResultV2> createReferenceTableWithHttpInfo(CreateTableRequest body) throws ApiException Creates a reference table. You can provide data in two ways: 1. Call POST /api/v2/reference-tables/upload to get an upload ID. Then, PUT the CSV data (not the file itself) in chunks to each URL in the request body. Finally, call this POST endpoint withupload_idinfile_metadata. 2. Provideaccess_detailsinfile_metadatapointing to a CSV file in cloud storage.- Parameters:
body- (required)- Returns:
- ApiResponse<TableResultV2>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 201 Created - 400 Bad Request - 403 Forbidden - 429 Too many requests -
-
createReferenceTableWithHttpInfoAsync
public CompletableFuture<ApiResponse<TableResultV2>> createReferenceTableWithHttpInfoAsync(CreateTableRequest body) Create reference table.See
createReferenceTableWithHttpInfo(com.datadog.api.client.v2.model.CreateTableRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<TableResultV2>>
-
createReferenceTableUpload
public CreateUploadResponse createReferenceTableUpload(CreateUploadRequest body) throws ApiException Create reference table upload.See
createReferenceTableUploadWithHttpInfo(com.datadog.api.client.v2.model.CreateUploadRequest).- Parameters:
body- (required)- Returns:
- CreateUploadResponse
- Throws:
ApiException- if fails to make API call
-
createReferenceTableUploadAsync
public CompletableFuture<CreateUploadResponse> createReferenceTableUploadAsync(CreateUploadRequest body) Create reference table upload.See
createReferenceTableUploadWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateUploadRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<CreateUploadResponse>
-
createReferenceTableUploadWithHttpInfo
public ApiResponse<CreateUploadResponse> createReferenceTableUploadWithHttpInfo(CreateUploadRequest body) throws ApiException Create a reference table upload for bulk data ingestion- Parameters:
body- (required)- Returns:
- ApiResponse<CreateUploadResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 201 Created - 400 Bad Request - 403 Forbidden - 429 Too many requests -
-
createReferenceTableUploadWithHttpInfoAsync
public CompletableFuture<ApiResponse<CreateUploadResponse>> createReferenceTableUploadWithHttpInfoAsync(CreateUploadRequest body) Create reference table upload.See
createReferenceTableUploadWithHttpInfo(com.datadog.api.client.v2.model.CreateUploadRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<CreateUploadResponse>>
-
deleteRows
Delete rows.- Parameters:
id- Unique identifier of the reference table to delete rows from (required)body- (required)- Throws:
ApiException- if fails to make API call
-
deleteRowsAsync
Delete rows.- Parameters:
id- Unique identifier of the reference table to delete rows from (required)body- (required)- Returns:
- CompletableFuture
-
deleteRowsWithHttpInfo
public ApiResponse<Void> deleteRowsWithHttpInfo(String id, BatchDeleteRowsRequestArray body) throws ApiException Delete multiple rows from a Reference Table by their primary key values.- Parameters:
id- Unique identifier of the reference table to delete rows from (required)body- (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 Rows deleted successfully - 400 Bad Request - 403 Forbidden - 404 Not Found - 409 Conflict - 412 Precondition Failed - 429 Too many requests - 500 Internal Server Error -
-
deleteRowsWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> deleteRowsWithHttpInfoAsync(String id, BatchDeleteRowsRequestArray body) Delete rows.- Parameters:
id- Unique identifier of the reference table to delete rows from (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
deleteTable
Delete table.- Parameters:
id- Unique identifier of the reference table to delete (required)- Throws:
ApiException- if fails to make API call
-
deleteTableAsync
Delete table.- Parameters:
id- Unique identifier of the reference table to delete (required)- Returns:
- CompletableFuture
-
deleteTableWithHttpInfo
Delete a reference table by ID- Parameters:
id- Unique identifier of the reference table to delete (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
deleteTableWithHttpInfoAsync
Delete table.- Parameters:
id- Unique identifier of the reference table to delete (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
getRowsByID
Get rows by id.See
getRowsByIDWithHttpInfo(java.lang.String, java.util.List<java.lang.String>).- Parameters:
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)- Returns:
- TableRowResourceArray
- Throws:
ApiException- if fails to make API call
-
getRowsByIDAsync
Get rows by id.See
getRowsByIDWithHttpInfoAsync(java.lang.String, java.util.List<java.lang.String>).- Parameters:
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)- Returns:
- CompletableFuture<TableRowResourceArray>
-
getRowsByIDWithHttpInfo
public ApiResponse<TableRowResourceArray> getRowsByIDWithHttpInfo(String id, List<String> rowId) throws ApiException Get reference table rows by their primary key values.- Parameters:
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)- Returns:
- ApiResponse<TableRowResourceArray>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 Some or all requested rows were found. - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
getRowsByIDWithHttpInfoAsync
public CompletableFuture<ApiResponse<TableRowResourceArray>> getRowsByIDWithHttpInfoAsync(String id, List<String> rowId) Get rows by id.See
getRowsByIDWithHttpInfo(java.lang.String, java.util.List<java.lang.String>).- Parameters:
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)- Returns:
- CompletableFuture<ApiResponse<TableRowResourceArray>>
-
getTable
Get table.- Parameters:
id- Unique identifier of the reference table to retrieve (required)- Returns:
- TableResultV2
- Throws:
ApiException- if fails to make API call
-
getTableAsync
Get table.- Parameters:
id- Unique identifier of the reference table to retrieve (required)- Returns:
- CompletableFuture<TableResultV2>
-
getTableWithHttpInfo
Get a reference table by ID- Parameters:
id- Unique identifier of the reference table to retrieve (required)- Returns:
- ApiResponse<TableResultV2>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
getTableWithHttpInfoAsync
Get table.- Parameters:
id- Unique identifier of the reference table to retrieve (required)- Returns:
- CompletableFuture<ApiResponse<TableResultV2>>
-
listReferenceTableRows
List rows.- Parameters:
id- Unique identifier of the reference table to list rows from. (required)- Returns:
- ListRowsResponse
- Throws:
ApiException- if fails to make API call
-
listReferenceTableRowsAsync
- Parameters:
id- Unique identifier of the reference table to list rows from. (required)- Returns:
- CompletableFuture<ListRowsResponse>
-
listReferenceTableRows
public ListRowsResponse listReferenceTableRows(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) throws ApiException List rows.- Parameters:
id- Unique identifier of the reference table to list rows from. (required)parameters- Optional parameters for the request.- Returns:
- ListRowsResponse
- Throws:
ApiException- if fails to make API call
-
listReferenceTableRowsAsync
public CompletableFuture<ListRowsResponse> listReferenceTableRowsAsync(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) - Parameters:
id- Unique identifier of the reference table to list rows from. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ListRowsResponse>
-
listReferenceTableRowsWithHttpInfo
public ApiResponse<ListRowsResponse> listReferenceTableRowsWithHttpInfo(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) throws ApiException List all rows in a reference table using cursor-based pagination. Pass thepage[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.- Parameters:
id- Unique identifier of the reference table to list rows from. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<ListRowsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
listReferenceTableRowsWithHttpInfoAsync
public CompletableFuture<ApiResponse<ListRowsResponse>> listReferenceTableRowsWithHttpInfoAsync(String id, ReferenceTablesApi.ListReferenceTableRowsOptionalParameters parameters) List rows.- Parameters:
id- Unique identifier of the reference table to list rows from. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<ListRowsResponse>>
-
listTables
List tables.- Returns:
- TableResultV2Array
- Throws:
ApiException- if fails to make API call
-
listTablesAsync
List tables.- Returns:
- CompletableFuture<TableResultV2Array>
-
listTables
public TableResultV2Array listTables(ReferenceTablesApi.ListTablesOptionalParameters parameters) throws ApiException List tables.- Parameters:
parameters- Optional parameters for the request.- Returns:
- TableResultV2Array
- Throws:
ApiException- if fails to make API call
-
listTablesAsync
public CompletableFuture<TableResultV2Array> listTablesAsync(ReferenceTablesApi.ListTablesOptionalParameters parameters) List tables.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<TableResultV2Array>
-
listTablesWithHttpInfo
public ApiResponse<TableResultV2Array> listTablesWithHttpInfo(ReferenceTablesApi.ListTablesOptionalParameters parameters) throws ApiException List all reference tables in this organization.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<TableResultV2Array>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 429 Too many requests -
-
listTablesWithHttpInfoAsync
public CompletableFuture<ApiResponse<TableResultV2Array>> listTablesWithHttpInfoAsync(ReferenceTablesApi.ListTablesOptionalParameters parameters) List tables.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<TableResultV2Array>>
-
updateReferenceTable
Update reference table.- Parameters:
id- Unique identifier of the reference table to update (required)body- (required)- Throws:
ApiException- if fails to make API call
-
updateReferenceTableAsync
Update reference table.- Parameters:
id- Unique identifier of the reference table to update (required)body- (required)- Returns:
- CompletableFuture
-
updateReferenceTableWithHttpInfo
public ApiResponse<Void> updateReferenceTableWithHttpInfo(String id, PatchTableRequest body) throws ApiException 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 typesource: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 withsource:types ofS3,GCS, orAZURE, provide updated access_details in file_metadata pointing to a CSV file in the same type of cloud storage.- Parameters:
id- Unique identifier of the reference table to update (required)body- (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Forbidden - 429 Too many requests -
-
updateReferenceTableWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> updateReferenceTableWithHttpInfoAsync(String id, PatchTableRequest body) Update reference table.- Parameters:
id- Unique identifier of the reference table to update (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
upsertRows
Upsert rows.- Parameters:
id- Unique identifier of the reference table to upsert rows into (required)body- (required)- Throws:
ApiException- if fails to make API call
-
upsertRowsAsync
Upsert rows.- Parameters:
id- Unique identifier of the reference table to upsert rows into (required)body- (required)- Returns:
- CompletableFuture
-
upsertRowsWithHttpInfo
public ApiResponse<Void> upsertRowsWithHttpInfo(String id, BatchUpsertRowsRequestArray body) throws ApiException Create or update rows in a Reference Table by their primary key values. If a row with the specified primary key exists, it is updated; otherwise, a new row is created.- Parameters:
id- Unique identifier of the reference table to upsert rows into (required)body- (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 Rows created or updated successfully - 400 Bad Request - 403 Forbidden - 404 Not Found - 409 Conflict - 412 Precondition Failed - 429 Too many requests - 500 Internal Server Error -
-
upsertRowsWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> upsertRowsWithHttpInfoAsync(String id, BatchUpsertRowsRequestArray body) Upsert rows.- Parameters:
id- Unique identifier of the reference table to upsert rows into (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-