Class AliasActionParameters

java.lang.Object

org.springframework.data.elasticsearch.core.index.AliasActionParameters

public class AliasActionParameters
extends Object

Value class capturing the arguments for an AliasAction.

Since:

4.1

Author:

Peter-Josef Meisch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AliasActionParameters.Builder

Method Summary

Modifier and Type	Method	Description
static AliasActionParameters.Builder	builder()
static AliasActionParameters.Builder	builderForTemplate()	a Builder to create AliasActionParameters to be used when creating index templates.
String @Nullable []	getAliases()
@Nullable Query	getFilterQuery()
@Nullable Class<?>	getFilterQueryClass()
@Nullable Boolean	getHidden()
@Nullable String	getIndexRouting()
String[]	getIndices()
@Nullable String	getRouting()
@Nullable String	getSearchRouting()
@Nullable Boolean	getWriteIndex()

Methods inherited from class Object

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

Method Details

builder

public static AliasActionParameters.Builder builder()

builderForTemplate

public static AliasActionParameters.Builder builderForTemplate()

a Builder to create AliasActionParameters to be used when creating index templates. Automatically sets the index name to an empty string, as this is not used in templates

getIndices

public String[] getIndices()

getAliases

public String @Nullable [] getAliases()

getHidden

public @Nullable Boolean getHidden()

getWriteIndex

public @Nullable Boolean getWriteIndex()

getRouting

public @Nullable String getRouting()

getIndexRouting

public @Nullable String getIndexRouting()

getSearchRouting

public @Nullable String getSearchRouting()

getFilterQuery

public @Nullable Query getFilterQuery()

getFilterQueryClass

public @Nullable Class<?> getFilterQueryClass()