StableObservationOptionsBuilder
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:91
Fluent builder for StableObservationOptionsType.
const observationOptions = StableObservationOptions.create() .withSeedProvider(seedProvider) .withSelfAddress(selfAddress) .withRequiredContactPoints(3);const observation = new StableObservation(observationOptions);Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new StableObservationOptionsBuilder():
StableObservationOptionsBuilder
Returns
Section titled “Returns”StableObservationOptionsBuilder
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”build()
Section titled “build()”build():
Partial<T>
Defined in: src/util/OptionsBuilder.ts:51
Snapshot the set fields as an independent Partial<T> (own props only).
Returns
Section titled “Returns”Partial<T>
Inherited from
Section titled “Inherited from”withLog()
Section titled “withLog()”withLog(
log):this
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:133
Where progress and reset lines go. Default: discarded.
Parameters
Section titled “Parameters”(message) => void
Returns
Section titled “Returns”this
withMaxWaitMs()
Section titled “withMaxWaitMs()”withMaxWaitMs(
ms):this
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:118
Total budget before the observation throws. Default: 60 000 ms.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
withPollIntervalMs()
Section titled “withPollIntervalMs()”withPollIntervalMs(
ms):this
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:113
Cadence of the lookup() polls. Default: 1 000 ms.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
withRequiredContactPoints()
Section titled “withRequiredContactPoints()”withRequiredContactPoints(
count):this
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:123
Fewest contact points a stable observation may contain. Default: 1.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
withSeedProvider()
Section titled “withSeedProvider()”withSeedProvider(
seedProvider):this
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:98
Where the contact points come from.
Parameters
Section titled “Parameters”seedProvider
Section titled “seedProvider”Returns
Section titled “Returns”this
withSelfAddress()
Section titled “withSelfAddress()”withSelfAddress(
selfAddress):this
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:103
This node’s advertised address — the value the election orders on.
Parameters
Section titled “Parameters”selfAddress
Section titled “selfAddress”Returns
Section titled “Returns”this
withSelfElectionGraceMs()
Section titled “withSelfElectionGraceMs()”withSelfElectionGraceMs(
ms):this
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:128
Grace handed to the elected initial seed. Default: 10 000 ms.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
withStableMarginMs()
Section titled “withStableMarginMs()”withStableMarginMs(
ms):this
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:108
How long the observed set must stay unchanged. Default: 5 000 ms.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate():StableObservationOptionsBuilder
Defined in: src/cluster/bootstrap/StableObservationOptions.ts:93
Start a fresh builder. Equivalent to new StableObservationOptionsBuilder().
Returns
Section titled “Returns”StableObservationOptionsBuilder