Package co.elastic.clients.elasticsearch.core

Class ClosePointInTimeRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.ClosePointInTimeRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ClosePointInTimeRequest
extends RequestBase
implements JsonpSerializable

Close a point in time.

A point in time must be opened explicitly before being used in search requests. The keep_alive parameter tells Elasticsearch how long it should persist. A point in time is automatically closed when the keep_alive period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClosePointInTimeRequest.Builder	Builder for ClosePointInTimeRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ClosePointInTimeRequest>	_DESERIALIZER	Json deserializer for ClosePointInTimeRequest
static final Endpoint<ClosePointInTimeRequest,ClosePointInTimeResponse,ErrorResponse>	_ENDPOINT	Endpoint "close_point_in_time".

Method Summary

Modifier and Type	Method	Description
final String	id()	Required - The ID of the point-in-time.
static ClosePointInTimeRequest	of(Function<ClosePointInTimeRequest.Builder,ObjectBuilder<ClosePointInTimeRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupClosePointInTimeRequestDeserializer(ObjectDeserializer<ClosePointInTimeRequest.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ClosePointInTimeRequest> _DESERIALIZER

Json deserializer for ClosePointInTimeRequest

_ENDPOINT

public static final Endpoint<ClosePointInTimeRequest,ClosePointInTimeResponse,ErrorResponse> _ENDPOINT

Endpoint "close_point_in_time".

Method Details

of

public static ClosePointInTimeRequest of(Function<ClosePointInTimeRequest.Builder,ObjectBuilder<ClosePointInTimeRequest>> fn)

id

public final String id()

Required - The ID of the point-in-time.

API name: id

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupClosePointInTimeRequestDeserializer

protected static void setupClosePointInTimeRequestDeserializer(ObjectDeserializer<ClosePointInTimeRequest.Builder> op)