org.elasticsearch.action.admin.indices.shrink

Class ShrinkRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<ShrinkRequest>

org.elasticsearch.action.admin.indices.shrink.ShrinkRequest

All Implemented Interfaces:

IndicesRequest, AckedRequest, Streamable, TaskAwareRequest

public class ShrinkRequest
extends AcknowledgedRequest<ShrinkRequest>
implements IndicesRequest

Request class to shrink an index into a single shard

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectParser<ShrinkRequest,java.lang.Void>	PARSER

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, timeout

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor and Description
ShrinkRequest(java.lang.String targetIndex, java.lang.String sourceindex)

Method Summary

Modifier and Type	Method and Description
CreateIndexRequest	getShrinkIndexRequest() Returns the CreateIndexRequest for the shrink index
java.lang.String	getSourceIndex() Returns the source index name
java.lang.String[]	indices() Returns the array of indices that the action relates to
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
void	setShrinkIndex(CreateIndexRequest shrinkIndexRequest)
void	setSourceIndex(java.lang.String index)
void	setWaitForActiveShards(ActiveShardCount waitForActiveShards) Sets the number of shard copies that should be active for creation of the new shrunken index to return.
void	setWaitForActiveShards(int waitForActiveShards) A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, readTimeout, timeout, timeout, timeout, writeTimeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Detail

PARSER

public static final ObjectParser<ShrinkRequest,java.lang.Void> PARSER

Constructor Detail

ShrinkRequest

public ShrinkRequest(java.lang.String targetIndex,
                     java.lang.String sourceindex)

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

setSourceIndex

public void setSourceIndex(java.lang.String index)

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class AcknowledgedRequest<ShrinkRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class AcknowledgedRequest<ShrinkRequest>

Throws:

java.io.IOException

indices

public java.lang.String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

setShrinkIndex

public void setShrinkIndex(CreateIndexRequest shrinkIndexRequest)

getShrinkIndexRequest

public CreateIndexRequest getShrinkIndexRequest()

Returns the CreateIndexRequest for the shrink index

getSourceIndex

public java.lang.String getSourceIndex()

Returns the source index name

setWaitForActiveShards

public void setWaitForActiveShards(ActiveShardCount waitForActiveShards)

Sets the number of shard copies that should be active for creation of the new shrunken index to return. Defaults to ActiveShardCount.DEFAULT, which will wait for one shard copy (the primary) to become active. Set this value to ActiveShardCount.ALL to wait for all shards (primary and all replicas) to be active before returning. Otherwise, use ActiveShardCount.from(int) to set this value to any non-negative integer, up to the number of copies per shard (number of replicas + 1), to wait for the desired amount of shard copies to become active before returning. Index creation will only wait up until the timeout value for the number of shard copies to be active before returning. Check CreateIndexResponse.isShardsAcked() to determine if the requisite shard copies were all started before returning or timing out.

Parameters:

waitForActiveShards - number of active shard copies to wait on

setWaitForActiveShards

public void setWaitForActiveShards(int waitForActiveShards)

A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.