hera/io.dataos.hera.client.apis/ActionApi

ActionApi

interface ActionApi

Defines actions related to the API for performing various operations on actions.

Functions

Link copied to clipboard
@GET(value = "/namespaces/{namespace}/actions/{action}")
abstract fun getAction(@Path(value = "namespace") namespace: Namespace, @Path(value = "action") action: ActionName, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Action>

Retrieves a specific action.

Link copied to clipboard
@GET(value = "/namespaces/{namespace}/actions/{action}/versions/{version}")
abstract fun getActionVersion(@Path(value = "namespace") namespace: String, @Path(value = "action") action: String, @Path(value = "version") version: String, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<ActionVersion>

Retrieves a specific version of an action.

Link copied to clipboard
@GET(value = "/actions")
abstract fun listActionAcrossNamespaces(@Query(value = "parent") parent: String, @Query(value = "type") type: String, @Query(value = "updatedAfterEpoch") updatedAfterEpoch: Long = 0, @Query(value = "limit") limit: Int = 100, @Query(value = "offset") offset: Int = 0, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Retrieves a list of actions across namespaces.

Link copied to clipboard
@GET(value = "/namespaces/{namespace}/actions/{action}/runs")
abstract fun listActionRuns(@Path(value = "namespace") namespace: String, @Path(value = "action") action: String, @Query(value = "updatedAfterEpoch") updatedAfterEpoch: Long? = null, @Query(value = "limit") limit: Int? = null, @Query(value = "offset") offset: Int? = null, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<List<Run>>

Retrieves a list of runs for a specific action.

Link copied to clipboard
@GET(value = "/namespaces/{namespace}/actions")
abstract fun listActions(@Path(value = "namespace") namespace: String, @Query(value = "limit") limit: Int? = null, @Query(value = "offset") offset: Int? = null, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<List<Action>>

Retrieves a list of actions within a namespace.

Link copied to clipboard
@GET(value = "/namespaces/{namespace}/actions/{action}/versions")
abstract fun listActionVersions(@Path(value = "namespace") namespace: String, @Path(value = "action") action: String, @Query(value = "limit") limit: Int, @Query(value = "offset") offset: Int, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<List<ActionVersion>>

Retrieves a list of versions for a specific action.