Package org.opensearch.client.opensearch.core

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeleteRequest	build()	Builds a DeleteRequest.
DeleteRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DeleteRequest.Builder	id(String value)	Required - Unique identifier for the document.
final DeleteRequest.Builder	ifPrimaryTerm(Long value)	Only perform the operation if the document has this primary term.
final DeleteRequest.Builder	ifSeqNo(Long value)	Only perform the operation if the document has this sequence number.
final DeleteRequest.Builder	index(String value)	Required - Name of the target index.
final DeleteRequest.Builder	refresh(Refresh value)	If true, OpenSearch 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 DeleteRequest.Builder	routing(String value, String... values)	Custom value used to route operations to a specific shard.
final DeleteRequest.Builder	routing(List<String> list)	Custom value used to route operations to a specific shard.
protected DeleteRequest.Builder	self()
final DeleteRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for active shards.
final DeleteRequest.Builder	timeout(Time value)	Period to wait for active shards.
final DeleteRequest.Builder	version(Long value)	Explicit version number for concurrency control.
final DeleteRequest.Builder	versionType(VersionType value)	Specific version type: external, external_gte.
final DeleteRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operation.
final DeleteRequest.Builder	waitForActiveShards(WaitForActiveShards value)	The 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, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public DeleteRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<DeleteRequest.Builder,DeleteRequest>

Returns:

a new builder instance.

self

@Nonnull
protected DeleteRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<DeleteRequest.Builder>

id

@Nonnull
public final DeleteRequest.Builder id(String value)

Required - Unique identifier for the document.

API name: id

ifPrimaryTerm

@Nonnull
public final DeleteRequest.Builder ifPrimaryTerm(@Nullable
 Long value)

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

API name: if_primary_term

ifSeqNo

@Nonnull
public final DeleteRequest.Builder ifSeqNo(@Nullable
 Long value)

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

API name: if_seq_no

index

@Nonnull
public final DeleteRequest.Builder index(String value)

Required - Name of the target index.

API name: index

refresh

@Nonnull
public final DeleteRequest.Builder refresh(@Nullable
 Refresh value)

If true, OpenSearch 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

@Nonnull
public final DeleteRequest.Builder routing(List<String> list)

Custom value used to route operations to a specific shard.

API name: routing

Adds all elements of list to routing.

routing

@Nonnull
public final DeleteRequest.Builder routing(String value,
 String... values)

Custom value used to route operations to a specific shard.

API name: routing

Adds one or more values to routing.

timeout

@Nonnull
public final DeleteRequest.Builder timeout(@Nullable
 Time value)

Period to wait for active shards.

API name: timeout

timeout

@Nonnull
public final DeleteRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for active shards.

API name: timeout

version

@Nonnull
public final DeleteRequest.Builder version(@Nullable
 Long value)

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

@Nonnull
public final DeleteRequest.Builder versionType(@Nullable
 VersionType value)

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

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

build

@Nonnull
public DeleteRequest build()

Builds a DeleteRequest.

Specified by:

build in interface ObjectBuilder<DeleteRequest>

Throws:

NullPointerException - if some of the required fields are null.