depot-service/io.dataos.ds.client.apis/DatasetApi/dropDataset

dropDataset

@DELETE(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}")
abstract fun dropDataset(@Path(value = "depot") depot: String, @Path(value = "collection") collection: String, @Path(value = "dataset") dataset: String, @Query(value = "purge") purge: Boolean, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Drops a dataset.

Return

A Call object with a Void response.

Parameters

depot

The depot name.

collection

The collection name.

dataset

The dataset name.

purge

Flag indicating whether to purge the dataset (optional, defaults to false).

correlationId

The correlation ID header (optional, defaults to a random UUID).