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

DepotApi

interface DepotApi

Represents an API for interacting with depot.

Functions

Link copied to clipboard
@PUT(value = "api/v2/depots/{depot}/owners/{owner}")
abstract fun addOwner(@Path(value = "depot") depotString: String, @Path(value = "owner") owner: String, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<DepotResponse>

Adds an owner to the specified depot.

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/archived")
abstract fun archive(@Path(value = "depot") depotString: String, @Body request: DepotFlagRequest, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<DepotResponse>

Makes a PATCH request to archive a depot.

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

Makes a POST request to create or update a depot.

Link copied to clipboard
@DELETE(value = "api/v2/depots/{depot}/meta")
abstract fun deleteMeta(@Path(value = "depot") depotString: String, @Query(value = "key") keys: String, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Deletes metadata for the specified depot.

Link copied to clipboard
@DELETE(value = "api/v2/depots/{depot}/owners/{owner}")
abstract fun endOwnership(@Path(value = "depot") depotString: String, @Path(value = "owner") owner: String, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Ends ownership of the specified depot for the specified owner.

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

Retrieves the list of collections for the specified depot.

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

Makes a GET request to retrieve a specific depot.

Link copied to clipboard
@GET(value = "api/v2/depots")
abstract fun getDepots(@Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<DepotResponse>
@GET(value = "api/v2/depots")
abstract fun getDepots(@Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString(), @QueryMap queryMap: Map<String, Any> = mapOf()): Call<DepotResponse>

Makes a GET request to retrieve a list of depots.

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

Retrieves the metadata for the specified depot.

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

Retrieves the list of owners for the specified depot.

Link copied to clipboard
@PATCH(value = "api/v2/depots/{depot}/meta")
abstract fun updateMeta(@Path(value = "depot") depotString: String, @Body metaRequest: Map<String, Any>, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<DepotResponse>

Makes a PATCH request to update the metadata of a depot.