co.elastic.clients.elasticsearch.indices.ShrinkRequest Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.indices;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.elasticsearch._types.WaitForActiveShards;
import co.elastic.clients.json.JsonData;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: indices.shrink.Request
/**
* Shrink an index. Shrink an index into a new index with fewer primary shards.
*
* Before you can shrink an index:
*
* - The index must be read-only.
* - A copy of every shard in the index must reside on the same node.
* - The index must have a green health status.
*
*
* To make shard allocation easier, we recommend you also remove the index's
* replica shards. You can later re-add replica shards as part of the shrink
* operation.
*
* The requested number of primary shards in the target index must be a factor
* of the number of shards in the source index. For example an index with 8
* primary shards can be shrunk into 4, 2 or 1 primary shards or an index with
* 15 primary shards can be shrunk into 5, 3 or 1. If the number of shards in
* the index is a prime number it can only be shrunk into a single primary shard
* Before shrinking, a (primary or replica) copy of every shard in the index
* must be present on the same node.
*
* The current write index on a data stream cannot be shrunk. In order to shrink
* the current write index, the data stream must first be rolled over so that a
* new write index is created and then the previous write index can be shrunk.
*
* A shrink operation:
*
* - Creates a new target index with the same definition as the source index,
* but with a smaller number of primary shards.
* - Hard-links segments from the source index into the target index. If the
* file system does not support hard-linking, then all segments are copied into
* the new index, which is a much more time consuming process. Also if using
* multiple data paths, shards on different data paths require a full copy of
* segment files if they are not on the same disk since hardlinks do not work
* across disks.
* - Recovers the target index as though it were a closed index which had just
* been re-opened. Recovers shards to the
*
.routing.allocation.initial_recovery._id index setting.
*
*
* IMPORTANT: Indices can only be shrunk if they satisfy the following
* requirements:
*
* - The target index must not exist.
* - The source index must have more primary shards than the target
* index.
* - The number of primary shards in the target index must be a factor of the
* number of primary shards in the source index. The source index must have more
* primary shards than the target index.
* - The index must not contain more than 2,147,483,519 documents in total
* across all shards that will be shrunk into a single shard on the target index
* as this is the maximum number of docs that can fit into a single shard.
* - The node handling the shrink process must have sufficient free disk space
* to accommodate a second copy of the existing index.
*
*
* @see API
* specification
*/
@JsonpDeserializable
public class ShrinkRequest extends RequestBase implements JsonpSerializable {
private final Map aliases;
private final String index;
@Nullable
private final Time masterTimeout;
private final Map settings;
private final String target;
@Nullable
private final Time timeout;
@Nullable
private final WaitForActiveShards waitForActiveShards;
// ---------------------------------------------------------------------------------------------
private ShrinkRequest(Builder builder) {
this.aliases = ApiTypeHelper.unmodifiable(builder.aliases);
this.index = ApiTypeHelper.requireNonNull(builder.index, this, "index");
this.masterTimeout = builder.masterTimeout;
this.settings = ApiTypeHelper.unmodifiable(builder.settings);
this.target = ApiTypeHelper.requireNonNull(builder.target, this, "target");
this.timeout = builder.timeout;
this.waitForActiveShards = builder.waitForActiveShards;
}
public static ShrinkRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The key is the alias name. Index alias names support date math.
*
* API name: {@code aliases}
*/
public final Map aliases() {
return this.aliases;
}
/**
* Required - Name of the source index to shrink.
*
* API name: {@code index}
*/
public final String index() {
return this.index;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
@Nullable
public final Time masterTimeout() {
return this.masterTimeout;
}
/**
* Configuration options for the target index.
*
* API name: {@code settings}
*/
public final Map settings() {
return this.settings;
}
/**
* Required - Name of the target index to create.
*
* API name: {@code target}
*/
public final String target() {
return this.target;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* The number of shard copies that must be active before proceeding with the
* operation. Set to all or any positive integer up to the total
* number of shards in the index (number_of_replicas+1).
*
* API name: {@code wait_for_active_shards}
*/
@Nullable
public final WaitForActiveShards waitForActiveShards() {
return this.waitForActiveShards;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (ApiTypeHelper.isDefined(this.aliases)) {
generator.writeKey("aliases");
generator.writeStartObject();
for (Map.Entry item0 : this.aliases.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.settings)) {
generator.writeKey("settings");
generator.writeStartObject();
for (Map.Entry item0 : this.settings.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ShrinkRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder implements ObjectBuilder {
@Nullable
private Map aliases;
private String index;
@Nullable
private Time masterTimeout;
@Nullable
private Map settings;
private String target;
@Nullable
private Time timeout;
@Nullable
private WaitForActiveShards waitForActiveShards;
/**
* The key is the alias name. Index alias names support date math.
*
* API name: {@code aliases}
*
* Adds all entries of map to aliases.
*/
public final Builder aliases(Map map) {
this.aliases = _mapPutAll(this.aliases, map);
return this;
}
/**
* The key is the alias name. Index alias names support date math.
*
* API name: {@code aliases}
*
* Adds an entry to aliases.
*/
public final Builder aliases(String key, Alias value) {
this.aliases = _mapPut(this.aliases, key, value);
return this;
}
/**
* The key is the alias name. Index alias names support date math.
*
* API name: {@code aliases}
*
* Adds an entry to aliases using a builder lambda.
*/
public final Builder aliases(String key, Function> fn) {
return aliases(key, fn.apply(new Alias.Builder()).build());
}
/**
* Required - Name of the source index to shrink.
*
* API name: {@code index}
*/
public final Builder index(String value) {
this.index = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(@Nullable Time value) {
this.masterTimeout = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(Function> fn) {
return this.masterTimeout(fn.apply(new Time.Builder()).build());
}
/**
* Configuration options for the target index.
*
* API name: {@code settings}
*
* Adds all entries of map to settings.
*/
public final Builder settings(Map map) {
this.settings = _mapPutAll(this.settings, map);
return this;
}
/**
* Configuration options for the target index.
*
* API name: {@code settings}
*
* Adds an entry to settings.
*/
public final Builder settings(String key, JsonData value) {
this.settings = _mapPut(this.settings, key, value);
return this;
}
/**
* Required - Name of the target index to create.
*
* API name: {@code target}
*/
public final Builder target(String value) {
this.target = value;
return this;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* The number of shard copies that must be active before proceeding with the
* operation. Set to all or any positive integer up to the total
* number of shards in the index (number_of_replicas+1).
*
* API name: {@code wait_for_active_shards}
*/
public final Builder waitForActiveShards(@Nullable WaitForActiveShards value) {
this.waitForActiveShards = value;
return this;
}
/**
* The number of shard copies that must be active before proceeding with the
* operation. Set to all or any positive integer up to the total
* number of shards in the index (number_of_replicas+1).
*
* API name: {@code wait_for_active_shards}
*/
public final Builder waitForActiveShards(
Function> fn) {
return this.waitForActiveShards(fn.apply(new WaitForActiveShards.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link ShrinkRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ShrinkRequest build() {
_checkSingleUse();
return new ShrinkRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link ShrinkRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
ShrinkRequest::setupShrinkRequestDeserializer);
protected static void setupShrinkRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::aliases, JsonpDeserializer.stringMapDeserializer(Alias._DESERIALIZER), "aliases");
op.add(Builder::settings, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), "settings");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code indices.shrink}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/indices.shrink",
// Request method
request -> {
return "PUT";
},
// Request path
request -> {
final int _index = 1 << 0;
final int _target = 1 << 1;
int propsSet = 0;
propsSet |= _index;
propsSet |= _target;
if (propsSet == (_index | _target)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index, buf);
buf.append("/_shrink");
buf.append("/");
SimpleEndpoint.pathEncode(request.target, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _index = 1 << 0;
final int _target = 1 << 1;
int propsSet = 0;
propsSet |= _index;
propsSet |= _target;
if (propsSet == (_index | _target)) {
params.put("index", request.index);
params.put("target", request.target);
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.masterTimeout != null) {
params.put("master_timeout", request.masterTimeout._toJsonString());
}
if (request.waitForActiveShards != null) {
params.put("wait_for_active_shards", request.waitForActiveShards._toJsonString());
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), true, ShrinkResponse._DESERIALIZER);
}