Class SearchProperties

java.lang.Object
io.jmix.search.SearchProperties

@ConfigurationProperties(prefix="jmix.search") public class SearchProperties extends Object
  • Field Details

    • searchResultPageSize

      protected final int searchResultPageSize
      Max amount of objects displayed on single page of search result.
    • maxSearchPageCount

      protected final int maxSearchPageCount
      Max amount of result pages.
    • searchReloadEntitiesBatchSize

      protected final int searchReloadEntitiesBatchSize
      Batch size for post-search entity processing.
    • processQueueBatchSize

      protected final int processQueueBatchSize
      Amount of queue items processed in single batch.
    • reindexEntityEnqueueBatchSize

      protected final int reindexEntityEnqueueBatchSize
      Amount of entity instances enqueued in single batch during entity reindex process.
    • changedEntitiesIndexingEnabled

      protected final boolean changedEntitiesIndexingEnabled
      Whether automatic indexing of changed entities is enabled.
    • useDefaultIndexingQueueProcessingQuartzConfiguration

      protected final boolean useDefaultIndexingQueueProcessingQuartzConfiguration
      Whether the default Indexing Queue processing quartz scheduling configuration is used.
    • useDefaultEnqueueingSessionProcessingQuartzConfiguration

      protected final boolean useDefaultEnqueueingSessionProcessingQuartzConfiguration
      Whether the default Enqueueing Session processing quartz scheduling configuration is used.
    • enqueueIndexAllOnStartupIndexRecreationEnabled

      protected final boolean enqueueIndexAllOnStartupIndexRecreationEnabled
      Whether all entity instances related to indexes created or recreated on startup should be enqueued automatically.
    • restHighLevelClientApiCompatibilityModeEnabled

      protected final boolean restHighLevelClientApiCompatibilityModeEnabled
      Whether the Rest High Level Client should be able to communicate with Elasticsearch version 8.x. Note that when compatibility mode is enabled, the Rest High Level Client not able to communicate with Elasticsearch version lower than 7.11.
    • elasticsearch

      protected final SearchProperties.Elasticsearch elasticsearch
    • defaultSearchStrategy

      protected final String defaultSearchStrategy
      Name of default search strategy
    • indexingQueueProcessingCron

      protected final String indexingQueueProcessingCron
      CRON expression that is used by default Indexing Queue processing quartz scheduling configuration.
    • enqueueingSessionProcessingCron

      protected final String enqueueingSessionProcessingCron
      CRON expression that is used by default Enqueueing Session processing quartz scheduling configuration.
    • searchIndexNamePrefix

      protected final String searchIndexNamePrefix
      Prefix for search index name. Index naming template: <prefix><entity_name>. Default prefix is 'search_index_'.
    • indexSchemaManagementStrategy

      protected final IndexSchemaManagementStrategy indexSchemaManagementStrategy
      The way of index schema synchronization.
    • enqueueIndexAllOnStartupIndexRecreationEntities

      protected final List<String> enqueueIndexAllOnStartupIndexRecreationEntities
      List of entities that should be automatically enqueued on startup in case of index recreation. Empty list means all indexed entities.
  • Constructor Details

    • SearchProperties

      public SearchProperties(@DefaultValue("100") int searchResultPageSize, @DefaultValue("100") int maxSearchPageCount, @DefaultValue("100") int searchReloadEntitiesBatchSize, @DefaultValue("100") int processQueueBatchSize, @DefaultValue("100") int reindexEntityEnqueueBatchSize, @DefaultValue("true") boolean changedEntitiesIndexingEnabled, @DefaultValue("true") boolean useDefaultIndexingQueueProcessingQuartzConfiguration, @DefaultValue("true") boolean useDefaultEnqueueingSessionProcessingQuartzConfiguration, @DefaultValue("true") boolean enqueueIndexAllOnStartupIndexRecreationEnabled, @DefaultValue("true") boolean restHighLevelClientApiCompatibilityModeEnabled, @DefaultValue("") String enqueueIndexAllOnStartupIndexRecreationEntities, @DefaultValue("search_index_") String searchIndexNamePrefix, @DefaultValue("anyTermAnyField") String defaultSearchStrategy, @DefaultValue("create-or-recreate") String indexSchemaManagementStrategy, @DefaultValue("0/5 * * * * ?") String indexingQueueProcessingCron, @DefaultValue("0/5 * * * * ?") String enqueueingSessionProcessingCron, @DefaultValue SearchProperties.Elasticsearch elasticsearch)
  • Method Details