Struct LeaseCandidateSpec

pub struct LeaseCandidateSpec {
    pub binary_version: String,
    pub emulation_version: Option<String>,
    pub lease_name: String,
    pub ping_time: Option<MicroTime>,
    pub renew_time: Option<MicroTime>,
    pub strategy: String,
}

LeaseCandidateSpec is a specification of a Lease.

Fields

binary_version: String

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

emulation_version: Option<String>

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”

lease_name: String

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

ping_time: Option<MicroTime>

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.

renew_time: Option<MicroTime>

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.

strategy: String

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.

Trait Implementations

impl Clone for LeaseCandidateSpec

fn clone(&self) -> LeaseCandidateSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LeaseCandidateSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeepMerge for LeaseCandidateSpec

fn merge_from(&mut self, other: Self)

Merge other into self.

impl Default for LeaseCandidateSpec

fn default() -> LeaseCandidateSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LeaseCandidateSpec

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LeaseCandidateSpec

fn eq(&self, other: &LeaseCandidateSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LeaseCandidateSpec

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LeaseCandidateSpec