Package org.opensearch.index.mapper

Class Uid

java.lang.Object

org.opensearch.index.mapper.Uid

public final class Uid
extends Object

A documents OpenSearch id

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
static final char	DELIMITER
static final byte	DELIMITER_BYTE

Method Summary

Modifier and Type	Method	Description
static String	decodeId(byte[] idBytes)	Decode an indexed id back to its original form.
static String	decodeId(byte[] idBytes, int offset, int length)	Decode an indexed id back to its original form.
static org.apache.lucene.util.BytesRef	encodeId(String id)	Encode an id for storage in the index.

Methods inherited from class java.lang.Object

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

Field Details

DELIMITER

public static final char DELIMITER

See Also:

• Constant Field Values

DELIMITER_BYTE

public static final byte DELIMITER_BYTE

See Also:

• Constant Field Values

Method Details

encodeId

public static org.apache.lucene.util.BytesRef encodeId(String id)

Encode an id for storage in the index. This encoding is optimized for numeric and base64 ids, which are encoded in a much denser way than what UTF8 would do.

See Also:

• decodeId(byte[])

decodeId

public static String decodeId(byte[] idBytes)

Decode an indexed id back to its original form.

See Also:

• encodeId(java.lang.String)

decodeId

public static String decodeId(byte[] idBytes,
 int offset,
 int length)

Decode an indexed id back to its original form.

See Also:

• encodeId(java.lang.String)