org.elasticsearch.action.admin.indices.shrink

Class ShrinkRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>

org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<Request,Response,RequestBuilder>

org.elasticsearch.action.support.master.AcknowledgedRequestBuilder<ShrinkRequest,ShrinkResponse,ShrinkRequestBuilder>

org.elasticsearch.action.admin.indices.shrink.ShrinkRequestBuilder

public class ShrinkRequestBuilder
extends AcknowledgedRequestBuilder<ShrinkRequest,ShrinkResponse,ShrinkRequestBuilder>

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor and Description
ShrinkRequestBuilder(ElasticsearchClient client, ShrinkAction action)

Method Summary

Modifier and Type	Method and Description
ShrinkRequestBuilder	setSettings(Settings settings)
ShrinkRequestBuilder	setSourceIndex(java.lang.String index)
ShrinkRequestBuilder	setTargetIndex(CreateIndexRequest request)
ShrinkRequestBuilder	setWaitForActiveShards(ActiveShardCount waitForActiveShards) Sets the number of shard copies that should be active for creation of the new shrunken index to return.
ShrinkRequestBuilder	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.

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

setTimeout, setTimeout

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

setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

beforeExecute, execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Detail

ShrinkRequestBuilder

public ShrinkRequestBuilder(ElasticsearchClient client,
                            ShrinkAction action)

Method Detail

setTargetIndex

public ShrinkRequestBuilder setTargetIndex(CreateIndexRequest request)

setSourceIndex

public ShrinkRequestBuilder setSourceIndex(java.lang.String index)

setSettings

public ShrinkRequestBuilder setSettings(Settings settings)

setWaitForActiveShards

public ShrinkRequestBuilder 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 ShrinkRequestBuilder 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.