core/karya.core.entities/Plan

Plan

@Serializable

data class Plan(val id: UUID, val userId: UUID, val description: String, val periodTime: String, val type: PlanType, val status: PlanStatus, val maxFailureRetry: Int, val action: Action, val hook: List<Hook>, val parentPlanId: UUID?, val createdAt: Long, val updatedAt: Long)

Data class representing a plan.

Constructors

constructor(id: UUID, userId: UUID, description: String, periodTime: String, type: PlanType, status: PlanStatus, maxFailureRetry: Int, action: Action, hook: List<Hook>, parentPlanId: UUID?, createdAt: Long, updatedAt: Long)

Properties

val action: Action

The action associated with the plan.

val createdAt: Long

The timestamp when the plan was created.

val description: String

A brief description of the plan.

val hook: List<Hook>

The list of hooks associated with the plan.

@Serializable(with = UUIDSerializer::class)

val id: UUID

The unique identifier of the plan.

maxFailureRetry

val maxFailureRetry: Int

The maximum number of retries on failure.

@Serializable(with = UUIDSerializer::class)

val parentPlanId: UUID?

The unique identifier of the parent plan, if any.

val periodTime: String

The period time for the plan.

val status: PlanStatus

The current status of the plan.

val type: PlanType

The type of the plan.

val updatedAt: Long

The timestamp when the plan was last updated.

@Serializable(with = UUIDSerializer::class)

val userId: UUID

The unique identifier of the user associated with the plan.

Functions

fun update(request: UpdatePlanRequest): Plan

Updates the current plan with the provided update request.