Package org.opensearch.action.admin.indices.create

Class CreateIndexClusterStateUpdateRequest

java.lang.Object

org.opensearch.cluster.ack.ClusterStateUpdateRequest<CreateIndexClusterStateUpdateRequest>

org.opensearch.action.admin.indices.create.CreateIndexClusterStateUpdateRequest

All Implemented Interfaces:

AckedRequest

public class CreateIndexClusterStateUpdateRequest
extends ClusterStateUpdateRequest<CreateIndexClusterStateUpdateRequest>

Cluster state update request that allows to create an index

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
CreateIndexClusterStateUpdateRequest(String cause, String index, String providedName)

Method Summary

Modifier and Type	Method	Description
Set<Alias>	aliases()
CreateIndexClusterStateUpdateRequest	aliases(Set<Alias> aliases)
Set<ClusterBlock>	blocks()
String	cause()
boolean	copySettings()
CreateIndexClusterStateUpdateRequest	copySettings(boolean copySettings)
String	dataStreamName()	Returns the name of the data stream this new index will be part of.
CreateIndexClusterStateUpdateRequest	dataStreamName(String dataStreamName)
String	getProvidedName()	The name that was provided by the user.
String	index()
String	mappings()
CreateIndexClusterStateUpdateRequest	mappings(String mappings)
Index	recoverFrom()
CreateIndexClusterStateUpdateRequest	recoverFrom(Index recoverFrom)
ResizeType	resizeType()	Returns the resize type or null if this is an ordinary create index request
CreateIndexClusterStateUpdateRequest	resizeType(ResizeType resizeType)
Settings	settings()
CreateIndexClusterStateUpdateRequest	settings(Settings settings)
String	toString()
ActiveShardCount	waitForActiveShards()
CreateIndexClusterStateUpdateRequest	waitForActiveShards(ActiveShardCount waitForActiveShards)

Methods inherited from class org.opensearch.cluster.ack.ClusterStateUpdateRequest

ackTimeout, ackTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.cluster.ack.AckedRequest

clusterManagerNodeTimeout

Constructor Details

CreateIndexClusterStateUpdateRequest

public CreateIndexClusterStateUpdateRequest(String cause,
 String index,
 String providedName)

Method Details

settings

public CreateIndexClusterStateUpdateRequest settings(Settings settings)

mappings

public CreateIndexClusterStateUpdateRequest mappings(String mappings)

aliases

public CreateIndexClusterStateUpdateRequest aliases(Set<Alias> aliases)

recoverFrom

public CreateIndexClusterStateUpdateRequest recoverFrom(Index recoverFrom)

waitForActiveShards

public CreateIndexClusterStateUpdateRequest waitForActiveShards(ActiveShardCount waitForActiveShards)

resizeType

public CreateIndexClusterStateUpdateRequest resizeType(ResizeType resizeType)

copySettings

public CreateIndexClusterStateUpdateRequest copySettings(boolean copySettings)

cause

public String cause()

index

public String index()

settings

public Settings settings()

mappings

public String mappings()

aliases

public Set<Alias> aliases()

blocks

public Set<ClusterBlock> blocks()

recoverFrom

public Index recoverFrom()

getProvidedName

public String getProvidedName()

The name that was provided by the user. This might contain a date math expression.

See Also:

• IndexMetadata.SETTING_INDEX_PROVIDED_NAME

waitForActiveShards

public ActiveShardCount waitForActiveShards()

resizeType

public ResizeType resizeType()

Returns the resize type or null if this is an ordinary create index request

copySettings

public boolean copySettings()

dataStreamName

public String dataStreamName()

Returns the name of the data stream this new index will be part of. If this new index will not be part of a data stream then this returns null.

dataStreamName

public CreateIndexClusterStateUpdateRequest dataStreamName(String dataStreamName)

toString

public String toString()

Overrides:

toString in class Object