co.elastic.clients.elasticsearch.tasks.GetTasksRequest Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.tasks;
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.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.ObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: tasks.get.Request
/**
* Returns information about a task.
*
* @see API
* specification
*/
public class GetTasksRequest extends RequestBase {
private final String taskId;
@Nullable
private final Time timeout;
@Nullable
private final Boolean waitForCompletion;
// ---------------------------------------------------------------------------------------------
private GetTasksRequest(Builder builder) {
this.taskId = ApiTypeHelper.requireNonNull(builder.taskId, this, "taskId");
this.timeout = builder.timeout;
this.waitForCompletion = builder.waitForCompletion;
}
public static GetTasksRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - Return the task with specified id (node_id:task_number)
*
* API name: {@code task_id}
*/
public final String taskId() {
return this.taskId;
}
/**
* Explicit operation timeout
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* Wait for the matching tasks to complete (default: false)
*
* API name: {@code wait_for_completion}
*/
@Nullable
public final Boolean waitForCompletion() {
return this.waitForCompletion;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GetTasksRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
private String taskId;
@Nullable
private Time timeout;
@Nullable
private Boolean waitForCompletion;
/**
* Required - Return the task with specified id (node_id:task_number)
*
* API name: {@code task_id}
*/
public final Builder taskId(String value) {
this.taskId = value;
return this;
}
/**
* Explicit operation timeout
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Explicit operation timeout
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* Wait for the matching tasks to complete (default: false)
*
* API name: {@code wait_for_completion}
*/
public final Builder waitForCompletion(@Nullable Boolean value) {
this.waitForCompletion = value;
return this;
}
/**
* Builds a {@link GetTasksRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GetTasksRequest build() {
_checkSingleUse();
return new GetTasksRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code tasks.get}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/tasks.get",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
final int _taskId = 1 << 0;
int propsSet = 0;
propsSet |= _taskId;
if (propsSet == (_taskId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_tasks");
buf.append("/");
SimpleEndpoint.pathEncode(request.taskId, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
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, GetTasksResponse._DESERIALIZER);
}