co.elastic.clients.elasticsearch.cat.HealthRequest Maven / Gradle / Ivy
/*
* 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.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.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
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.health.Request
/**
* Returns the health status of a cluster, similar to the cluster health API.
* 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 cluster health API. This API is often used
* to check malfunctioning clusters. To help you track cluster health alongside
* log files and alerting systems, the API returns timestamps in two formats:
* HH:MM:SS, which is human-readable but includes no date
* information; Unix epoch time, which is machine-sortable and
* includes date information. The latter format is useful for cluster recoveries
* that take multiple days. You can use the cat health API to verify cluster
* health across multiple nodes. You also can use the API to track the recovery
* of a large cluster over a longer period of time.
*
* @see API
* specification
*/
public class HealthRequest extends CatRequestBase {
@Nullable
private final TimeUnit time;
@Nullable
private final Boolean ts;
// ---------------------------------------------------------------------------------------------
private HealthRequest(Builder builder) {
this.time = builder.time;
this.ts = builder.ts;
}
public static HealthRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The unit used to display time values.
*
* API name: {@code time}
*/
@Nullable
public final TimeUnit time() {
return this.time;
}
/**
* If true, returns HH:MM:SS and Unix epoch timestamps.
*
* API name: {@code ts}
*/
@Nullable
public final Boolean ts() {
return this.ts;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link HealthRequest}.
*/
public static class Builder extends CatRequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private TimeUnit time;
@Nullable
private Boolean ts;
/**
* The unit used to display time values.
*
* API name: {@code time}
*/
public final Builder time(@Nullable TimeUnit value) {
this.time = value;
return this;
}
/**
* If true, returns HH:MM:SS and Unix epoch timestamps.
*
* API name: {@code ts}
*/
public final Builder ts(@Nullable Boolean value) {
this.ts = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link HealthRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public HealthRequest build() {
_checkSingleUse();
return new HealthRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code cat.health}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/cat.health",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
return "/_cat/health";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
Map params = new HashMap<>();
params.put("format", "json");
if (request.time != null) {
params.put("time", request.time.jsonValue());
}
if (request.ts != null) {
params.put("ts", String.valueOf(request.ts));
}
return params;
}, SimpleEndpoint.emptyMap(), false, HealthResponse._DESERIALIZER);
}