co.elastic.clients.elasticsearch.core.ClearScrollRequest 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.
*/
package co.elastic.clients.elasticsearch.core;
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.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.List;
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.clear_scroll.Request
/**
* Clear a scrolling search.
*
* Clear the search context and results for a scrolling search.
*
* @see API
* specification
*/
@JsonpDeserializable
public class ClearScrollRequest extends RequestBase implements JsonpSerializable {
private final List scrollId;
// ---------------------------------------------------------------------------------------------
private ClearScrollRequest(Builder builder) {
this.scrollId = ApiTypeHelper.unmodifiable(builder.scrollId);
}
public static ClearScrollRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Scroll IDs to clear. To clear all scroll IDs, use _all.
*
* API name: {@code scroll_id}
*/
public final List 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 (ApiTypeHelper.isDefined(this.scrollId)) {
generator.writeKey("scroll_id");
generator.writeStartArray();
for (String item0 : this.scrollId) {
generator.write(item0);
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ClearScrollRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private List scrollId;
/**
* Scroll IDs to clear. To clear all scroll IDs, use _all.
*
* API name: {@code scroll_id}
*
* Adds all elements of list to scrollId.
*/
public final Builder scrollId(List list) {
this.scrollId = _listAddAll(this.scrollId, list);
return this;
}
/**
* Scroll IDs to clear. To clear all scroll IDs, use _all.
*
* API name: {@code scroll_id}
*
* Adds one or more values to scrollId.
*/
public final Builder scrollId(String value, String... values) {
this.scrollId = _listAdd(this.scrollId, value, values);
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link ClearScrollRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ClearScrollRequest build() {
_checkSingleUse();
return new ClearScrollRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link ClearScrollRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, ClearScrollRequest::setupClearScrollRequestDeserializer);
protected static void setupClearScrollRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::scrollId, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"scroll_id");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code clear_scroll}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/clear_scroll",
// Request method
request -> {
return "DELETE";
},
// Request path
request -> {
return "/_search/scroll";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, ClearScrollResponse._DESERIALIZER);
}