Package org.opensearch.cluster.routing.allocation.command

Class BasePrimaryAllocationCommand

java.lang.Object

org.opensearch.cluster.routing.allocation.command.AbstractAllocateAllocationCommand

org.opensearch.cluster.routing.allocation.command.BasePrimaryAllocationCommand

All Implemented Interfaces:

AllocationCommand, org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

Direct Known Subclasses:

AllocateEmptyPrimaryAllocationCommand, AllocateStalePrimaryAllocationCommand

public abstract class BasePrimaryAllocationCommand
extends AbstractAllocateAllocationCommand

Abstract base class for allocating an unassigned primary shard to a node

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BasePrimaryAllocationCommand.Builder<T extends BasePrimaryAllocationCommand>	Base builder class for the primary allocation command.

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	acceptDataLoss

Fields inherited from class org.opensearch.cluster.routing.allocation.command.AbstractAllocateAllocationCommand

index, node, shardId

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasePrimaryAllocationCommand(String index, int shardId, String node, boolean acceptDataLoss)
protected	BasePrimaryAllocationCommand(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	acceptDataLoss()	The operation only executes if the user explicitly agrees to possible data loss
protected static <T extends BasePrimaryAllocationCommand.Builder<?>> org.opensearch.core.xcontent.ObjectParser<T,Void>	createAllocatePrimaryParser(String command)
boolean	equals(Object obj)
protected void	extraXContent(org.opensearch.core.xcontent.XContentBuilder builder)
int	hashCode()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.cluster.routing.allocation.command.AbstractAllocateAllocationCommand

createAllocateParser, explainOrThrowMissingRoutingNode, explainOrThrowRejectedCommand, explainOrThrowRejectedCommand, index, initializeUnassignedShard, initializeUnassignedShard, node, shardId, toXContent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.cluster.routing.allocation.command.AllocationCommand

execute, getMessage, getWriteableName, name

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

acceptDataLoss

protected final boolean acceptDataLoss

Constructor Details

BasePrimaryAllocationCommand

protected BasePrimaryAllocationCommand(String index,
 int shardId,
 String node,
 boolean acceptDataLoss)

BasePrimaryAllocationCommand

protected BasePrimaryAllocationCommand(org.opensearch.core.common.io.stream.StreamInput in)
                                throws IOException

Read from a stream.

Throws:

IOException

Method Details

createAllocatePrimaryParser

protected static <T extends BasePrimaryAllocationCommand.Builder<?>>
org.opensearch.core.xcontent.ObjectParser<T,Void> createAllocatePrimaryParser(String command)

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class AbstractAllocateAllocationCommand

Throws:

IOException

acceptDataLoss

public boolean acceptDataLoss()

The operation only executes if the user explicitly agrees to possible data loss

Returns:

whether data loss is acceptable

extraXContent

protected void extraXContent(org.opensearch.core.xcontent.XContentBuilder builder)
                      throws IOException

Overrides:

extraXContent in class AbstractAllocateAllocationCommand

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAllocateAllocationCommand

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAllocateAllocationCommand