Class DeleteRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<DeleteRequest.Builder>
org.opensearch.client.opensearch.core.DeleteRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<DeleteRequest.Builder,,DeleteRequest> MutableBuilder<DeleteRequest.Builder,,DeleteRequest> ObjectBuilder<DeleteRequest>
- Enclosing class:
DeleteRequest
public static class DeleteRequest.Builder
extends RequestBase.AbstractBuilder<DeleteRequest.Builder>
implements CopyableBuilder<DeleteRequest.Builder,DeleteRequest>
Builder for
DeleteRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aDeleteRequest.copy()Create a new builderCopyableBuilderthat is a copy of this one.final DeleteRequest.BuilderRequired - Unique identifier for the document.final DeleteRequest.BuilderifPrimaryTerm(Long value) Only perform the operation if the document has this primary term.final DeleteRequest.BuilderOnly perform the operation if the document has this sequence number.final DeleteRequest.BuilderRequired - Name of the target index.final DeleteRequest.BuilderIftrue, OpenSearch refreshes the affected shards to make this operation visible to search, ifwait_forthen wait for a refresh to make this operation visible to search, iffalsedo nothing with refreshes.final DeleteRequest.BuilderCustom value used to route operations to a specific shard.final DeleteRequest.BuilderCustom value used to route operations to a specific shard.protected DeleteRequest.Builderself()final DeleteRequest.BuilderPeriod to wait for active shards.final DeleteRequest.BuilderPeriod to wait for active shards.final DeleteRequest.BuilderExplicit version number for concurrency control.final DeleteRequest.BuilderversionType(VersionType value) Specific version type:external,external_gte.final DeleteRequest.BuilderThe number of shard copies that must be active before proceeding with the operation.final DeleteRequest.BuilderThe number of shard copies that must be active before proceeding with the operation.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder
errorTrace, humanMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<DeleteRequest.Builder,DeleteRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<DeleteRequest.Builder>
-
id
Required - Unique identifier for the document.API name:
id -
ifPrimaryTerm
Only perform the operation if the document has this primary term.API name:
if_primary_term -
ifSeqNo
Only perform the operation if the document has this sequence number.API name:
if_seq_no -
index
Required - Name of the target index.API name:
index -
refresh
Iftrue, OpenSearch refreshes the affected shards to make this operation visible to search, ifwait_forthen wait for a refresh to make this operation visible to search, iffalsedo nothing with refreshes. Valid values:true,false,wait_for.API name:
refresh -
routing
Custom value used to route operations to a specific shard.API name:
routingAdds all elements of
listtorouting. -
routing
Custom value used to route operations to a specific shard.API name:
routingAdds one or more values to
routing. -
timeout
Period to wait for active shards.API name:
timeout -
timeout
Period to wait for active shards.API name:
timeout -
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
Specific version type:external,external_gte.API name:
version_type -
waitForActiveShards
@Nonnull public final DeleteRequest.Builder waitForActiveShards(@Nullable WaitForActiveShards value) The number of shard copies that must be active before proceeding with the operation. Set toallor any positive integer up to the total number of shards in the index (number_of_replicas+1).API name:
wait_for_active_shards -
waitForActiveShards
@Nonnull public final DeleteRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) The number of shard copies that must be active before proceeding with the operation. Set toallor any positive integer up to the total number of shards in the index (number_of_replicas+1).API name:
wait_for_active_shards -
build
Builds aDeleteRequest.- Specified by:
buildin interfaceObjectBuilder<DeleteRequest>- Throws:
NullPointerException- if some of the required fields are null.
-