co.elastic.clients.elasticsearch.cat.TasksRequest Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* 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.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.tasks.Request
/**
* Get task information.
*
* Get information about tasks currently running in the 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 task management API.
*
* @see API
* specification
*/
public class TasksRequest extends CatRequestBase {
private final List actions;
@Nullable
private final Boolean detailed;
private final List h;
private final List nodes;
@Nullable
private final String parentTaskId;
private final List s;
@Nullable
private final TimeUnit time;
@Nullable
private final Time timeout;
@Nullable
private final Boolean waitForCompletion;
// ---------------------------------------------------------------------------------------------
private TasksRequest(Builder builder) {
this.actions = ApiTypeHelper.unmodifiable(builder.actions);
this.detailed = builder.detailed;
this.h = ApiTypeHelper.unmodifiable(builder.h);
this.nodes = ApiTypeHelper.unmodifiable(builder.nodes);
this.parentTaskId = builder.parentTaskId;
this.s = ApiTypeHelper.unmodifiable(builder.s);
this.time = builder.time;
this.timeout = builder.timeout;
this.waitForCompletion = builder.waitForCompletion;
}
public static TasksRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The task action names, which are used to limit the response.
*
* API name: {@code actions}
*/
public final List actions() {
return this.actions;
}
/**
* If true, the response includes detailed information about shard
* recoveries.
*
* API name: {@code detailed}
*/
@Nullable
public final Boolean detailed() {
return this.detailed;
}
/**
* List of columns to appear in the response. Supports simple wildcards.
*
* API name: {@code h}
*/
public final List h() {
return this.h;
}
/**
* Unique node identifiers, which are used to limit the response.
*
* API name: {@code nodes}
*/
public final List nodes() {
return this.nodes;
}
/**
* The parent task identifier, which is used to limit the response.
*
* API name: {@code parent_task_id}
*/
@Nullable
public final String parentTaskId() {
return this.parentTaskId;
}
/**
* 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;
}
/**
* Unit used to display time values.
*
* API name: {@code time}
*/
@Nullable
public final TimeUnit time() {
return this.time;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* If true, the request blocks until the task has completed.
*
* API name: {@code wait_for_completion}
*/
@Nullable
public final Boolean waitForCompletion() {
return this.waitForCompletion;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link TasksRequest}.
*/
public static class Builder extends CatRequestBase.AbstractBuilder implements ObjectBuilder {
@Nullable
private List actions;
@Nullable
private Boolean detailed;
@Nullable
private List h;
@Nullable
private List nodes;
@Nullable
private String parentTaskId;
@Nullable
private List s;
@Nullable
private TimeUnit time;
@Nullable
private Time timeout;
@Nullable
private Boolean waitForCompletion;
/**
* The task action names, which are used to limit the response.
*
* API name: {@code actions}
*
* Adds all elements of list to actions.
*/
public final Builder actions(List list) {
this.actions = _listAddAll(this.actions, list);
return this;
}
/**
* The task action names, which are used to limit the response.
*
* API name: {@code actions}
*
* Adds one or more values to actions.
*/
public final Builder actions(String value, String... values) {
this.actions = _listAdd(this.actions, value, values);
return this;
}
/**
* If true, the response includes detailed information about shard
* recoveries.
*
* API name: {@code detailed}
*/
public final Builder detailed(@Nullable Boolean value) {
this.detailed = value;
return this;
}
/**
* 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;
}
/**
* Unique node identifiers, which are used to limit the response.
*
* API name: {@code nodes}
*
* Adds all elements of list to nodes.
*/
public final Builder nodes(List list) {
this.nodes = _listAddAll(this.nodes, list);
return this;
}
/**
* Unique node identifiers, which are used to limit the response.
*
* API name: {@code nodes}
*
* Adds one or more values to nodes.
*/
public final Builder nodes(String value, String... values) {
this.nodes = _listAdd(this.nodes, value, values);
return this;
}
/**
* The parent task identifier, which is used to limit the response.
*
* API name: {@code parent_task_id}
*/
public final Builder parentTaskId(@Nullable String value) {
this.parentTaskId = value;
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;
}
/**
* Unit used to display time values.
*
* API name: {@code time}
*/
public final Builder time(@Nullable TimeUnit value) {
this.time = value;
return this;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* If true, the request blocks until the task has completed.
*
* API name: {@code wait_for_completion}
*/
public final Builder waitForCompletion(@Nullable Boolean value) {
this.waitForCompletion = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link TasksRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public TasksRequest build() {
_checkSingleUse();
return new TasksRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code cat.tasks}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/cat.tasks",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
return "/_cat/tasks";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
Map params = new HashMap<>();
params.put("format", "json");
if (ApiTypeHelper.isDefined(request.nodes)) {
params.put("nodes", request.nodes.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.parentTaskId != null) {
params.put("parent_task_id", request.parentTaskId);
}
if (ApiTypeHelper.isDefined(request.s)) {
params.put("s", request.s.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.detailed != null) {
params.put("detailed", String.valueOf(request.detailed));
}
if (ApiTypeHelper.isDefined(request.h)) {
params.put("h", request.h.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.time != null) {
params.put("time", request.time.jsonValue());
}
if (ApiTypeHelper.isDefined(request.actions)) {
params.put("actions", request.actions.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.waitForCompletion != null) {
params.put("wait_for_completion", String.valueOf(request.waitForCompletion));
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), false, TasksResponse._DESERIALIZER);
}