Class DeleteRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.core.DeleteRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<DeleteRequest>
- Enclosing class:
- DeleteRequest
public static class DeleteRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<DeleteRequest>
Builder for
DeleteRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description DeleteRequest
build()
Builds aDeleteRequest
.DeleteRequest.Builder
id(java.lang.String value)
Required - The document IDDeleteRequest.Builder
ifPrimaryTerm(java.lang.Long value)
only perform the delete operation if the last operation that has changed the document has the specified primary termDeleteRequest.Builder
ifSeqNo(java.lang.Long value)
only perform the delete operation if the last operation that has changed the document has the specified sequence numberDeleteRequest.Builder
index(java.lang.String value)
Required - The name of the indexDeleteRequest.Builder
refresh(Refresh value)
Iftrue
then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
(the default) then do nothing with refreshes.DeleteRequest.Builder
routing(java.lang.String value)
Specific routing valueDeleteRequest.Builder
timeout(Time value)
Explicit operation timeoutDeleteRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Explicit operation timeoutDeleteRequest.Builder
version(java.lang.Long value)
Explicit version number for concurrency controlDeleteRequest.Builder
versionType(VersionType value)
Specific version typeDeleteRequest.Builder
waitForActiveShards(WaitForActiveShards value)
Sets the number of shard copies that must be active before proceeding with the delete operation.DeleteRequest.Builder
waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)
Sets the number of shard copies that must be active before proceeding with the delete operation.Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
id
Required - The document IDAPI name:
id
-
ifPrimaryTerm
only perform the delete operation if the last operation that has changed the document has the specified primary termAPI name:
if_primary_term
-
ifSeqNo
only perform the delete operation if the last operation that has changed the document has the specified sequence numberAPI name:
if_seq_no
-
index
Required - The name of the indexAPI name:
index
-
refresh
Iftrue
then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
(the default) then do nothing with refreshes.API name:
refresh
-
routing
Specific routing valueAPI name:
routing
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
public final DeleteRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Explicit operation timeoutAPI name:
timeout
-
version
Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
waitForActiveShards
Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set toall
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
waitForActiveShards
public final DeleteRequest.Builder waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set toall
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
build
Builds aDeleteRequest
.- Specified by:
build
in interfaceObjectBuilder<DeleteRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-