org.opensearch.action.admin.indices.stats.IndicesStatsRequest Maven / Gradle / Ivy
Show all versions of opensearch Show documentation
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* 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.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
package org.opensearch.action.admin.indices.stats;
import org.opensearch.action.support.broadcast.BroadcastRequest;
import org.opensearch.common.annotation.PublicApi;
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.core.tasks.TaskId;
import org.opensearch.rest.action.admin.cluster.ClusterAdminTask;
import org.opensearch.tasks.Task;
import java.io.IOException;
import java.util.Map;
/**
* A request to get indices level stats. Allow to enable different stats to be returned.
*
* By default, all statistics are enabled.
*
* All the stats to be returned can be cleared using {@link #clear()}, at which point, specific
* stats can be enabled.
*
* @opensearch.api
*/
@PublicApi(since = "1.0.0")
public class IndicesStatsRequest extends BroadcastRequest {
private CommonStatsFlags flags = new CommonStatsFlags();
public IndicesStatsRequest() {
super((String[]) null);
}
public IndicesStatsRequest(StreamInput in) throws IOException {
super(in);
flags = new CommonStatsFlags(in);
}
/**
* Sets all flags to return all stats.
*/
public IndicesStatsRequest all() {
flags.all();
return this;
}
/**
* Clears all stats.
*/
public IndicesStatsRequest clear() {
flags.clear();
return this;
}
/**
* Returns the underlying stats flags.
*/
public CommonStatsFlags flags() {
return flags;
}
/**
* Sets the underlying stats flags.
*/
public IndicesStatsRequest flags(CommonStatsFlags flags) {
this.flags = flags;
return this;
}
/**
* Sets specific search group stats to retrieve the stats for. Mainly affects search
* when enabled.
*/
public IndicesStatsRequest groups(String... groups) {
flags.groups(groups);
return this;
}
@Override
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map headers) {
if (this.getShouldCancelOnTimeout()) {
return new ClusterAdminTask(id, type, action, parentTaskId, headers);
} else {
return super.createTask(id, type, action, parentTaskId, headers);
}
}
public String[] groups() {
return this.flags.groups();
}
public IndicesStatsRequest docs(boolean docs) {
flags.set(CommonStatsFlags.Flag.Docs, docs);
return this;
}
public boolean docs() {
return flags.isSet(CommonStatsFlags.Flag.Docs);
}
public IndicesStatsRequest store(boolean store) {
flags.set(CommonStatsFlags.Flag.Store, store);
return this;
}
public boolean store() {
return flags.isSet(CommonStatsFlags.Flag.Store);
}
public IndicesStatsRequest indexing(boolean indexing) {
flags.set(CommonStatsFlags.Flag.Indexing, indexing);
return this;
}
public boolean indexing() {
return flags.isSet(CommonStatsFlags.Flag.Indexing);
}
public IndicesStatsRequest get(boolean get) {
flags.set(CommonStatsFlags.Flag.Get, get);
return this;
}
public boolean get() {
return flags.isSet(CommonStatsFlags.Flag.Get);
}
public IndicesStatsRequest search(boolean search) {
flags.set(CommonStatsFlags.Flag.Search, search);
return this;
}
public boolean search() {
return flags.isSet(CommonStatsFlags.Flag.Search);
}
public IndicesStatsRequest merge(boolean merge) {
flags.set(CommonStatsFlags.Flag.Merge, merge);
return this;
}
public boolean merge() {
return flags.isSet(CommonStatsFlags.Flag.Merge);
}
public IndicesStatsRequest refresh(boolean refresh) {
flags.set(CommonStatsFlags.Flag.Refresh, refresh);
return this;
}
public boolean refresh() {
return flags.isSet(CommonStatsFlags.Flag.Refresh);
}
public IndicesStatsRequest flush(boolean flush) {
flags.set(CommonStatsFlags.Flag.Flush, flush);
return this;
}
public boolean flush() {
return flags.isSet(CommonStatsFlags.Flag.Flush);
}
public IndicesStatsRequest warmer(boolean warmer) {
flags.set(CommonStatsFlags.Flag.Warmer, warmer);
return this;
}
public boolean warmer() {
return flags.isSet(CommonStatsFlags.Flag.Warmer);
}
public IndicesStatsRequest queryCache(boolean queryCache) {
flags.set(CommonStatsFlags.Flag.QueryCache, queryCache);
return this;
}
public boolean queryCache() {
return flags.isSet(CommonStatsFlags.Flag.QueryCache);
}
public IndicesStatsRequest fieldData(boolean fieldData) {
flags.set(CommonStatsFlags.Flag.FieldData, fieldData);
return this;
}
public boolean fieldData() {
return flags.isSet(CommonStatsFlags.Flag.FieldData);
}
public IndicesStatsRequest segments(boolean segments) {
flags.set(CommonStatsFlags.Flag.Segments, segments);
return this;
}
public boolean segments() {
return flags.isSet(CommonStatsFlags.Flag.Segments);
}
public IndicesStatsRequest fieldDataFields(String... fieldDataFields) {
flags.fieldDataFields(fieldDataFields);
return this;
}
public String[] fieldDataFields() {
return flags.fieldDataFields();
}
public IndicesStatsRequest completion(boolean completion) {
flags.set(CommonStatsFlags.Flag.Completion, completion);
return this;
}
public boolean completion() {
return flags.isSet(CommonStatsFlags.Flag.Completion);
}
public IndicesStatsRequest completionFields(String... completionDataFields) {
flags.completionDataFields(completionDataFields);
return this;
}
public String[] completionFields() {
return flags.completionDataFields();
}
public IndicesStatsRequest translog(boolean translog) {
flags.set(CommonStatsFlags.Flag.Translog, translog);
return this;
}
public boolean translog() {
return flags.isSet(CommonStatsFlags.Flag.Translog);
}
public IndicesStatsRequest requestCache(boolean requestCache) {
flags.set(CommonStatsFlags.Flag.RequestCache, requestCache);
return this;
}
public boolean requestCache() {
return flags.isSet(CommonStatsFlags.Flag.RequestCache);
}
public IndicesStatsRequest recovery(boolean recovery) {
flags.set(CommonStatsFlags.Flag.Recovery, recovery);
return this;
}
public boolean recovery() {
return flags.isSet(CommonStatsFlags.Flag.Recovery);
}
public boolean includeSegmentFileSizes() {
return flags.includeSegmentFileSizes();
}
public IndicesStatsRequest includeSegmentFileSizes(boolean includeSegmentFileSizes) {
flags.includeSegmentFileSizes(includeSegmentFileSizes);
return this;
}
public IndicesStatsRequest includeUnloadedSegments(boolean includeUnloadedSegments) {
flags.includeUnloadedSegments(includeUnloadedSegments);
return this;
}
@Override
public void writeTo(StreamOutput out) throws IOException {
super.writeTo(out);
flags.writeTo(out);
}
@Override
public boolean includeDataStreams() {
return true;
}
}