Skip to content

coordination.v1alpha1.leaseCandidateSpec

"LeaseCandidateSpec is a specification of a Lease."

Index

Fields

fn withBinaryVersion

withBinaryVersion(binaryVersion)

"BinaryVersion is the binary version. It must be in a semver format without leading v. This field is required when strategy is \"OldestEmulationVersion\

fn withEmulationVersion

withEmulationVersion(emulationVersion)

"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\

fn withLeaseName

withLeaseName(leaseName)

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

fn withPingTime

withPingTime(pingTime)

"MicroTime is version of Time with microsecond level precision."

fn withPreferredStrategies

withPreferredStrategies(preferredStrategies)

"PreferredStrategies indicates the list of strategies for picking the leader for coordinated leader election. The list is ordered, and the first strategy supersedes all other strategies. The list is used by coordinated leader election to make a decision about the final election strategy. This follows as - If all clients have strategy X as the first element in this list, strategy X will be used. - If a candidate has strategy [X] and another candidate has strategy [Y, X], Y supersedes X and strategy Y\n will be used.\n- If a candidate has strategy [X, Y] and another candidate has strategy [Y, X], this is a user error and leader\n election will not operate the Lease until resolved.\n(Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled."

fn withPreferredStrategiesMixin

withPreferredStrategiesMixin(preferredStrategies)

"PreferredStrategies indicates the list of strategies for picking the leader for coordinated leader election. The list is ordered, and the first strategy supersedes all other strategies. The list is used by coordinated leader election to make a decision about the final election strategy. This follows as - If all clients have strategy X as the first element in this list, strategy X will be used. - If a candidate has strategy [X] and another candidate has strategy [Y, X], Y supersedes X and strategy Y\n will be used.\n- If a candidate has strategy [X, Y] and another candidate has strategy [Y, X], this is a user error and leader\n election will not operate the Lease until resolved.\n(Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled."

Note: This function appends passed data to existing values

fn withRenewTime

withRenewTime(renewTime)

"MicroTime is version of Time with microsecond level precision."