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

co.elastic.clients.elasticsearch.cat.CountRequest Maven / Gradle / Ivy

The newest version!
/*
 * 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.ErrorResponse;
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.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.count.Request

/**
 * Get a document count.
 * 

* Get quick access to a document count for a data stream, an index, or an * entire cluster. The document count only includes live documents, not deleted * documents which have not yet been removed by the merge process. *

* 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 count API. * * @see API * specification */ public class CountRequest extends CatRequestBase { private final List h; private final List index; private final List s; // --------------------------------------------------------------------------------------------- private CountRequest(Builder builder) { this.h = ApiTypeHelper.unmodifiable(builder.h); this.index = ApiTypeHelper.unmodifiable(builder.index); this.s = ApiTypeHelper.unmodifiable(builder.s); } public static CountRequest of(Function> fn) { return fn.apply(new Builder()).build(); } /** * List of columns to appear in the response. Supports simple wildcards. *

* API name: {@code h} */ public final List h() { return this.h; } /** * A comma-separated list of data streams, indices, and aliases used to limit * the request. It 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; } /** * List of columns that determine how the table should be sorted. Sorting * defaults to ascending and can be changed by setting :asc or * :desc as a suffix to the column name. *

* API name: {@code s} */ public final List s() { return this.s; } // --------------------------------------------------------------------------------------------- /** * Builder for {@link CountRequest}. */ public static class Builder extends CatRequestBase.AbstractBuilder implements ObjectBuilder { @Nullable private List h; @Nullable private List index; @Nullable private List s; /** * List of columns to appear in the response. Supports simple wildcards. *

* API name: {@code h} *

* Adds all elements of list to h. */ public final Builder h(List list) { this.h = _listAddAll(this.h, list); return this; } /** * List of columns to appear in the response. Supports simple wildcards. *

* API name: {@code h} *

* Adds one or more values to h. */ public final Builder h(String value, String... values) { this.h = _listAdd(this.h, value, values); return this; } /** * A comma-separated list of data streams, indices, and aliases used to limit * the request. It 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; } /** * A comma-separated list of data streams, indices, and aliases used to limit * the request. It 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; } /** * List of columns that determine how the table should be sorted. Sorting * defaults to ascending and can be changed by setting :asc or * :desc as a suffix to the column name. *

* API name: {@code s} *

* Adds all elements of list to s. */ public final Builder s(List list) { this.s = _listAddAll(this.s, list); return this; } /** * List of columns that determine how the table should be sorted. Sorting * defaults to ascending and can be changed by setting :asc or * :desc as a suffix to the column name. *

* API name: {@code s} *

* Adds one or more values to s. */ public final Builder s(String value, String... values) { this.s = _listAdd(this.s, value, values); return this; } @Override protected Builder self() { return this; } /** * Builds a {@link CountRequest}. * * @throws NullPointerException * if some of the required fields are null. */ public CountRequest build() { _checkSingleUse(); return new CountRequest(this); } } // --------------------------------------------------------------------------------------------- /** * Endpoint "{@code cat.count}". */ public static final Endpoint _ENDPOINT = new SimpleEndpoint<>( "es/cat.count", // 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("/count"); return buf.toString(); } if (propsSet == (_index)) { StringBuilder buf = new StringBuilder(); buf.append("/_cat"); buf.append("/count"); 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.s)) { params.put("s", request.s.stream().map(v -> v).collect(Collectors.joining(","))); } if (ApiTypeHelper.isDefined(request.h)) { params.put("h", request.h.stream().map(v -> v).collect(Collectors.joining(","))); } return params; }, SimpleEndpoint.emptyMap(), false, CountResponse._DESERIALIZER); }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy