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

co.elastic.clients.elasticsearch.cat.NodesRequest 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.Bytes;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.Time;
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.Collections;
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.nodes.Request

/**
 * Get node information.
 * 

* Get information about the nodes in a cluster. 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 nodes info API. * * @see API * specification */ public class NodesRequest extends CatRequestBase { @Nullable private final Bytes bytes; @Nullable private final Boolean fullId; private final List h; @Nullable private final Boolean includeUnloadedSegments; @Nullable private final Time masterTimeout; private final List s; @Nullable private final TimeUnit time; // --------------------------------------------------------------------------------------------- private NodesRequest(Builder builder) { this.bytes = builder.bytes; this.fullId = builder.fullId; this.h = ApiTypeHelper.unmodifiable(builder.h); this.includeUnloadedSegments = builder.includeUnloadedSegments; this.masterTimeout = builder.masterTimeout; this.s = ApiTypeHelper.unmodifiable(builder.s); this.time = builder.time; } public static NodesRequest 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; } /** * If true, return the full node ID. If false, return * the shortened node ID. *

* API name: {@code full_id} */ @Nullable public final Boolean fullId() { return this.fullId; } /** * A comma-separated list of columns names to display. It supports simple * wildcards. *

* API name: {@code h} */ public final List h() { return this.h; } /** * 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; } /** * The period to wait for a connection to the master node. *

* API name: {@code master_timeout} */ @Nullable public final Time masterTimeout() { return this.masterTimeout; } /** * A comma-separated list of column names or aliases that determines the sort * order. 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; } /** * The unit used to display time values. *

* API name: {@code time} */ @Nullable public final TimeUnit time() { return this.time; } // --------------------------------------------------------------------------------------------- /** * Builder for {@link NodesRequest}. */ public static class Builder extends CatRequestBase.AbstractBuilder implements ObjectBuilder { @Nullable private Bytes bytes; @Nullable private Boolean fullId; @Nullable private List h; @Nullable private Boolean includeUnloadedSegments; @Nullable private Time masterTimeout; @Nullable private List s; @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; } /** * If true, return the full node ID. If false, return * the shortened node ID. *

* API name: {@code full_id} */ public final Builder fullId(@Nullable Boolean value) { this.fullId = value; return this; } /** * A comma-separated list of columns names to display. It 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; } /** * A comma-separated list of columns names to display. It 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; } /** * 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; } /** * The period to wait for a connection to the master node. *

* API name: {@code master_timeout} */ public final Builder masterTimeout(@Nullable Time value) { this.masterTimeout = value; return this; } /** * The period to wait for a connection to the master node. *

* API name: {@code master_timeout} */ public final Builder masterTimeout(Function> fn) { return this.masterTimeout(fn.apply(new Time.Builder()).build()); } /** * A comma-separated list of column names or aliases that determines the sort * order. 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; } /** * A comma-separated list of column names or aliases that determines the sort * order. 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; } /** * 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 NodesRequest}. * * @throws NullPointerException * if some of the required fields are null. */ public NodesRequest build() { _checkSingleUse(); return new NodesRequest(this); } } // --------------------------------------------------------------------------------------------- /** * Endpoint "{@code cat.nodes}". */ public static final Endpoint _ENDPOINT = new SimpleEndpoint<>( "es/cat.nodes", // Request method request -> { return "GET"; }, // Request path request -> { return "/_cat/nodes"; }, // Path parameters request -> { return Collections.emptyMap(); }, // Request parameters request -> { Map params = new HashMap<>(); params.put("format", "json"); if (request.masterTimeout != null) { params.put("master_timeout", request.masterTimeout._toJsonString()); } if (ApiTypeHelper.isDefined(request.s)) { params.put("s", request.s.stream().map(v -> v).collect(Collectors.joining(","))); } if (request.bytes != null) { params.put("bytes", request.bytes.jsonValue()); } if (ApiTypeHelper.isDefined(request.h)) { params.put("h", request.h.stream().map(v -> v).collect(Collectors.joining(","))); } if (request.includeUnloadedSegments != null) { params.put("include_unloaded_segments", String.valueOf(request.includeUnloadedSegments)); } if (request.time != null) { params.put("time", request.time.jsonValue()); } if (request.fullId != null) { params.put("full_id", String.valueOf(request.fullId)); } return params; }, SimpleEndpoint.emptyMap(), false, NodesResponse._DESERIALIZER); }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy