Package org.opensearch.cluster.metadata

Class IndexMetadata.Builder

java.lang.Object

org.opensearch.cluster.metadata.IndexMetadata.Builder

Enclosing class:

IndexMetadata

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

Builder of index metadata.

Opensearch.api:

Constructor Summary

Constructors

Constructor	Description
Builder(String index)
Builder(IndexMetadata indexMetadata)

Method Summary

Modifier and Type	Method	Description
long	aliasesVersion()
IndexMetadata.Builder	aliasesVersion(long aliasesVersion)
IndexMetadata	build()
IndexMetadata.Builder	creationDate(long creationDate)
static IndexMetadata	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
Set<String>	getInSyncAllocationIds(int shardId)
int	getRoutingNumShards()	Returns number of shards that should be used for routing.
IndexMetadata.Builder	index(String index)
boolean	isSystem()
MappingMetadata	mapping()
long	mappingVersion()
IndexMetadata.Builder	mappingVersion(long mappingVersion)
IndexMetadata.Builder	numberOfReplicas(int numberOfReplicas)
int	numberOfShards()	Returns the number of shards.
IndexMetadata.Builder	numberOfShards(int numberOfShards)
long	primaryTerm(int shardId)	returns the primary term for the given shard.
IndexMetadata.Builder	primaryTerm(int shardId, long primaryTerm)	sets the primary term for the given shard.
IndexMetadata.Builder	putAlias(AliasMetadata aliasMetadata)
IndexMetadata.Builder	putAlias(AliasMetadata.Builder aliasMetadata)
IndexMetadata.Builder	putCustom(String type, Map<String,String> customIndexMetadata)
IndexMetadata.Builder	putInSyncAllocationIds(int shardId, Set<String> allocationIds)
IndexMetadata.Builder	putMapping(String source)
IndexMetadata.Builder	putMapping(MappingMetadata mappingMd)
IndexMetadata.Builder	putRolloverInfo(RolloverInfo rolloverInfo)
IndexMetadata.Builder	removeAlias(String alias)
IndexMetadata.Builder	removeAllAliases()
Map<String,String>	removeCustom(String type)
IndexMetadata.Builder	routingPartitionSize(int routingPartitionSize)
IndexMetadata.Builder	setRoutingNumShards(int routingNumShards)	Sets the number of shards that should be used for routing.
IndexMetadata.Builder	settings(Settings settings)
IndexMetadata.Builder	settings(Settings.Builder settings)
long	settingsVersion()
IndexMetadata.Builder	settingsVersion(long settingsVersion)
IndexMetadata.Builder	state(IndexMetadata.State state)
IndexMetadata.Builder	system(boolean system)
static void	toXContent(IndexMetadata indexMetadata, org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
long	version()
IndexMetadata.Builder	version(long version)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String index)

Builder

public Builder(IndexMetadata indexMetadata)

Method Details

index

public IndexMetadata.Builder index(String index)

numberOfShards

public IndexMetadata.Builder numberOfShards(int numberOfShards)

setRoutingNumShards

public IndexMetadata.Builder setRoutingNumShards(int routingNumShards)

Sets the number of shards that should be used for routing. This should only be used if the number of shards in an index has changed ie if the index is shrunk.

getRoutingNumShards

public int getRoutingNumShards()

Returns number of shards that should be used for routing. By default this method will return the number of shards for this index.

See Also:

• setRoutingNumShards(int)
• numberOfShards()

numberOfShards

public int numberOfShards()

Returns the number of shards.

Returns:

the provided value or -1 if it has not been set.

numberOfReplicas

public IndexMetadata.Builder numberOfReplicas(int numberOfReplicas)

routingPartitionSize

public IndexMetadata.Builder routingPartitionSize(int routingPartitionSize)

creationDate

public IndexMetadata.Builder creationDate(long creationDate)

settings

public IndexMetadata.Builder settings(Settings.Builder settings)

settings

public IndexMetadata.Builder settings(Settings settings)

mapping

public MappingMetadata mapping()

putMapping

public IndexMetadata.Builder putMapping(String source)
                                 throws IOException

Throws:

IOException

putMapping

public IndexMetadata.Builder putMapping(MappingMetadata mappingMd)

state

public IndexMetadata.Builder state(IndexMetadata.State state)

putAlias

public IndexMetadata.Builder putAlias(AliasMetadata aliasMetadata)

putAlias

public IndexMetadata.Builder putAlias(AliasMetadata.Builder aliasMetadata)

removeAlias

public IndexMetadata.Builder removeAlias(String alias)

removeAllAliases

public IndexMetadata.Builder removeAllAliases()

putCustom

public IndexMetadata.Builder putCustom(String type,
 Map<String,String> customIndexMetadata)

removeCustom

public Map<String,String> removeCustom(String type)

getInSyncAllocationIds

public Set<String> getInSyncAllocationIds(int shardId)

putInSyncAllocationIds

public IndexMetadata.Builder putInSyncAllocationIds(int shardId,
 Set<String> allocationIds)

putRolloverInfo

public IndexMetadata.Builder putRolloverInfo(RolloverInfo rolloverInfo)

version

public long version()

version

public IndexMetadata.Builder version(long version)

mappingVersion

public long mappingVersion()

mappingVersion

public IndexMetadata.Builder mappingVersion(long mappingVersion)

settingsVersion

public long settingsVersion()

settingsVersion

public IndexMetadata.Builder settingsVersion(long settingsVersion)

aliasesVersion

public long aliasesVersion()

aliasesVersion

public IndexMetadata.Builder aliasesVersion(long aliasesVersion)

primaryTerm

public long primaryTerm(int shardId)

returns the primary term for the given shard. See IndexMetadata.primaryTerm(int) for more information.

primaryTerm

public IndexMetadata.Builder primaryTerm(int shardId,
 long primaryTerm)

sets the primary term for the given shard. See IndexMetadata.primaryTerm(int) for more information.

system

public IndexMetadata.Builder system(boolean system)

isSystem

public boolean isSystem()

build

public IndexMetadata build()

toXContent

public static void toXContent(IndexMetadata indexMetadata,
 org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                       throws IOException

Throws:

IOException

fromXContent

public static IndexMetadata fromXContent(org.opensearch.core.xcontent.XContentParser parser)
                                  throws IOException

Throws:

IOException