Package org.redisson.api.search.index

Interface TagIndex

All Superinterfaces:
FieldIndex
All Known Implementing Classes:
TagIndexParams
public interface TagIndex extends FieldIndex
Tag field index options.
Author:
Nikita Koksharov

  • Method Details

    • as

      TagIndex as(String as)
      Defines the attribute associated to the field name
      Parameters:
      as - the associated attribute
      Returns:
      options object

    • separator

      TagIndex separator(String separator)
      Defines separator used for splitting the value of this attribute. The separator value must be a single character.

      Default is ,

      Parameters:
      separator - separator value
      Returns:
      options object

    • sortMode

      TagIndex sortMode(SortMode sortMode)
      Defines sort mode applied to the value of this attribute
      Parameters:
      sortMode - sort mode
      Returns:
      options object

    • caseSensitive

      TagIndex caseSensitive()
      Defines whether to keep the original letter cases of the tags. If not defined, the characters are converted to lowercase.
      Returns:
      options object

    • noIndex

      TagIndex noIndex()
      Defines to not index this attribute
      Returns:
      options object

    • withSuffixTrie

      TagIndex withSuffixTrie()
      Defines whether to keep a suffix trie with all terms which match the suffix.
      Returns:
      options object

    • indexEmpty

      TagIndex indexEmpty()
      Defines whether to index an empty value.
      Returns:
      options object

    • indexMissing

      TagIndex indexMissing()
      Defines to index documents that don't contain this attribute
      Returns:
      options object