Package co.elastic.clients.elasticsearch.core

Class DeleteRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.DeleteRequest

public class DeleteRequest
extends RequestBase

Removes a JSON document from the specified index.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 Endpoint<DeleteRequest,DeleteResponse,ErrorResponse>	_ENDPOINT	Endpoint "delete".

Method Summary

Modifier and Type	Method	Description
final String	id()	Required - Unique identifier for the document.
final Long	ifPrimaryTerm()	Only perform the operation if the document has this primary term.
final Long	ifSeqNo()	Only perform the operation if the document has this sequence number.
final String	index()	Required - Name of the target index.
static DeleteRequest	of(Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)
final Refresh	refresh()	If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes.
final String	routing()	Custom value used to route operations to a specific shard.
final Time	timeout()	Period to wait for active shards.
final Long	version()	Explicit version number for concurrency control.
final VersionType	versionType()	Specific version type: external, external_gte.
final WaitForActiveShards	waitForActiveShards()	The number of shard copies that must be active before proceeding with the operation.

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

_ENDPOINT

public static final Endpoint<DeleteRequest,DeleteResponse,ErrorResponse> _ENDPOINT

Endpoint "delete".

Method Details

of

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

id

public final String id()

Required - Unique identifier for the document.

API name: id

ifPrimaryTerm

@Nullable
public final Long ifPrimaryTerm()

Only perform the operation if the document has this primary term.

API name: if_primary_term

ifSeqNo

@Nullable
public final Long ifSeqNo()

Only perform the operation if the document has this sequence number.

API name: if_seq_no

index

public final String index()

Required - Name of the target index.

API name: index

refresh

@Nullable
public final Refresh refresh()

If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. Valid values: true, false, wait_for.

API name: refresh

routing

@Nullable
public final String routing()

Custom value used to route operations to a specific shard.

API name: routing

timeout

@Nullable
public final Time timeout()

Period to wait for active shards.

API name: timeout

version

@Nullable
public final Long version()

Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.

API name: version

versionType

@Nullable
public final VersionType versionType()

Specific version type: external, external_gte.

API name: version_type

waitForActiveShards

@Nullable
public final WaitForActiveShards waitForActiveShards()

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

API name: wait_for_active_shards