Package org.elasticsearch.index

Class Index

java.lang.Object

org.elasticsearch.index.Index

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class Index
extends Object
implements Writeable, ToXContentObject

A value class representing the basic required properties of an Elasticsearch 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

Modifier and Type	Field	Description
static final Index[]	EMPTY_ARRAY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Index(String name, String uuid)
Index(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static Index	fromXContent(XContentParser parser)
String	getName()
String	getUUID()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.ToXContentObject

isFragment

Field Details

EMPTY_ARRAY

public static final Index[] EMPTY_ARRAY

Constructor Details

Index

public Index(String name,
 String uuid)

Index

public Index(StreamInput in)
      throws IOException

Read from a stream.

Throws:

IOException

Method Details

getName

public String getName()

getUUID

public String getUUID()

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

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static Index fromXContent(XContentParser parser)
                          throws IOException

Throws:

IOException