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

Class AllocationCommands

java.lang.Object

org.opensearch.cluster.routing.allocation.command.AllocationCommands

All Implemented Interfaces:

org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class AllocationCommands
extends java.lang.Object
implements org.opensearch.common.xcontent.ToXContentFragment

A simple AllocationCommand composite managing several AllocationCommand implementations

Nested Class Summary

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

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

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AllocationCommands(AllocationCommand... commands)	Creates a new set of AllocationCommands

Method Summary

Modifier and Type	Method	Description
AllocationCommands	add(AllocationCommand... commands)	Adds a set of commands to this collection
java.util.List<AllocationCommand>	commands()	Get the commands wrapped by this instance
boolean	equals(java.lang.Object obj)
RoutingExplanations	execute(RoutingAllocation allocation, boolean explain)	Executes all wrapped commands on a given RoutingAllocation
static AllocationCommands	fromXContent(org.opensearch.common.xcontent.XContentParser parser)	Reads AllocationCommands from a XContentParser
int	hashCode()
static AllocationCommands	readFrom(StreamInput in)	Reads a AllocationCommands from a StreamInput
java.lang.String	toString()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
static void	writeTo(AllocationCommands commands, StreamOutput out)	Writes AllocationCommands to a StreamOutput

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

AllocationCommands

public AllocationCommands(AllocationCommand... commands)

Creates a new set of AllocationCommands

Parameters:

commands - AllocationCommands that are wrapped by this instance

Method Details

add

public AllocationCommands add(AllocationCommand... commands)

Adds a set of commands to this collection

Parameters:

commands - Array of commands to add to this instance

Returns:

AllocationCommands with the given commands added

commands

public java.util.List<AllocationCommand> commands()

Get the commands wrapped by this instance

Returns:

List of commands

execute

public RoutingExplanations execute(RoutingAllocation allocation, boolean explain)

Executes all wrapped commands on a given RoutingAllocation

Parameters:

allocation - RoutingAllocation to apply this command to

Throws:

OpenSearchException - if something happens during execution

readFrom

public static AllocationCommands readFrom(StreamInput in) throws java.io.IOException

Reads a AllocationCommands from a StreamInput

Parameters:

in - StreamInput to read from

Returns:

AllocationCommands read

Throws:

java.io.IOException - if something happens during read

writeTo

public static void writeTo(AllocationCommands commands, StreamOutput out) throws java.io.IOException

Writes AllocationCommands to a StreamOutput

Parameters:

commands - Commands to write

out - StreamOutput to write the commands to

Throws:

java.io.IOException - if something happens during write

fromXContent

public static AllocationCommands fromXContent(org.opensearch.common.xcontent.XContentParser parser) throws java.io.IOException

Reads AllocationCommands from a XContentParser

     {
         "commands" : [
              {"allocate" : {"index" : "test", "shard" : 0, "node" : "test"}}
         ]
     }
 

Parameters:

parser - XContentParser to read the commands from

Returns:

AllocationCommands read

Throws:

java.io.IOException - if something bad happens while reading the stream

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object