Package org.elasticsearch.action.support
Record Class ActiveShardCount
java.lang.Object
java.lang.Record
org.elasticsearch.action.support.ActiveShardCount
- All Implemented Interfaces:
Writeable
A class whose instances represent a value for counting the number
of active shard copies for a given shard in an index.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ActiveShardCount
static final ActiveShardCount
static final ActiveShardCount
static final ActiveShardCount
-
Constructor Summary
ConstructorDescriptionActiveShardCount
(int value) Creates an instance of aActiveShardCount
record class. -
Method Summary
Modifier and TypeMethodDescriptionboolean
enoughShardsActive
(int activeShardCount) Returns true iff the given number of active shards is enough to meet the required shard count represented by this instance.boolean
enoughShardsActive
(ClusterState clusterState, String... indices) Returns true iff the given cluster state's routing table contains enough active shards for the given indices to meet the required shard count represented by this instance.boolean
enoughShardsActive
(IndexShardRoutingTable shardRoutingTable) Returns true iff the active shard count in the shard routing table is enough to meet the required shard count represented by this instance.final boolean
Indicates whether some other object is "equal to" this one.static ActiveShardCount
from
(int value) Get an ActiveShardCount instance for the given value.final int
hashCode()
Returns a hash code value for this object.static ActiveShardCount
parseString
(String str) Parses the active shard count from the given string.static ActiveShardCount
readFrom
(StreamInput in) toString()
Returns a string representation of this record class.boolean
validate
(int numberOfReplicas) Validates that the instance is valid for the given number of replicas in an index.int
value()
Returns the value of thevalue
record component.void
writeTo
(StreamOutput out) Write this into the StreamOutput.
-
Field Details
-
DEFAULT
-
ALL
-
NONE
-
ONE
-
-
Constructor Details
-
ActiveShardCount
public ActiveShardCount(int value) Creates an instance of aActiveShardCount
record class.- Parameters:
value
- the value for thevalue
record component
-
-
Method Details
-
from
Get an ActiveShardCount instance for the given value. The value is first validated to ensure it is a valid shard count and throws an IllegalArgumentException if validation fails. Valid values are any non-negative number. Directly useDEFAULT
for the default value (which is one shard copy) orALL
to specify all the shards. -
validate
public boolean validate(int numberOfReplicas) Validates that the instance is valid for the given number of replicas in an index. -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
readFrom
- Throws:
IOException
-
parseString
Parses the active shard count from the given string. Valid values are "all" for all shard copies, null for the default value (which defaults to one shard copy), or a numeric value greater than or equal to 0. Any other input will throw an IllegalArgumentException. -
enoughShardsActive
public boolean enoughShardsActive(int activeShardCount) Returns true iff the given number of active shards is enough to meet the required shard count represented by this instance. This method should only be invoked withActiveShardCount
objects created fromfrom(int)
, orNONE
orONE
. -
enoughShardsActive
Returns true iff the given cluster state's routing table contains enough active shards for the given indices to meet the required shard count represented by this instance. -
enoughShardsActive
Returns true iff the active shard count in the shard routing table is enough to meet the required shard count represented by this instance. -
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='. -
value
public int value()Returns the value of thevalue
record component.- Returns:
- the value of the
value
record component
-