co.elastic.clients.elasticsearch.cat.IndicesRequest 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.
*/
package co.elastic.clients.elasticsearch.cat;
import co.elastic.clients.elasticsearch._types.Bytes;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.ExpandWildcard;
import co.elastic.clients.elasticsearch._types.HealthStatus;
import co.elastic.clients.elasticsearch._types.TimeUnit;
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 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;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: cat.indices.Request
/**
* Returns high-level information about indices in a cluster, including backing
* indices for data streams. IMPORTANT: cat APIs are only intended for human
* consumption using the command line or Kibana console. They are not intended
* for use by applications. For application consumption, use the get index API.
* Use the cat indices API to get the following information for each index in a
* cluster: shard count; document count; deleted document count; primary store
* size; total store size of all shards, including shard replicas. These metrics
* are retrieved directly from Lucene, which Elasticsearch uses internally to
* power indexing and search. As a result, all document counts include hidden
* nested documents. To get an accurate count of Elasticsearch documents, use
* the cat count or count APIs.
*
* @see API
* specification
*/
public class IndicesRequest extends CatRequestBase {
@Nullable
private final Bytes bytes;
private final List expandWildcards;
@Nullable
private final HealthStatus health;
@Nullable
private final Boolean includeUnloadedSegments;
private final List index;
@Nullable
private final Boolean pri;
@Nullable
private final TimeUnit time;
// ---------------------------------------------------------------------------------------------
private IndicesRequest(Builder builder) {
this.bytes = builder.bytes;
this.expandWildcards = ApiTypeHelper.unmodifiable(builder.expandWildcards);
this.health = builder.health;
this.includeUnloadedSegments = builder.includeUnloadedSegments;
this.index = ApiTypeHelper.unmodifiable(builder.index);
this.pri = builder.pri;
this.time = builder.time;
}
public static IndicesRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The unit used to display byte values.
*
* API name: {@code bytes}
*/
@Nullable
public final Bytes bytes() {
return this.bytes;
}
/**
* The type of index that wildcard patterns can match.
*
* API name: {@code expand_wildcards}
*/
public final List expandWildcards() {
return this.expandWildcards;
}
/**
* The health status used to limit returned indices. By default, the response
* includes indices of any health status.
*
* API name: {@code health}
*/
@Nullable
public final HealthStatus health() {
return this.health;
}
/**
* 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;
}
/**
* Comma-separated list of data streams, indices, and aliases used to limit the
* request. Supports wildcards (*). To target all data streams and
* indices, omit this parameter or use * or _all.
*
* API name: {@code index}
*/
public final List index() {
return this.index;
}
/**
* If true, the response only includes information from primary shards.
*
* API name: {@code pri}
*/
@Nullable
public final Boolean pri() {
return this.pri;
}
/**
* The unit used to display time values.
*
* API name: {@code time}
*/
@Nullable
public final TimeUnit time() {
return this.time;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link IndicesRequest}.
*/
public static class Builder extends CatRequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Bytes bytes;
@Nullable
private List expandWildcards;
@Nullable
private HealthStatus health;
@Nullable
private Boolean includeUnloadedSegments;
@Nullable
private List index;
@Nullable
private Boolean pri;
@Nullable
private TimeUnit time;
/**
* The unit used to display byte values.
*
* API name: {@code bytes}
*/
public final Builder bytes(@Nullable Bytes value) {
this.bytes = value;
return this;
}
/**
* The type of index that wildcard patterns can match.
*
* 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;
}
/**
* The type of index that wildcard patterns can match.
*
* 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;
}
/**
* The health status used to limit returned indices. By default, the response
* includes indices of any health status.
*
* API name: {@code health}
*/
public final Builder health(@Nullable HealthStatus value) {
this.health = 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;
}
/**
* Comma-separated list of data streams, indices, and aliases used to limit the
* request. Supports wildcards (*). To target all data streams and
* indices, omit this parameter or use * or _all.
*
* 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;
}
/**
* Comma-separated list of data streams, indices, and aliases used to limit the
* request. Supports wildcards (*). To target all data streams and
* indices, omit this parameter or use * or _all.
*
* 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;
}
/**
* If true, the response only includes information from primary shards.
*
* API name: {@code pri}
*/
public final Builder pri(@Nullable Boolean value) {
this.pri = value;
return this;
}
/**
* The unit used to display time values.
*
* API name: {@code time}
*/
public final Builder time(@Nullable TimeUnit value) {
this.time = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link IndicesRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public IndicesRequest build() {
_checkSingleUse();
return new IndicesRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code cat.indices}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/cat.indices",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
final int _index = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.index()))
propsSet |= _index;
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_cat");
buf.append("/indices");
return buf.toString();
}
if (propsSet == (_index)) {
StringBuilder buf = new StringBuilder();
buf.append("/_cat");
buf.append("/indices");
buf.append("/");
SimpleEndpoint.pathEncode(request.index.stream().map(v -> v).collect(Collectors.joining(",")), buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _index = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.index()))
propsSet |= _index;
if (propsSet == 0) {
}
if (propsSet == (_index)) {
params.put("index", request.index.stream().map(v -> v).collect(Collectors.joining(",")));
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
params.put("format", "json");
if (ApiTypeHelper.isDefined(request.expandWildcards)) {
params.put("expand_wildcards",
request.expandWildcards.stream().map(v -> v.jsonValue()).collect(Collectors.joining(",")));
}
if (request.bytes != null) {
params.put("bytes", request.bytes.jsonValue());
}
if (request.pri != null) {
params.put("pri", String.valueOf(request.pri));
}
if (request.health != null) {
params.put("health", request.health.jsonValue());
}
if (request.includeUnloadedSegments != null) {
params.put("include_unloaded_segments", String.valueOf(request.includeUnloadedSegments));
}
if (request.time != null) {
params.put("time", request.time.jsonValue());
}
return params;
}, SimpleEndpoint.emptyMap(), false, IndicesResponse._DESERIALIZER);
}