co.elastic.clients.elasticsearch.sql.GetAsyncRequest 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.sql;
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 jakarta.json.stream.JsonGenerator;
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;
//----------------------------------------------------------------
// 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: sql.get_async.Request
/**
* Returns the current status and available results for an async SQL search or
* stored synchronous SQL search
*
* @see API
* specification
*/
public class GetAsyncRequest extends RequestBase {
@Nullable
private final String delimiter;
@Nullable
private final String format;
private final String id;
@Nullable
private final Time keepAlive;
@Nullable
private final Time waitForCompletionTimeout;
// ---------------------------------------------------------------------------------------------
private GetAsyncRequest(Builder builder) {
this.delimiter = builder.delimiter;
this.format = builder.format;
this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id");
this.keepAlive = builder.keepAlive;
this.waitForCompletionTimeout = builder.waitForCompletionTimeout;
}
public static GetAsyncRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Separator for CSV results. The API only supports this parameter for CSV
* responses.
*
* API name: {@code delimiter}
*/
@Nullable
public final String delimiter() {
return this.delimiter;
}
/**
* Format for the response. You must specify a format using this parameter or
* the Accept HTTP header. If you specify both, the API uses this parameter.
*
* API name: {@code format}
*/
@Nullable
public final String format() {
return this.format;
}
/**
* Required - Identifier for the search.
*
* API name: {@code id}
*/
public final String id() {
return this.id;
}
/**
* Retention period for the search and its results. Defaults to the
* keep_alive period for the original SQL search.
*
* API name: {@code keep_alive}
*/
@Nullable
public final Time keepAlive() {
return this.keepAlive;
}
/**
* Period to wait for complete results. Defaults to no timeout, meaning the
* request waits for complete search results.
*
* API name: {@code wait_for_completion_timeout}
*/
@Nullable
public final Time waitForCompletionTimeout() {
return this.waitForCompletionTimeout;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GetAsyncRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder implements ObjectBuilder {
@Nullable
private String delimiter;
@Nullable
private String format;
private String id;
@Nullable
private Time keepAlive;
@Nullable
private Time waitForCompletionTimeout;
/**
* Separator for CSV results. The API only supports this parameter for CSV
* responses.
*
* API name: {@code delimiter}
*/
public final Builder delimiter(@Nullable String value) {
this.delimiter = value;
return this;
}
/**
* Format for the response. You must specify a format using this parameter or
* the Accept HTTP header. If you specify both, the API uses this parameter.
*
* API name: {@code format}
*/
public final Builder format(@Nullable String value) {
this.format = value;
return this;
}
/**
* Required - Identifier for the search.
*
* API name: {@code id}
*/
public final Builder id(String value) {
this.id = value;
return this;
}
/**
* Retention period for the search and its results. Defaults to the
* keep_alive period for the original SQL search.
*
* API name: {@code keep_alive}
*/
public final Builder keepAlive(@Nullable Time value) {
this.keepAlive = value;
return this;
}
/**
* Retention period for the search and its results. Defaults to the
* keep_alive period for the original SQL search.
*
* API name: {@code keep_alive}
*/
public final Builder keepAlive(Function> fn) {
return this.keepAlive(fn.apply(new Time.Builder()).build());
}
/**
* Period to wait for complete results. Defaults to no timeout, meaning the
* request waits for complete search results.
*
* API name: {@code wait_for_completion_timeout}
*/
public final Builder waitForCompletionTimeout(@Nullable Time value) {
this.waitForCompletionTimeout = value;
return this;
}
/**
* Period to wait for complete results. Defaults to no timeout, meaning the
* request waits for complete search results.
*
* API name: {@code wait_for_completion_timeout}
*/
public final Builder waitForCompletionTimeout(Function> fn) {
return this.waitForCompletionTimeout(fn.apply(new Time.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link GetAsyncRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GetAsyncRequest build() {
_checkSingleUse();
return new GetAsyncRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code sql.get_async}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/sql.get_async",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
final int _id = 1 << 0;
int propsSet = 0;
propsSet |= _id;
if (propsSet == (_id)) {
StringBuilder buf = new StringBuilder();
buf.append("/_sql");
buf.append("/async");
buf.append("/");
SimpleEndpoint.pathEncode(request.id, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _id = 1 << 0;
int propsSet = 0;
propsSet |= _id;
if (propsSet == (_id)) {
params.put("id", request.id);
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.delimiter != null) {
params.put("delimiter", request.delimiter);
}
if (request.format != null) {
params.put("format", request.format);
}
if (request.keepAlive != null) {
params.put("keep_alive", request.keepAlive._toJsonString());
}
if (request.waitForCompletionTimeout != null) {
params.put("wait_for_completion_timeout", request.waitForCompletionTimeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), false, GetAsyncResponse._DESERIALIZER);
}