LeaseCandidateSpec

data class LeaseCandidateSpec(val binaryVersion: String, val emulationVersion: String? = null, val leaseName: String, val pingTime: String? = null, val renewTime: String? = null, val strategy: String)

LeaseCandidateSpec is a specification of a Lease.

Constructors

Link copied to clipboard
constructor(binaryVersion: String, emulationVersion: String? = null, leaseName: String, pingTime: String? = null, renewTime: String? = null, strategy: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

BinaryVersion is the binary version. It must be in a semver format without leading v. This field is required.

Link copied to clipboard

EmulationVersion is the emulation version. It must be in a semver format without leading v. EmulationVersion must be less than or equal to BinaryVersion. This field is required when strategy is "OldestEmulationVersion"

Link copied to clipboard

LeaseName is the name of the lease for which this candidate is contending. This field is immutable.

Link copied to clipboard
val pingTime: String? = null

PingTime is the last time that the server has requested the LeaseCandidate to renew. It is only done during leader election to check if any LeaseCandidates have become ineligible. When PingTime is updated, the LeaseCandidate will respond by updating RenewTime.

Link copied to clipboard
val renewTime: String? = null

RenewTime is the time that the LeaseCandidate was last updated. Any time a Lease needs to do leader election, the PingTime field is updated to signal to the LeaseCandidate that they should update the RenewTime. Old LeaseCandidate objects are also garbage collected if it has been hours since the last renew. The PingTime field is updated regularly to prevent garbage collection for still active LeaseCandidates.

Link copied to clipboard

Strategy is the strategy that coordinated leader election will use for picking the leader. If multiple candidates for the same Lease return different strategies, the strategy provided by the candidate with the latest BinaryVersion will be used. If there is still conflict, this is a user error and coordinated leader election will not operate the Lease until resolved. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled.