raft_fleet v0.4.4 RaftFleet.Cluster.State View Source
Link to this section Summary
Functions
Type-aware getter for consensus_groups
Type-aware setter for consensus_groups
Type-aware getter for members_per_leader_node
Type-aware setter for members_per_leader_node
Creates a new instance of RaftFleet.Cluster.State by using the given dict
A variant of new/1
which returns t
or raise if validation fails
Type-aware getter for node_to_purge
Type-aware setter for node_to_purge
Type-aware getter for nodes_per_zone
Type-aware setter for nodes_per_zone
Type-aware getter for recently_removed_consensus_names
Type-aware setter for recently_removed_consensus_names
Type-aware getter for unhealthy_members_map
Type-aware setter for unhealthy_members_map
Updates an existing instance of RaftFleet.Cluster.State with the given dict
.
The values in the dict
are validated by each field’s valid?/1
function.
Returns {:ok, valid_struct}
or {:error, reason}
A variant of update/2
which returns t
or raise if validation fails.
In other words, update/2
followed by Croma.Result.get!/1
Checks if the given value belongs to t/0
or not
Link to this section Types
t() :: %RaftFleet.Cluster.State{consensus_groups: RaftFleet.ConsensusGroups.t(), members_per_leader_node: RaftFleet.MembersPerLeaderNode.t(), node_to_purge: Croma.TypeGen.Nilable.Croma.Atom.t(), nodes_per_zone: RaftFleet.NodesPerZone.t(), recently_removed_consensus_names: RaftFleet.CappedQueue.t(), unhealthy_members_map: RaftFleet.UnhealthyMembersCountsMap.t()}
Link to this section Functions
consensus_groups(t()) :: RaftFleet.ConsensusGroups.t()
Type-aware getter for consensus_groups.
consensus_groups(t(), RaftFleet.ConsensusGroups.t()) :: t()
Type-aware setter for consensus_groups.
members_per_leader_node(t()) :: RaftFleet.MembersPerLeaderNode.t()
Type-aware getter for members_per_leader_node.
members_per_leader_node(t(), RaftFleet.MembersPerLeaderNode.t()) :: t()
Type-aware setter for members_per_leader_node.
Creates a new instance of RaftFleet.Cluster.State by using the given dict
.
For missing fields, default/0
of each field type will be used.
Returns {:ok, valid_struct}
or {:error, reason}
.
The values in the dict
are validated by each field’s valid?/1
function.
A variant of new/1
which returns t
or raise if validation fails.
In other words, new/1
followed by Croma.Result.get!/1
.
node_to_purge(t()) :: Croma.TypeGen.Nilable.Croma.Atom.t()
Type-aware getter for node_to_purge.
node_to_purge(t(), Croma.TypeGen.Nilable.Croma.Atom.t()) :: t()
Type-aware setter for node_to_purge.
nodes_per_zone(t()) :: RaftFleet.NodesPerZone.t()
Type-aware getter for nodes_per_zone.
nodes_per_zone(t(), RaftFleet.NodesPerZone.t()) :: t()
Type-aware setter for nodes_per_zone.
recently_removed_consensus_names(t()) :: RaftFleet.CappedQueue.t()
Type-aware getter for recently_removed_consensus_names.
recently_removed_consensus_names(t(), RaftFleet.CappedQueue.t()) :: t()
Type-aware setter for recently_removed_consensus_names.
unhealthy_members_map(t()) :: RaftFleet.UnhealthyMembersCountsMap.t()
Type-aware getter for unhealthy_members_map.
unhealthy_members_map(t(), RaftFleet.UnhealthyMembersCountsMap.t()) :: t()
Type-aware setter for unhealthy_members_map.
Updates an existing instance of RaftFleet.Cluster.State with the given dict
.
The values in the dict
are validated by each field’s valid?/1
function.
Returns {:ok, valid_struct}
or {:error, reason}
.
A variant of update/2
which returns t
or raise if validation fails.
In other words, update/2
followed by Croma.Result.get!/1
.
Checks if the given value belongs to t/0
or not.