Package org.opensearch.client.opensearch.core.pit

Class DeletePitRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.pit.DeletePitRequest

All Implemented Interfaces:

JsonpSerializable

public class DeletePitRequest
extends RequestBase
implements JsonpSerializable

Deletes PITs on the OpenSearch cluster

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<DeletePitRequest,DeletePitResponse,ErrorResponse>	_ENDPOINT

Constructor Summary

Constructors

Constructor	Description
DeletePitRequest(DeletePitRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static DeletePitRequest	of(java.util.function.Function<DeletePitRequest.Builder,ObjectBuilder<DeletePitRequest>> fn)
java.util.List<java.lang.String>	pitId()	A list of Pit IDs to be deleted
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<DeletePitRequest,DeletePitResponse,ErrorResponse> _ENDPOINT

Constructor Detail

DeletePitRequest

public DeletePitRequest(DeletePitRequest.Builder builder)

Method Detail

of

public static DeletePitRequest of(java.util.function.Function<DeletePitRequest.Builder,ObjectBuilder<DeletePitRequest>> fn)

pitId

@Nullable
public final java.util.List<java.lang.String> pitId()

A list of Pit IDs to be deleted

API name - pit_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)