Package org.elasticsearch.action.admin.indices.alias

Class Alias

java.lang.Object

org.elasticsearch.action.admin.indices.alias.Alias

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class Alias
extends Object
implements Writeable, ToXContentFragment

Represents an alias, to be associated with an index

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Alias(String name)
Alias(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	filter()	Returns the filter associated with the alias
Alias	filter(String filter)	Associates a filter to the alias
Alias	filter(Map<String,Object> filter)	Associates a filter to the alias
Alias	filter(QueryBuilder filterBuilder)	Associates a filter to the alias
static Alias	fromXContent(XContentParser parser)	Parses an alias and returns its parsed representation
int	hashCode()
String	indexRouting()	Returns the index routing value associated with the alias
Alias	indexRouting(String indexRouting)	Associates an index routing value to the alias
Boolean	isHidden()
Alias	isHidden(Boolean isHidden)	Sets whether this alias is hidden
String	name()	Returns the alias name
Alias	name(String name)	Modify the alias name only
Alias	routing(String routing)	Associates a routing value to the alias
String	searchRouting()	Returns the search routing value associated with the alias
Alias	searchRouting(String searchRouting)	Associates a search routing value to the alias
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Boolean	writeIndex()
Alias	writeIndex(Boolean writeIndex)	Sets whether an alias is pointing to a write-index
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

Alias

public Alias(StreamInput in)
      throws IOException

Throws:

IOException

Alias

public Alias(String name)

Method Details

name

public String name()

Returns the alias name

name

public Alias name(String name)

Modify the alias name only

filter

public String filter()

Returns the filter associated with the alias

filter

public Alias filter(String filter)

Associates a filter to the alias

filter

public Alias filter(Map<String,Object> filter)

Associates a filter to the alias

filter

public Alias filter(QueryBuilder filterBuilder)

Associates a filter to the alias

routing

public Alias routing(String routing)

Associates a routing value to the alias

indexRouting

public String indexRouting()

Returns the index routing value associated with the alias

indexRouting

public Alias indexRouting(String indexRouting)

Associates an index routing value to the alias

searchRouting

public String searchRouting()

Returns the search routing value associated with the alias

searchRouting

public Alias searchRouting(String searchRouting)

Associates a search routing value to the alias

writeIndex

public Boolean writeIndex()

Returns:

the write index flag for the alias

writeIndex

public Alias writeIndex(@Nullable
 Boolean writeIndex)

Sets whether an alias is pointing to a write-index

isHidden

public Boolean isHidden()

Returns:

whether this alias is hidden or not

isHidden

public Alias isHidden(@Nullable
 Boolean isHidden)

Sets whether this alias is hidden

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

fromXContent

public static Alias fromXContent(XContentParser parser)
                          throws IOException

Parses an alias and returns its parsed representation

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object