org.elasticsearch.action.admin.indices.alias

Class Alias

java.lang.Object

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

All Implemented Interfaces:

Streamable

public class Alias
extends Object
implements Streamable

Represents an alias, to be associated with an index

Constructor Summary

Constructors

Constructor and Description
Alias(String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	filter() Returns the filter associated with the alias
Alias	filter(Map<String,Object> filter) Associates a filter to the alias
Alias	filter(QueryBuilder filterBuilder) Associates a filter to the alias
Alias	filter(String filter) 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
String	name() Returns the alias name
static Alias	read(StreamInput in) Allows to read an alias from the provided input stream
void	readFrom(StreamInput in)
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
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

Alias

public Alias(String name)

Method Detail

name

public String name()

Returns the alias name

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

read

public static Alias read(StreamInput in)
                  throws IOException

Allows to read an alias from the provided input stream

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

fromXContent

public static Alias fromXContent(XContentParser parser)
                          throws IOException

Parses an alias and returns its parsed representation

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object