/* * Licensed to Elasticsearch under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch 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 org.elasticsearch.action.admin.cluster.health; import org.elasticsearch.action.ActionRequestValidationException; import org.elasticsearch.action.IndicesRequest; import org.elasticsearch.action.support.ActiveShardCount; import org.elasticsearch.action.support.IndicesOptions; import org.elasticsearch.action.support.master.MasterNodeReadRequest; import org.elasticsearch.cluster.health.ClusterHealthStatus; import org.elasticsearch.common.Priority; import org.elasticsearch.common.Strings; import org.elasticsearch.common.io.stream.StreamInput; import org.elasticsearch.common.io.stream.StreamOutput; import org.elasticsearch.common.unit.TimeValue; import java.io.IOException; import java.util.concurrent.TimeUnit; public class ClusterHealthRequest extends MasterNodeReadRequest<ClusterHealthRequest> implements IndicesRequest.Replaceable { private String[] indices; private TimeValue timeout = new TimeValue(30, TimeUnit.SECONDS); private ClusterHealthStatus waitForStatus; private boolean waitForNoRelocatingShards = false; private ActiveShardCount waitForActiveShards = ActiveShardCount.NONE; private String waitForNodes = ""; private Priority waitForEvents = null; public ClusterHealthRequest() { } public ClusterHealthRequest(String... indices) { this.indices = indices; } @Override public String[] indices() { return indices; } @Override public ClusterHealthRequest indices(String... indices) { this.indices = indices; return this; } @Override public IndicesOptions indicesOptions() { return IndicesOptions.lenientExpandOpen(); } public TimeValue timeout() { return timeout; } public ClusterHealthRequest timeout(TimeValue timeout) { this.timeout = timeout; if (masterNodeTimeout == DEFAULT_MASTER_NODE_TIMEOUT) { masterNodeTimeout = timeout; } return this; } public ClusterHealthRequest timeout(String timeout) { return this.timeout(TimeValue.parseTimeValue(timeout, null, getClass().getSimpleName() + ".timeout")); } public ClusterHealthStatus waitForStatus() { return waitForStatus; } public ClusterHealthRequest waitForStatus(ClusterHealthStatus waitForStatus) { this.waitForStatus = waitForStatus; return this; } public ClusterHealthRequest waitForGreenStatus() { return waitForStatus(ClusterHealthStatus.GREEN); } public ClusterHealthRequest waitForYellowStatus() { return waitForStatus(ClusterHealthStatus.YELLOW); } public boolean waitForNoRelocatingShards() { return waitForNoRelocatingShards; } /** * Sets whether the request should wait for there to be no relocating shards before * retrieving the cluster health status. Defaults to {@code false}, meaning the * operation does not wait on there being no more relocating shards. Set to <code>true</code> * to wait until the number of relocating shards in the cluster is 0. */ public ClusterHealthRequest waitForNoRelocatingShards(boolean waitForNoRelocatingShards) { this.waitForNoRelocatingShards = waitForNoRelocatingShards; return this; } public ActiveShardCount waitForActiveShards() { return waitForActiveShards; } /** * Sets the number of shard copies that must be active across all indices before getting the * health status. Defaults to {@link ActiveShardCount#NONE}, meaning we don't wait on any active shards. * Set this value to {@link ActiveShardCount#ALL} to wait for all shards (primary and * all replicas) to be active across all indices in the cluster. Otherwise, use * {@link ActiveShardCount#from(int)} to set this value to any non-negative integer, up to the * total number of shard copies to wait for. */ public ClusterHealthRequest waitForActiveShards(ActiveShardCount waitForActiveShards) { if (waitForActiveShards.equals(ActiveShardCount.DEFAULT)) { // the default for cluster health request is 0, not 1 this.waitForActiveShards = ActiveShardCount.NONE; } else { this.waitForActiveShards = waitForActiveShards; } return this; } /** * A shortcut for {@link #waitForActiveShards(ActiveShardCount)} where the numerical * shard count is passed in, instead of having to first call {@link ActiveShardCount#from(int)} * to get the ActiveShardCount. */ public ClusterHealthRequest waitForActiveShards(final int waitForActiveShards) { return waitForActiveShards(ActiveShardCount.from(waitForActiveShards)); } public String waitForNodes() { return waitForNodes; } /** * Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range. */ public ClusterHealthRequest waitForNodes(String waitForNodes) { this.waitForNodes = waitForNodes; return this; } public ClusterHealthRequest waitForEvents(Priority waitForEvents) { this.waitForEvents = waitForEvents; return this; } public Priority waitForEvents() { return this.waitForEvents; } @Override public ActionRequestValidationException validate() { return null; } @Override public void readFrom(StreamInput in) throws IOException { super.readFrom(in); int size = in.readVInt(); if (size == 0) { indices = Strings.EMPTY_ARRAY; } else { indices = new String[size]; for (int i = 0; i < indices.length; i++) { indices[i] = in.readString(); } } timeout = new TimeValue(in); if (in.readBoolean()) { waitForStatus = ClusterHealthStatus.fromValue(in.readByte()); } waitForNoRelocatingShards = in.readBoolean(); waitForActiveShards = ActiveShardCount.readFrom(in); waitForNodes = in.readString(); if (in.readBoolean()) { waitForEvents = Priority.readFrom(in); } } @Override public void writeTo(StreamOutput out) throws IOException { super.writeTo(out); if (indices == null) { out.writeVInt(0); } else { out.writeVInt(indices.length); for (String index : indices) { out.writeString(index); } } timeout.writeTo(out); if (waitForStatus == null) { out.writeBoolean(false); } else { out.writeBoolean(true); out.writeByte(waitForStatus.value()); } out.writeBoolean(waitForNoRelocatingShards); waitForActiveShards.writeTo(out); out.writeString(waitForNodes); if (waitForEvents == null) { out.writeBoolean(false); } else { out.writeBoolean(true); Priority.writeTo(waitForEvents, out); } } }