All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.elasticsearch.action.admin.indices.flush.FlushRequest Maven / Gradle / Ivy

There is a newer version: 8.15.1
Show newest version
/*
 * 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.flush;

import org.elasticsearch.action.ActionRequest;
import org.elasticsearch.action.support.broadcast.BroadcastRequest;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;

import java.io.IOException;

/**
 * A flush request to flush one or more indices. The flush process of an index basically frees memory from the index
 * by flushing data to the index storage and clearing the internal transaction log. By default, Elasticsearch uses
 * memory heuristics in order to automatically trigger flush operations as required in order to clear memory.
 * 

* Best created with {@link org.elasticsearch.client.Requests#flushRequest(String...)}. * * @see org.elasticsearch.client.Requests#flushRequest(String...) * @see org.elasticsearch.client.IndicesAdminClient#flush(FlushRequest) * @see FlushResponse */ public class FlushRequest extends BroadcastRequest { private boolean force = false; private boolean waitIfOngoing = true; /** * Constructs a new flush request against one or more indices. If nothing is provided, all indices will * be flushed. */ public FlushRequest(String... indices) { super(indices); } /** * Returns true iff a flush should block * if a another flush operation is already running. Otherwise false */ public boolean waitIfOngoing() { return this.waitIfOngoing; } /** * if set to true the flush will block * if a another flush operation is already running until the flush can be performed. * The default is true */ public FlushRequest waitIfOngoing(boolean waitIfOngoing) { this.waitIfOngoing = waitIfOngoing; return this; } /** * Force flushing, even if one is possibly not needed. */ public boolean force() { return force; } /** * Force flushing, even if one is possibly not needed. */ public FlushRequest force(boolean force) { this.force = force; return this; } @Override public void writeTo(StreamOutput out) throws IOException { super.writeTo(out); out.writeBoolean(force); out.writeBoolean(waitIfOngoing); } @Override public void readFrom(StreamInput in) throws IOException { super.readFrom(in); force = in.readBoolean(); waitIfOngoing = in.readBoolean(); } @Override public String toString() { return "FlushRequest{" + "waitIfOngoing=" + waitIfOngoing + ", force=" + force + "}"; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy