co.elastic.clients.elasticsearch.core.ScrollRequest 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.core;
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.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
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.Collections;
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: _global.scroll.Request
/**
* Run a scrolling search.
*
* IMPORTANT: The scroll API is no longer recommend for deep pagination. If you
* need to preserve the index state while paging through more than 10,000 hits,
* use the search_after parameter with a point in time (PIT).
*
* The scroll API gets large sets of results from a single scrolling search
* request. To get the necessary scroll ID, submit a search API request that
* includes an argument for the scroll query parameter. The
* scroll parameter indicates how long Elasticsearch should retain
* the search context for the request. The search response returns a scroll ID
* in the _scroll_id response body parameter. You can then use the
* scroll ID with the scroll API to retrieve the next batch of results for the
* request. If the Elasticsearch security features are enabled, the access to
* the results of a specific scroll ID is restricted to the user or API key that
* submitted the search.
*
* You can also use the scroll API to specify a new scroll parameter that
* extends or shortens the retention period for the search context.
*
* IMPORTANT: Results from a scrolling search reflect the state of the index at
* the time of the initial search request. Subsequent indexing or document
* changes only affect later search and scroll requests.
*
* @see API
* specification
*/
@JsonpDeserializable
public class ScrollRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Time scroll;
private final String scrollId;
// ---------------------------------------------------------------------------------------------
private ScrollRequest(Builder builder) {
this.scroll = builder.scroll;
this.scrollId = ApiTypeHelper.requireNonNull(builder.scrollId, this, "scrollId");
}
public static ScrollRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Period to retain the search context for scrolling.
*
* API name: {@code scroll}
*/
@Nullable
public final Time scroll() {
return this.scroll;
}
/**
* Required - Scroll ID of the search.
*
* API name: {@code scroll_id}
*/
public final String scrollId() {
return this.scrollId;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.scroll != null) {
generator.writeKey("scroll");
this.scroll.serialize(generator, mapper);
}
generator.writeKey("scroll_id");
generator.write(this.scrollId);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ScrollRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder implements ObjectBuilder {
@Nullable
private Time scroll;
private String scrollId;
/**
* Period to retain the search context for scrolling.
*
* API name: {@code scroll}
*/
public final Builder scroll(@Nullable Time value) {
this.scroll = value;
return this;
}
/**
* Period to retain the search context for scrolling.
*
* API name: {@code scroll}
*/
public final Builder scroll(Function> fn) {
return this.scroll(fn.apply(new Time.Builder()).build());
}
/**
* Required - Scroll ID of the search.
*
* API name: {@code scroll_id}
*/
public final Builder scrollId(String value) {
this.scrollId = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link ScrollRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ScrollRequest build() {
_checkSingleUse();
return new ScrollRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link ScrollRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
ScrollRequest::setupScrollRequestDeserializer);
protected static void setupScrollRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::scroll, Time._DESERIALIZER, "scroll");
op.add(Builder::scrollId, JsonpDeserializer.stringDeserializer(), "scroll_id");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code scroll}".
*/
public static final SimpleEndpoint _ENDPOINT = new SimpleEndpoint<>("es/scroll",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
return "/_search/scroll";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, ScrollResponse._DESERIALIZER);
/**
* Create an "{@code scroll}" endpoint.
*/
public static Endpoint, ErrorResponse> createScrollEndpoint(
JsonpDeserializer tDocumentDeserializer) {
return _ENDPOINT
.withResponseDeserializer(ScrollResponse.createScrollResponseDeserializer(tDocumentDeserializer));
}
}