co.elastic.clients.elasticsearch.indices.IndicesStatsRequest 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.indices;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.ExpandWildcard;
import co.elastic.clients.elasticsearch._types.Level;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
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.ObjectBuilderBase;
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: indices.stats.Request
/**
* Provides statistics on operations happening in an index.
*
* @see API
* specification
*/
public class IndicesStatsRequest extends RequestBase {
private final List completionFields;
private final List expandWildcards;
private final List fielddataFields;
private final List fields;
@Nullable
private final Boolean forbidClosedIndices;
private final List groups;
@Nullable
private final Boolean includeSegmentFileSizes;
@Nullable
private final Boolean includeUnloadedSegments;
private final List index;
@Nullable
private final Level level;
private final List metric;
// ---------------------------------------------------------------------------------------------
private IndicesStatsRequest(Builder builder) {
this.completionFields = ApiTypeHelper.unmodifiable(builder.completionFields);
this.expandWildcards = ApiTypeHelper.unmodifiable(builder.expandWildcards);
this.fielddataFields = ApiTypeHelper.unmodifiable(builder.fielddataFields);
this.fields = ApiTypeHelper.unmodifiable(builder.fields);
this.forbidClosedIndices = builder.forbidClosedIndices;
this.groups = ApiTypeHelper.unmodifiable(builder.groups);
this.includeSegmentFileSizes = builder.includeSegmentFileSizes;
this.includeUnloadedSegments = builder.includeUnloadedSegments;
this.index = ApiTypeHelper.unmodifiable(builder.index);
this.level = builder.level;
this.metric = ApiTypeHelper.unmodifiable(builder.metric);
}
public static IndicesStatsRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Comma-separated list or wildcard expressions of fields to include in
* fielddata and suggest statistics.
*
* API name: {@code completion_fields}
*/
public final List completionFields() {
return this.completionFields;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values, such as
* open,hidden.
*
* API name: {@code expand_wildcards}
*/
public final List expandWildcards() {
return this.expandWildcards;
}
/**
* Comma-separated list or wildcard expressions of fields to include in
* fielddata statistics.
*
* API name: {@code fielddata_fields}
*/
public final List fielddataFields() {
return this.fielddataFields;
}
/**
* Comma-separated list or wildcard expressions of fields to include in the
* statistics.
*
* API name: {@code fields}
*/
public final List fields() {
return this.fields;
}
/**
* If true, statistics are not collected from closed indices.
*
* API name: {@code forbid_closed_indices}
*/
@Nullable
public final Boolean forbidClosedIndices() {
return this.forbidClosedIndices;
}
/**
* Comma-separated list of search groups to include in the search statistics.
*
* API name: {@code groups}
*/
public final List groups() {
return this.groups;
}
/**
* If true, the call reports the aggregated disk usage of each one of the Lucene
* index files (only applies if segment stats are requested).
*
* API name: {@code include_segment_file_sizes}
*/
@Nullable
public final Boolean includeSegmentFileSizes() {
return this.includeSegmentFileSizes;
}
/**
* If true, the response includes information from segments that are not loaded
* into memory.
*
* API name: {@code include_unloaded_segments}
*/
@Nullable
public final Boolean includeUnloadedSegments() {
return this.includeUnloadedSegments;
}
/**
* A comma-separated list of index names; use _all or empty string
* to perform the operation on all indices
*
* API name: {@code index}
*/
public final List index() {
return this.index;
}
/**
* Indicates whether statistics are aggregated at the cluster, index, or shard
* level.
*
* API name: {@code level}
*/
@Nullable
public final Level level() {
return this.level;
}
/**
* Limit the information returned the specific metrics.
*
* API name: {@code metric}
*/
public final List metric() {
return this.metric;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link IndicesStatsRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
@Nullable
private List completionFields;
@Nullable
private List expandWildcards;
@Nullable
private List fielddataFields;
@Nullable
private List fields;
@Nullable
private Boolean forbidClosedIndices;
@Nullable
private List groups;
@Nullable
private Boolean includeSegmentFileSizes;
@Nullable
private Boolean includeUnloadedSegments;
@Nullable
private List index;
@Nullable
private Level level;
@Nullable
private List metric;
/**
* Comma-separated list or wildcard expressions of fields to include in
* fielddata and suggest statistics.
*
* API name: {@code completion_fields}
*
* Adds all elements of list to completionFields.
*/
public final Builder completionFields(List list) {
this.completionFields = _listAddAll(this.completionFields, list);
return this;
}
/**
* Comma-separated list or wildcard expressions of fields to include in
* fielddata and suggest statistics.
*
* API name: {@code completion_fields}
*
* Adds one or more values to completionFields.
*/
public final Builder completionFields(String value, String... values) {
this.completionFields = _listAdd(this.completionFields, value, values);
return this;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values, such as
* open,hidden.
*
* API name: {@code expand_wildcards}
*
* Adds all elements of list to expandWildcards.
*/
public final Builder expandWildcards(List list) {
this.expandWildcards = _listAddAll(this.expandWildcards, list);
return this;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values, such as
* open,hidden.
*
* API name: {@code expand_wildcards}
*
* Adds one or more values to expandWildcards.
*/
public final Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) {
this.expandWildcards = _listAdd(this.expandWildcards, value, values);
return this;
}
/**
* Comma-separated list or wildcard expressions of fields to include in
* fielddata statistics.
*
* API name: {@code fielddata_fields}
*
* Adds all elements of list to fielddataFields.
*/
public final Builder fielddataFields(List list) {
this.fielddataFields = _listAddAll(this.fielddataFields, list);
return this;
}
/**
* Comma-separated list or wildcard expressions of fields to include in
* fielddata statistics.
*
* API name: {@code fielddata_fields}
*
* Adds one or more values to fielddataFields.
*/
public final Builder fielddataFields(String value, String... values) {
this.fielddataFields = _listAdd(this.fielddataFields, value, values);
return this;
}
/**
* Comma-separated list or wildcard expressions of fields to include in the
* statistics.
*
* API name: {@code fields}
*
* Adds all elements of list to fields.
*/
public final Builder fields(List list) {
this.fields = _listAddAll(this.fields, list);
return this;
}
/**
* Comma-separated list or wildcard expressions of fields to include in the
* statistics.
*
* API name: {@code fields}
*
* Adds one or more values to fields.
*/
public final Builder fields(String value, String... values) {
this.fields = _listAdd(this.fields, value, values);
return this;
}
/**
* If true, statistics are not collected from closed indices.
*
* API name: {@code forbid_closed_indices}
*/
public final Builder forbidClosedIndices(@Nullable Boolean value) {
this.forbidClosedIndices = value;
return this;
}
/**
* Comma-separated list of search groups to include in the search statistics.
*
* API name: {@code groups}
*
* Adds all elements of list to groups.
*/
public final Builder groups(List list) {
this.groups = _listAddAll(this.groups, list);
return this;
}
/**
* Comma-separated list of search groups to include in the search statistics.
*
* API name: {@code groups}
*
* Adds one or more values to groups.
*/
public final Builder groups(String value, String... values) {
this.groups = _listAdd(this.groups, value, values);
return this;
}
/**
* If true, the call reports the aggregated disk usage of each one of the Lucene
* index files (only applies if segment stats are requested).
*
* API name: {@code include_segment_file_sizes}
*/
public final Builder includeSegmentFileSizes(@Nullable Boolean value) {
this.includeSegmentFileSizes = value;
return this;
}
/**
* If true, the response includes information from segments that are not loaded
* into memory.
*
* API name: {@code include_unloaded_segments}
*/
public final Builder includeUnloadedSegments(@Nullable Boolean value) {
this.includeUnloadedSegments = value;
return this;
}
/**
* A comma-separated list of index names; use _all or empty string
* to perform the operation on all indices
*
* API name: {@code index}
*
* Adds all elements of list to index.
*/
public final Builder index(List list) {
this.index = _listAddAll(this.index, list);
return this;
}
/**
* A comma-separated list of index names; use _all or empty string
* to perform the operation on all indices
*
* API name: {@code index}
*
* Adds one or more values to index.
*/
public final Builder index(String value, String... values) {
this.index = _listAdd(this.index, value, values);
return this;
}
/**
* Indicates whether statistics are aggregated at the cluster, index, or shard
* level.
*
* API name: {@code level}
*/
public final Builder level(@Nullable Level value) {
this.level = value;
return this;
}
/**
* Limit the information returned the specific 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;
}
/**
* Limit the information returned the specific 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;
}
/**
* Builds a {@link IndicesStatsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public IndicesStatsRequest build() {
_checkSingleUse();
return new IndicesStatsRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code indices.stats}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/indices.stats",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
final int _metric = 1 << 0;
final int _index = 1 << 1;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.metric()))
propsSet |= _metric;
if (ApiTypeHelper.isDefined(request.index()))
propsSet |= _index;
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_stats");
return buf.toString();
}
if (propsSet == (_metric)) {
StringBuilder buf = new StringBuilder();
buf.append("/_stats");
buf.append("/");
SimpleEndpoint.pathEncode(request.metric.stream().map(v -> v).collect(Collectors.joining(",")),
buf);
return buf.toString();
}
if (propsSet == (_index)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index.stream().map(v -> v).collect(Collectors.joining(",")), buf);
buf.append("/_stats");
return buf.toString();
}
if (propsSet == (_index | _metric)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index.stream().map(v -> v).collect(Collectors.joining(",")), buf);
buf.append("/_stats");
buf.append("/");
SimpleEndpoint.pathEncode(request.metric.stream().map(v -> v).collect(Collectors.joining(",")),
buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (ApiTypeHelper.isDefined(request.expandWildcards)) {
params.put("expand_wildcards",
request.expandWildcards.stream().map(v -> v.jsonValue()).collect(Collectors.joining(",")));
}
if (request.level != null) {
params.put("level", request.level.jsonValue());
}
if (ApiTypeHelper.isDefined(request.completionFields)) {
params.put("completion_fields",
request.completionFields.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (ApiTypeHelper.isDefined(request.fielddataFields)) {
params.put("fielddata_fields",
request.fielddataFields.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (ApiTypeHelper.isDefined(request.groups)) {
params.put("groups", request.groups.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.includeUnloadedSegments != null) {
params.put("include_unloaded_segments", String.valueOf(request.includeUnloadedSegments));
}
if (ApiTypeHelper.isDefined(request.fields)) {
params.put("fields", request.fields.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.forbidClosedIndices != null) {
params.put("forbid_closed_indices", String.valueOf(request.forbidClosedIndices));
}
if (request.includeSegmentFileSizes != null) {
params.put("include_segment_file_sizes", String.valueOf(request.includeSegmentFileSizes));
}
return params;
}, SimpleEndpoint.emptyMap(), false, IndicesStatsResponse._DESERIALIZER);
}