Module org.elasticsearch.server
Package org.elasticsearch.index.mapper

Class Uid

java.lang.Object
org.elasticsearch.index.mapper.Uid
public final class Uid extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BASE64_ESCAPE
    Escape byte prepended to base64-decoded IDs when the first byte is >= 0xfd
    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 String
    decodeId(org.apache.lucene.util.BytesRef idBytes)
    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_BYTE

      public static final byte DELIMITER_BYTE
      See Also:

    • BASE64_ESCAPE

      public static final int BASE64_ESCAPE
      Escape byte prepended to base64-decoded IDs when the first byte is >= 0xfd
      See Also:

  • 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

      public static String decodeId(org.apache.lucene.util.BytesRef idBytes)
      Decode an indexed id back to its original form.
      See Also:

    • decodeId

      public static String decodeId(byte[] idBytes)
      Decode an indexed id back to its original form.
      See Also:

    • decodeId

      public static String decodeId(byte[] idBytes, int offset, int length)
      Decode an indexed id back to its original form.
      See Also: