Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.model/ServiceSpecRollbackConfig

ServiceSpecRollbackConfig

@Serializable

data class ServiceSpecRollbackConfig(val parallelism: Long? = null, val delay: Long? = null, val failureAction: ServiceSpecRollbackConfig.FailureAction? = null, val monitor: Long? = null, val maxFailureRatio: Double? = null, val order: ServiceSpecRollbackConfig.Order? = null)

Specification for the rollback strategy of the service.

Parameters

parallelism

Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism).

delay

Amount of time between rollback iterations, in nanoseconds.

failureAction

Action to take if an rolled back task fails to run, or stops running during the rollback.

monitor

Amount of time to monitor each rolled back task for failures, in nanoseconds.

maxFailureRatio

The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1.

order

The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.

Constructors

ServiceSpecRollbackConfig

constructor(parallelism: Long? = null, delay: Long? = null, failureAction: ServiceSpecRollbackConfig.FailureAction? = null, monitor: Long? = null, maxFailureRatio: Double? = null, order: ServiceSpecRollbackConfig.Order? = null)

Types

FailureAction

@Serializable

enum FailureAction : Enum<ServiceSpecRollbackConfig.FailureAction>

Action to take if an rolled back task fails to run, or stops running during the rollback.

Order

@Serializable

enum Order : Enum<ServiceSpecRollbackConfig.Order>

The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.