org.elasticsearch.action.admin.indices.shrink.ResizeRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.action.admin.indices.shrink;
import org.elasticsearch.action.ActionRequestValidationException;
import org.elasticsearch.action.IndicesRequest;
import org.elasticsearch.action.admin.indices.alias.Alias;
import org.elasticsearch.action.admin.indices.create.CreateIndexRequest;
import org.elasticsearch.action.support.ActiveShardCount;
import org.elasticsearch.action.support.IndicesOptions;
import org.elasticsearch.action.support.master.AcknowledgedRequest;
import org.elasticsearch.cluster.metadata.IndexMetadata;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.unit.ByteSizeValue;
import org.elasticsearch.xcontent.ObjectParser;
import org.elasticsearch.xcontent.ParseField;
import org.elasticsearch.xcontent.ToXContentObject;
import org.elasticsearch.xcontent.XContentBuilder;
import org.elasticsearch.xcontent.XContentParser;
import java.io.IOException;
import java.util.Objects;
import static org.elasticsearch.action.ValidateActions.addValidationError;
/**
* Request class to shrink an index into a single shard
*/
public class ResizeRequest extends AcknowledgedRequest implements IndicesRequest, ToXContentObject {
public static final ObjectParser PARSER = new ObjectParser<>("resize_request");
private static final ParseField MAX_PRIMARY_SHARD_SIZE = new ParseField("max_primary_shard_size");
static {
PARSER.declareField(
(parser, request, context) -> request.getTargetIndexRequest().settings(parser.map()),
new ParseField("settings"),
ObjectParser.ValueType.OBJECT
);
PARSER.declareField(
(parser, request, context) -> request.getTargetIndexRequest().aliases(parser.map()),
new ParseField("aliases"),
ObjectParser.ValueType.OBJECT
);
PARSER.declareField(
ResizeRequest::setMaxPrimaryShardSize,
(p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), MAX_PRIMARY_SHARD_SIZE.getPreferredName()),
MAX_PRIMARY_SHARD_SIZE,
ObjectParser.ValueType.STRING
);
}
private CreateIndexRequest targetIndexRequest;
private String sourceIndex;
private ResizeType type = ResizeType.SHRINK;
private Boolean copySettings = true;
private ByteSizeValue maxPrimaryShardSize;
public ResizeRequest(StreamInput in) throws IOException {
super(in);
targetIndexRequest = new CreateIndexRequest(in);
sourceIndex = in.readString();
type = in.readEnum(ResizeType.class);
copySettings = in.readOptionalBoolean();
if (in.readBoolean()) {
maxPrimaryShardSize = new ByteSizeValue(in);
}
}
ResizeRequest() {}
public ResizeRequest(String targetIndex, String sourceIndex) {
this.targetIndexRequest = new CreateIndexRequest(targetIndex);
this.sourceIndex = sourceIndex;
}
@Override
public ActionRequestValidationException validate() {
ActionRequestValidationException validationException = targetIndexRequest == null ? null : targetIndexRequest.validate();
if (sourceIndex == null) {
validationException = addValidationError("source index is missing", validationException);
}
if (targetIndexRequest == null) {
validationException = addValidationError("target index request is missing", validationException);
}
if (targetIndexRequest.settings().getByPrefix("index.sort.").isEmpty() == false) {
validationException = addValidationError("can't override index sort when resizing an index", validationException);
}
if (type == ResizeType.SPLIT && IndexMetadata.INDEX_NUMBER_OF_SHARDS_SETTING.exists(targetIndexRequest.settings()) == false) {
validationException = addValidationError("index.number_of_shards is required for split operations", validationException);
}
if (maxPrimaryShardSize != null && maxPrimaryShardSize.getBytes() <= 0) {
validationException = addValidationError("max_primary_shard_size must be greater than 0", validationException);
}
assert copySettings == null || copySettings;
return validationException;
}
public void setSourceIndex(String index) {
this.sourceIndex = index;
}
@Override
public void writeTo(StreamOutput out) throws IOException {
super.writeTo(out);
targetIndexRequest.writeTo(out);
out.writeString(sourceIndex);
out.writeEnum(type);
out.writeOptionalBoolean(copySettings);
out.writeOptionalWriteable(maxPrimaryShardSize);
}
@Override
public String[] indices() {
return new String[] { sourceIndex };
}
@Override
public IndicesOptions indicesOptions() {
return IndicesOptions.lenientExpandOpen();
}
public void setTargetIndex(CreateIndexRequest targetIndexRequest) {
this.targetIndexRequest = Objects.requireNonNull(targetIndexRequest, "target index request must not be null");
}
/**
* Returns the {@link CreateIndexRequest} for the shrink index
*/
public CreateIndexRequest getTargetIndexRequest() {
return targetIndexRequest;
}
/**
* Returns the source index name
*/
public String getSourceIndex() {
return sourceIndex;
}
/**
* Sets the number of shard copies that should be active for creation of the
* new shrunken index to return. Defaults to {@link ActiveShardCount#DEFAULT}, which will
* wait for one shard copy (the primary) to become active. Set this value to
* {@link ActiveShardCount#ALL} to wait for all shards (primary and all replicas) to be active
* before returning. Otherwise, use {@link 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 {@link ResizeResponse#isShardsAcknowledged()} to
* determine if the requisite shard copies were all started before returning or timing out.
*
* @param waitForActiveShards number of active shard copies to wait on
*/
public void setWaitForActiveShards(ActiveShardCount waitForActiveShards) {
this.getTargetIndexRequest().waitForActiveShards(waitForActiveShards);
}
/**
* A shortcut for {@link #setWaitForActiveShards(ActiveShardCount)} where the numerical
* shard count is passed in, instead of having to first call {@link ActiveShardCount#from(int)}
* to get the ActiveShardCount.
*/
public void setWaitForActiveShards(final int waitForActiveShards) {
setWaitForActiveShards(ActiveShardCount.from(waitForActiveShards));
}
/**
* The type of the resize operation
*/
public void setResizeType(ResizeType type) {
this.type = Objects.requireNonNull(type);
}
/**
* Returns the type of the resize operation
*/
public ResizeType getResizeType() {
return type;
}
public void setCopySettings(final Boolean copySettings) {
if (copySettings != null && copySettings == false) {
throw new IllegalArgumentException("[copySettings] can not be explicitly set to [false]");
}
this.copySettings = copySettings;
}
public Boolean getCopySettings() {
return copySettings;
}
/**
* Sets the max primary shard size of the target index.
* It's used to calculate an optimum shards number of the target index according to storage of
* the source index, each shard's storage of the target index will not be greater than this parameter,
* while the shards number of the target index still be a factor of the source index's shards number.
*
* @param maxPrimaryShardSize the max primary shard size of the target index
*/
public void setMaxPrimaryShardSize(ByteSizeValue maxPrimaryShardSize) {
this.maxPrimaryShardSize = maxPrimaryShardSize;
}
/**
* Returns the max primary shard size of the target index
*/
public ByteSizeValue getMaxPrimaryShardSize() {
return maxPrimaryShardSize;
}
@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject();
{
builder.startObject(CreateIndexRequest.SETTINGS.getPreferredName());
{
targetIndexRequest.settings().toXContent(builder, params);
}
builder.endObject();
builder.startObject(CreateIndexRequest.ALIASES.getPreferredName());
{
for (Alias alias : targetIndexRequest.aliases()) {
alias.toXContent(builder, params);
}
}
builder.endObject();
if (maxPrimaryShardSize != null) {
builder.field(MAX_PRIMARY_SHARD_SIZE.getPreferredName(), maxPrimaryShardSize);
}
}
builder.endObject();
return builder;
}
public void fromXContent(XContentParser parser) throws IOException {
PARSER.parse(parser, this, null);
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null || getClass() != obj.getClass()) return false;
ResizeRequest that = (ResizeRequest) obj;
return Objects.equals(targetIndexRequest, that.targetIndexRequest)
&& Objects.equals(sourceIndex, that.sourceIndex)
&& Objects.equals(type, that.type)
&& Objects.equals(copySettings, that.copySettings)
&& Objects.equals(maxPrimaryShardSize, that.maxPrimaryShardSize);
}
@Override
public int hashCode() {
return Objects.hash(targetIndexRequest, sourceIndex, type, copySettings, maxPrimaryShardSize);
}
}