Package org.springframework.data.elasticsearch.core.index

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[]	getAliases()
Query	getFilterQuery()
Class<?>	getFilterQueryClass()
Boolean	getHidden()
String	getIndexRouting()
String[]	getIndices()
String	getRouting()
String	getSearchRouting()
Boolean	getWriteIndex()

Methods inherited from class java.lang.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

@Nullable
public String[] getAliases()

getHidden

@Nullable
public Boolean getHidden()

getWriteIndex

@Nullable
public Boolean getWriteIndex()

getRouting

@Nullable
public String getRouting()

getIndexRouting

@Nullable
public String getIndexRouting()

getSearchRouting

@Nullable
public String getSearchRouting()

getFilterQuery

@Nullable
public Query getFilterQuery()

getFilterQueryClass

@Nullable
public Class<?> getFilterQueryClass()