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

Class Alias

java.lang.Object

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

All Implemented Interfaces:

Streamable, ToXContent, ToXContentFragment

public class Alias
extends java.lang.Object
implements Streamable, ToXContentFragment

Represents an alias, to be associated with an index

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Alias(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	filter()	Returns the filter associated with the alias
Alias	filter(java.lang.String filter)	Associates a filter to the alias
Alias	filter(java.util.Map<java.lang.String,java.lang.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()
java.lang.String	indexRouting()	Returns the index routing value associated with the alias
Alias	indexRouting(java.lang.String indexRouting)	Associates an index routing value to the alias
java.lang.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)	Set this object's fields from a StreamInput.
Alias	routing(java.lang.String routing)	Associates a routing value to the alias
java.lang.String	searchRouting()	Returns the search routing value associated with the alias
Alias	searchRouting(java.lang.String searchRouting)	Associates a search routing value to the alias
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.Boolean	writeIndex()
Alias	writeIndex(java.lang.Boolean writeIndex)	Sets whether an alias is pointing to a write-index
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Constructor Detail

Alias

public Alias(java.lang.String name)

Method Detail

name

public java.lang.String name()

Returns the alias name

filter

public java.lang.String filter()

Returns the filter associated with the alias

filter

public Alias filter(java.lang.String filter)

Associates a filter to the alias

filter

public Alias filter(java.util.Map<java.lang.String,java.lang.Object> filter)

Associates a filter to the alias

filter

public Alias filter(QueryBuilder filterBuilder)

Associates a filter to the alias

routing

public Alias routing(java.lang.String routing)

Associates a routing value to the alias

indexRouting

public java.lang.String indexRouting()

Returns the index routing value associated with the alias

indexRouting

public Alias indexRouting(java.lang.String indexRouting)

Associates an index routing value to the alias

searchRouting

public java.lang.String searchRouting()

Returns the search routing value associated with the alias

searchRouting

public Alias searchRouting(java.lang.String searchRouting)

Associates a search routing value to the alias

writeIndex

public java.lang.Boolean writeIndex()

Returns:

the write index flag for the alias

writeIndex

public Alias writeIndex(@Nullable
                        java.lang.Boolean writeIndex)

Sets whether an alias is pointing to a write-index

read

public static Alias read(StreamInput in)
                  throws java.io.IOException

Allows to read an alias from the provided input stream

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException

fromXContent

public static Alias fromXContent(XContentParser parser)
                          throws java.io.IOException

Parses an alias and returns its parsed representation

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object