Package org.opensearch.client.opensearch.core

Class DeletePitRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.DeletePitRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<DeletePitRequest.Builder,DeletePitRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class DeletePitRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<DeletePitRequest.Builder,DeletePitRequest>

Deletes one or more point in time searches based on the IDs passed.

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 final JsonpDeserializer<DeletePitRequest>	_DESERIALIZER	Json deserializer for DeletePitRequest
static final Endpoint<DeletePitRequest,DeletePitResponse,ErrorResponse>	_ENDPOINT	Endpoint "delete_pit".

Method Summary

Modifier and Type	Method	Description
static DeletePitRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static DeletePitRequest	of(Function<DeletePitRequest.Builder,ObjectBuilder<DeletePitRequest>> fn)
final List<String>	pitId()	Required - API name: pit_id
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	setupDeletePitRequestDeserializer(ObjectDeserializer<DeletePitRequest.Builder> op)
DeletePitRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DeletePitRequest> _DESERIALIZER

Json deserializer for DeletePitRequest

_ENDPOINT

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

Endpoint "delete_pit".

Method Details

of

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

pitId

@Nonnull
public final List<String> pitId()

Required - 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)

toBuilder

@Nonnull
public DeletePitRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeletePitRequest.Builder,DeletePitRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static DeletePitRequest.Builder builder()

setupDeletePitRequestDeserializer

protected static void setupDeletePitRequestDeserializer(ObjectDeserializer<DeletePitRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object