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

DatasetApi

interface DatasetApi

Represents an API for interacting with datasets.

Functions

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/fields")
abstract fun addField(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Body request: FieldRequest,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Adds a field to a dataset.

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/properties")
abstract fun addMetadataProperties(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Body properties: Map<String, String>,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Adds metadata properties to a dataset.

Link copied to clipboard
@POST(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}")
abstract fun createDataset(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Body request: DatasetRequest,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Creates a new dataset.

Link copied to clipboard
@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.

Link copied to clipboard
@DELETE(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/fields/{field}")
abstract fun dropField(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Path(value = "field") field: String,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Drops a field from a dataset.

Link copied to clipboard
@GET(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}")
abstract fun fetchDataset(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<DatasetResponse>

Fetches a dataset.

Link copied to clipboard
@GET(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/schema")
abstract fun getDatasetSchema(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<String>

Retrieves the schema of a dataset.

Link copied to clipboard
@GET(value = "api/v2/depots/{depot}/collections/{collection}/datasets")
abstract fun listDataset(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<List<String>>

Lists datasets in a collection.

Link copied to clipboard
@GET(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/metadata")
abstract fun listMetadataVersions(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Iterable<MetadataVersionResponse>>

Retrieves the list of metadata versions for a dataset.

Link copied to clipboard
@GET(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/properties")
abstract fun listProperties(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Map<String, String>>

Retrieves the list of properties for a dataset.

Link copied to clipboard
@GET(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/snapshots")
abstract fun listTableSnapshots(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Iterable<SnapshotResponse>>

Retrieves the list of table snapshots for a dataset.

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/fields/{field}/nullable/{nullable}")
abstract fun nullableField(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Path(value = "field") field: String,     @Path(value = "nullable") nullable: Boolean,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Sets the nullability of a field in a dataset.

Link copied to clipboard
@HTTP(method = "DELETE", path = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/properties", hasBody = true)
abstract fun removeProperties(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Body properties: List<String>,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Removes metadata properties from a dataset.

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/fields/{field}/rename")
abstract fun renameField(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Path(value = "field") field: String,     @Body request: FieldRenameRequest,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Renames a field in a dataset.

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/metadata/{version}")
abstract fun setMetadataVersion(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Path(value = "version") version: String,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Sets the metadata version for a dataset.

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/snapshots/{id}")
abstract fun setSnapshot(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Path(value = "id") id: Long,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Sets a snapshot for a dataset.

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/fields/{field}/update")
abstract fun updateField(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Path(value = "field") field: String,     @Body request: FieldUpdateRequest,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Updates a field in a dataset.

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/partitions")
abstract fun updatePartition(    @Path(value = "depot") depot: String,     @Path(value = "collection") collection: String,     @Path(value = "dataset") dataset: String,     @Body request: String,     @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Updates partitions for a dataset.