co.elastic.clients.elasticsearch.sql.GetAsyncStatusRequest 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.sql;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
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.String;
import java.util.Collections;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: sql.get_async_status.Request
/**
* Returns the current status of an async SQL search or a stored synchronous SQL
* search
*
* @see API
* specification
*/
public class GetAsyncStatusRequest extends RequestBase {
private final String id;
// ---------------------------------------------------------------------------------------------
private GetAsyncStatusRequest(Builder builder) {
this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id");
}
public static GetAsyncStatusRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The async search ID
*
* API name: {@code id}
*/
public final String id() {
return this.id;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GetAsyncStatusRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
private String id;
/**
* Required - The async search ID
*
* API name: {@code id}
*/
public final Builder id(String value) {
this.id = value;
return this;
}
/**
* Builds a {@link GetAsyncStatusRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GetAsyncStatusRequest build() {
_checkSingleUse();
return new GetAsyncStatusRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code sql.get_async_status}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/sql.get_async_status",
// 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("/status");
buf.append("/");
SimpleEndpoint.pathEncode(request.id, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), false, GetAsyncStatusResponse._DESERIALIZER);
}