co.elastic.clients.elasticsearch.cluster.PendingTasksRequest 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.cluster;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
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: cluster.pending_tasks.Request
/**
* Returns cluster-level changes (such as create index, update mapping, allocate
* or fail shard) that have not yet been executed. NOTE: This API returns a list
* of any pending updates to the cluster state. These are distinct from the
* tasks reported by the Task Management API which include periodic tasks and
* tasks initiated by the user, such as node stats, search queries, or create
* index requests. However, if a user-initiated task such as a create index
* command causes a cluster state update, the activity of this task might be
* reported by both task api and pending cluster tasks API.
*
* @see API
* specification
*/
public class PendingTasksRequest extends RequestBase {
@Nullable
private final Boolean local;
@Nullable
private final Time masterTimeout;
// ---------------------------------------------------------------------------------------------
private PendingTasksRequest(Builder builder) {
this.local = builder.local;
this.masterTimeout = builder.masterTimeout;
}
public static PendingTasksRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If true, the request retrieves information from the local node
* only. If false, information is retrieved from the master node.
*
* API name: {@code local}
*/
@Nullable
public final Boolean local() {
return this.local;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
@Nullable
public final Time masterTimeout() {
return this.masterTimeout;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link PendingTasksRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Boolean local;
@Nullable
private Time masterTimeout;
/**
* If true, the request retrieves information from the local node
* only. If false, information is retrieved from the master node.
*
* API name: {@code local}
*/
public final Builder local(@Nullable Boolean value) {
this.local = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(@Nullable Time value) {
this.masterTimeout = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(Function> fn) {
return this.masterTimeout(fn.apply(new Time.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link PendingTasksRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public PendingTasksRequest build() {
_checkSingleUse();
return new PendingTasksRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code cluster.pending_tasks}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/cluster.pending_tasks",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
return "/_cluster/pending_tasks";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.masterTimeout != null) {
params.put("master_timeout", request.masterTimeout._toJsonString());
}
if (request.local != null) {
params.put("local", String.valueOf(request.local));
}
return params;
}, SimpleEndpoint.emptyMap(), false, PendingTasksResponse._DESERIALIZER);
}