Package org.opensearch.core.index

Class Index

java.lang.Object

org.opensearch.core.index.Index

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

@PublicApi(since="1.0.0")
public class Index
extends Object
implements Writeable, ToXContentObject

A value class representing the basic required properties of an OpenSearch index.

(This class is immutable.)

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Index[]	EMPTY_ARRAY
static final String	UNKNOWN_INDEX_NAME

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Index(String name, String uuid)	Creates a new Index instance with name and unique identifier
Index(StreamInput in)	Creates a new Index instance from a StreamInput.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Checks if this index is the same as another index by comparing the name and unique identifier.
static Index	fromXContent(XContentParser parser)
String	getName()	Gets the name of the index.
String	getUUID()	Gets the unique identifier of the index.
int	hashCode()
String	toString()	Returns either the name and unique identifier of the index or only the name if the uuid is Strings.UNKNOWN_UUID_VALUE.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Writes the name and unique identifier to the StreamOutput

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

EMPTY_ARRAY

public static final Index[] EMPTY_ARRAY

UNKNOWN_INDEX_NAME

public static final String UNKNOWN_INDEX_NAME

See Also:

• Constant Field Values

Constructor Details

Index

public Index(String name,
 String uuid)

Creates a new Index instance with name and unique identifier

Parameters:

name - the name of the index

uuid - the unique identifier of the index

Throws:

NullPointerException - if either name or uuid are null

Index

public Index(StreamInput in)
      throws IOException

Creates a new Index instance from a StreamInput. Reads the name and unique identifier from the stream.

Parameters:

in - the stream to read from

Throws:

IOException - if an error occurs while reading from the stream

See Also:

• writeTo(StreamOutput)

Method Details

getName

public String getName()

Gets the name of the index.

Returns:

the name of the index.

getUUID

public String getUUID()

Gets the unique identifier of the index.

Returns:

the unique identifier of the index. "_na_" if Strings.UNKNOWN_UUID_VALUE.

toString

public String toString()

Returns either the name and unique identifier of the index or only the name if the uuid is Strings.UNKNOWN_UUID_VALUE.

If we have a uuid we put it in the toString so it'll show up in logs which is useful as more and more things use the uuid rather than the name as the lookup key for the index.

Overrides:

toString in class Object

Returns:

"[name/uuid]" or "[name]"

equals

public boolean equals(Object o)

Checks if this index is the same as another index by comparing the name and unique identifier. If both uuid are Strings.UNKNOWN_UUID_VALUE then only the name is compared.

Overrides:

equals in class Object

Parameters:

o - the index to compare to

Returns:

true if the name and unique identifier are the same, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Writes the name and unique identifier to the StreamOutput

Specified by:

writeTo in interface Writeable

Parameters:

out - The stream to write to

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