Package org.opensearch.cluster.metadata

Class IndexGraveyard.Builder

java.lang.Object

org.opensearch.cluster.metadata.IndexGraveyard.Builder

Enclosing class:

IndexGraveyard

@PublicApi(since="1.0.0")
public static final class IndexGraveyard.Builder
extends Object

A class to build an IndexGraveyard.

Opensearch.api:

Method Summary

Modifier and Type	Method	Description
IndexGraveyard.Builder	addTombstone(org.opensearch.core.index.Index index)	Add a deleted index to the list of tombstones in the cluster state.
IndexGraveyard.Builder	addTombstones(Collection<org.opensearch.core.index.Index> indices)	Add a set of deleted indexes to the list of tombstones in the cluster state.
IndexGraveyard	build()
IndexGraveyard	build(Settings settings)
int	getNumPurged()	Get the number of tombstones that were purged.
List<IndexGraveyard.Tombstone>	tombstones()	A copy of the current tombstones in the builder.

Methods inherited from class java.lang.Object

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

Method Details

tombstones

public List<IndexGraveyard.Tombstone> tombstones()

A copy of the current tombstones in the builder.

addTombstone

public IndexGraveyard.Builder addTombstone(org.opensearch.core.index.Index index)

Add a deleted index to the list of tombstones in the cluster state.

addTombstones

public IndexGraveyard.Builder addTombstones(Collection<org.opensearch.core.index.Index> indices)

Add a set of deleted indexes to the list of tombstones in the cluster state.

getNumPurged

public int getNumPurged()

Get the number of tombstones that were purged. This should *only* be called after build() has been called.

build

public IndexGraveyard build()

build

public IndexGraveyard build(Settings settings)