Module org.elasticsearch.server

Package org.elasticsearch.action.delete

Class DeleteRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestLazyBuilder<Request,Response>

org.elasticsearch.action.support.replication.ReplicationRequestBuilder<DeleteRequest,DeleteResponse,DeleteRequestBuilder>

org.elasticsearch.action.delete.DeleteRequestBuilder

All Implemented Interfaces:

RequestBuilder<DeleteRequest,DeleteResponse>, WriteRequestBuilder<DeleteRequestBuilder>

public class DeleteRequestBuilder
extends ReplicationRequestBuilder<DeleteRequest,DeleteResponse,DeleteRequestBuilder>
implements WriteRequestBuilder<DeleteRequestBuilder>

A delete document action request builder.

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestLazyBuilder

action, client

Constructor Summary

Constructors

Constructor	Description
DeleteRequestBuilder(ElasticsearchClient client, String index)

Method Summary

Modifier and Type	Method	Description
DeleteRequest	request()	This method creates the request.
DeleteRequestBuilder	setId(String id)	Sets the id of the document to delete.
DeleteRequestBuilder	setIfPrimaryTerm(long term)	only perform this delete request if the document was last modification was assigned the given primary term.
DeleteRequestBuilder	setIfSeqNo(long seqNo)	only perform this delete request if the document was last modification was assigned the given sequence number.
DeleteRequestBuilder	setRefreshPolicy(String refreshPolicy)	Parse the refresh policy from a string, only modifying it if the string is non null.
DeleteRequestBuilder	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)	Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).
DeleteRequestBuilder	setRouting(String routing)	Controls the shard routing of the delete request.
DeleteRequestBuilder	setVersion(long version)	Sets the version, which will cause the delete operation to only be performed if a matching version exists and no changes happened on the doc since then.
DeleteRequestBuilder	setVersionType(VersionType versionType)	Sets the type of versioning to use.

Methods inherited from class org.elasticsearch.action.support.replication.ReplicationRequestBuilder

apply, getIndex, setIndex, setTimeout, setTimeout, setWaitForActiveShards, setWaitForActiveShards

Methods inherited from class org.elasticsearch.action.ActionRequestLazyBuilder

execute, execute, get, get

Methods inherited from class java.lang.Object

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

Constructor Details

DeleteRequestBuilder

public DeleteRequestBuilder(ElasticsearchClient client,
 @Nullable
 String index)

Method Details

setId

public DeleteRequestBuilder setId(String id)

Sets the id of the document to delete.

setRouting

public DeleteRequestBuilder setRouting(String routing)

Controls the shard routing of the delete request. Using this value to hash the shard and not the id.

setVersion

public DeleteRequestBuilder setVersion(long version)

Sets the version, which will cause the delete operation to only be performed if a matching version exists and no changes happened on the doc since then.

setVersionType

public DeleteRequestBuilder setVersionType(VersionType versionType)

Sets the type of versioning to use. Defaults to VersionType.INTERNAL.

setIfSeqNo

public DeleteRequestBuilder setIfSeqNo(long seqNo)

only perform this delete request if the document was last modification was assigned the given sequence number. Must be used in combination with setIfPrimaryTerm(long) If the document last modification was assigned a different sequence number a VersionConflictEngineException will be thrown.

setIfPrimaryTerm

public DeleteRequestBuilder setIfPrimaryTerm(long term)

only perform this delete request if the document was last modification was assigned the given primary term. Must be used in combination with setIfSeqNo(long) If the document last modification was assigned a different term a VersionConflictEngineException will be thrown.

setRefreshPolicy

public DeleteRequestBuilder setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Description copied from interface: WriteRequestBuilder

Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).

Specified by:

setRefreshPolicy in interface WriteRequestBuilder<DeleteRequestBuilder>

setRefreshPolicy

public DeleteRequestBuilder setRefreshPolicy(String refreshPolicy)

Description copied from interface: WriteRequestBuilder

Parse the refresh policy from a string, only modifying it if the string is non null. Convenient to use with request parsing.

Specified by:

setRefreshPolicy in interface WriteRequestBuilder<DeleteRequestBuilder>

request

public DeleteRequest request()

Description copied from class: ActionRequestLazyBuilder

This method creates the request. The caller of this method is responsible for calling Request#decRef.

Specified by:

request in interface RequestBuilder<DeleteRequest,DeleteResponse>

Specified by:

request in interface WriteRequestBuilder<DeleteRequestBuilder>

Specified by:

request in class ActionRequestLazyBuilder<DeleteRequest,DeleteResponse>

Returns:

A newly-built Request, fully initialized by this builder.