SearchOptions (Hazelcast Root 5.6.0 API)

@Beta public interface SearchOptions

Vector search options

Since:: 5.5

Method Summary

Modifier and Type

Method

Description

static SearchOptionsBuilder

builder()

Map<String,String>

getHints()

int

getLimit()

boolean

isIncludeValue()

boolean

isIncludeVectors()

static SearchOptions

of(int limit, boolean includeValue, boolean includeVectors)

SearchOptionsBuilder

toBuilder()

Method Details
- isIncludeValue
  
  boolean isIncludeValue()
  
  Returns:
  
  true if search results should include the user-supplied value or false if only keys should be returned.
- isIncludeVectors
  
  boolean isIncludeVectors()
  
  Returns:
  
  true if search results should include the vectors associated with each search result, false otherwise.
- getLimit
  
  int getLimit()
  
  Returns:
  
  the number of search results to return
- getHints
  
  Map<String,String> getHints()
  
  Returns:
  
  hints for search execution
- toBuilder
  
  SearchOptionsBuilder toBuilder()
  
  Returns:
  
  SearchOptionsBuilder with the same settings
  
  Since:
  
  5.6
- builder
  
  static SearchOptionsBuilder builder()
  
  Returns:
  
  builder of SearchOptions
- of
  
  static SearchOptions of(int limit, boolean includeValue, boolean includeVectors)