co.elastic.clients.elasticsearch.cluster.RerouteRequest Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.cluster;
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.cluster.reroute.Command;
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 co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
// typedef: cluster.reroute.Request
/**
* Allows to manually change the allocation of individual shards in the cluster.
*
* @see API
* specification
*/
@JsonpDeserializable
public class RerouteRequest extends RequestBase implements JsonpSerializable {
private final List commands;
@Nullable
private final Boolean dryRun;
@Nullable
private final Boolean explain;
@Nullable
private final Time masterTimeout;
private final List metric;
@Nullable
private final Boolean retryFailed;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private RerouteRequest(Builder builder) {
this.commands = ApiTypeHelper.unmodifiable(builder.commands);
this.dryRun = builder.dryRun;
this.explain = builder.explain;
this.masterTimeout = builder.masterTimeout;
this.metric = ApiTypeHelper.unmodifiable(builder.metric);
this.retryFailed = builder.retryFailed;
this.timeout = builder.timeout;
}
public static RerouteRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Defines the commands to perform.
*
* API name: {@code commands}
*/
public final List commands() {
return this.commands;
}
/**
* If true, then the request simulates the operation only and returns the
* resulting state.
*
* API name: {@code dry_run}
*/
@Nullable
public final Boolean dryRun() {
return this.dryRun;
}
/**
* If true, then the response contains an explanation of why the commands can or
* cannot be executed.
*
* API name: {@code explain}
*/
@Nullable
public final Boolean explain() {
return this.explain;
}
/**
* 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;
}
/**
* Limits the information returned to the specified metrics.
*
* API name: {@code metric}
*/
public final List metric() {
return this.metric;
}
/**
* If true, then retries allocation of shards that are blocked due to too many
* subsequent allocation failures.
*
* API name: {@code retry_failed}
*/
@Nullable
public final Boolean retryFailed() {
return this.retryFailed;
}
/**
* 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;
}
/**
* 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.commands)) {
generator.writeKey("commands");
generator.writeStartArray();
for (Command item0 : this.commands) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link RerouteRequest}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private List commands;
@Nullable
private Boolean dryRun;
@Nullable
private Boolean explain;
@Nullable
private Time masterTimeout;
@Nullable
private List metric;
@Nullable
private Boolean retryFailed;
@Nullable
private Time timeout;
/**
* Defines the commands to perform.
*
* API name: {@code commands}
*
* Adds all elements of list to commands.
*/
public final Builder commands(List list) {
this.commands = _listAddAll(this.commands, list);
return this;
}
/**
* Defines the commands to perform.
*
* API name: {@code commands}
*
* Adds one or more values to commands.
*/
public final Builder commands(Command value, Command... values) {
this.commands = _listAdd(this.commands, value, values);
return this;
}
/**
* Defines the commands to perform.
*
* API name: {@code commands}
*
* Adds a value to commands using a builder lambda.
*/
public final Builder commands(Function> fn) {
return commands(fn.apply(new Command.Builder()).build());
}
/**
* If true, then the request simulates the operation only and returns the
* resulting state.
*
* API name: {@code dry_run}
*/
public final Builder dryRun(@Nullable Boolean value) {
this.dryRun = value;
return this;
}
/**
* If true, then the response contains an explanation of why the commands can or
* cannot be executed.
*
* API name: {@code explain}
*/
public final Builder explain(@Nullable Boolean value) {
this.explain = 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());
}
/**
* Limits the information returned to the specified metrics.
*
* API name: {@code metric}
*
* Adds all elements of list to metric.
*/
public final Builder metric(List list) {
this.metric = _listAddAll(this.metric, list);
return this;
}
/**
* Limits the information returned to the specified metrics.
*
* API name: {@code metric}
*
* Adds one or more values to metric.
*/
public final Builder metric(String value, String... values) {
this.metric = _listAdd(this.metric, value, values);
return this;
}
/**
* If true, then retries allocation of shards that are blocked due to too many
* subsequent allocation failures.
*
* API name: {@code retry_failed}
*/
public final Builder retryFailed(@Nullable Boolean value) {
this.retryFailed = 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());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link RerouteRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public RerouteRequest build() {
_checkSingleUse();
return new RerouteRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link RerouteRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
RerouteRequest::setupRerouteRequestDeserializer);
protected static void setupRerouteRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::commands, JsonpDeserializer.arrayDeserializer(Command._DESERIALIZER), "commands");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code cluster.reroute}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/cluster.reroute",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
return "/_cluster/reroute";
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.explain != null) {
params.put("explain", String.valueOf(request.explain));
}
if (request.masterTimeout != null) {
params.put("master_timeout", request.masterTimeout._toJsonString());
}
if (ApiTypeHelper.isDefined(request.metric)) {
params.put("metric", request.metric.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.dryRun != null) {
params.put("dry_run", String.valueOf(request.dryRun));
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
if (request.retryFailed != null) {
params.put("retry_failed", String.valueOf(request.retryFailed));
}
return params;
}, SimpleEndpoint.emptyMap(), true, RerouteResponse._DESERIALIZER);
}