org.elasticsearch.action.admin.indices.recovery.RecoveryRequest Maven / Gradle / Ivy
/*
* 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.indices.recovery;
import java.io.IOException;
import org.elasticsearch.action.support.broadcast.BroadcastOperationRequest;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
/**
* Request for recovery information
*/
public class RecoveryRequest extends BroadcastOperationRequest {
private boolean detailed = false; // Provides extra details in the response
private boolean activeOnly = false; // Only reports on active recoveries
/**
* Constructs a request for recovery information for all shards
*/
public RecoveryRequest() {
this(Strings.EMPTY_ARRAY);
}
/**
* Constructs a request for recovery information for all shards for the given indices
*
* @param indices Comma-separated list of indices about which to gather recovery information
*/
public RecoveryRequest(String... indices) {
super(indices);
}
/**
* True if detailed flag is set, false otherwise. This value if false by default.
*
* @return True if detailed flag is set, false otherwise
*/
public boolean detailed() {
return detailed;
}
/**
* Set value of the detailed flag. Detailed requests will contain extra
* information such as a list of physical files and their recovery progress.
*
* @param detailed Whether or not to set the detailed flag
*/
public void detailed(boolean detailed) {
this.detailed = detailed;
}
/**
* True if activeOnly flag is set, false otherwise. This value is false by default.
*
* @return True if activeOnly flag is set, false otherwise
*/
public boolean activeOnly() {
return activeOnly;
}
/**
* Set value of the activeOnly flag. If true, this request will only response with
* on-going recovery information.
*
* @param activeOnly Whether or not to set the activeOnly flag.
*/
public void activeOnly(boolean activeOnly) {
this.activeOnly = activeOnly;
}
@Override
public void writeTo(StreamOutput out) throws IOException {
super.writeTo(out);
out.writeBoolean(detailed);
out.writeBoolean(activeOnly);
}
@Override
public void readFrom(StreamInput in) throws IOException {
super.readFrom(in);
detailed = in.readBoolean();
activeOnly = in.readBoolean();
}
}