Package io.quarkus.hibernate.search.standalone.elasticsearch.runtime

Interface HibernateSearchStandaloneRuntimeConfig

@ConfigMapping(prefix="quarkus.hibernate-search-standalone")
@ConfigRoot(phase=RUN_TIME)
public interface HibernateSearchStandaloneRuntimeConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HibernateSearchStandaloneRuntimeConfig.IndexingConfig
static interface	HibernateSearchStandaloneRuntimeConfig.IndexingPlanConfig
static interface	HibernateSearchStandaloneRuntimeConfig.IndexingPlanSynchronizationConfig
static interface	HibernateSearchStandaloneRuntimeConfig.SchemaManagementConfig

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	active()	Whether Hibernate Search Standalone should be active at runtime.
static String	backendPropertyKey(String backendName, String indexName, String radical)
@WithUnnamedKey Map<String,io.quarkus.hibernate.search.backend.elasticsearch.common.runtime.HibernateSearchBackendElasticsearchRuntimeConfig>	backends()	Configuration for Elasticsearch/OpenSearch backends.
static List<String>	defaultBackendPropertyKeys(String radical)
static String	extensionPropertyKey(String radical)
HibernateSearchStandaloneRuntimeConfig.IndexingConfig	indexing()	Configuration for indexing.
static String	mapperPropertyKey(String radical)
static List<String>	mapperPropertyKeys(String radical)
HibernateSearchStandaloneRuntimeConfig.SchemaManagementConfig	schemaManagement()	Configuration for automatic creation and validation of the Elasticsearch schema: indexes, their mapping, their settings.

Method Details

active

@ConfigDocDefault("\'true\' if Hibernate Search Standalone is enabled; \'false\' otherwise")
Optional<Boolean> active()

Whether Hibernate Search Standalone should be active at runtime. If Hibernate Search Standalone is not active, it won't start with the application, and accessing the SearchMapping for search or other operations will not be possible. Note that if Hibernate Search Standalone is disabled (i.e. `quarkus.hibernate-search-standalone.enabled` is set to `false`), it won't be active, and setting this property to `true` will fail.

backends

@ConfigDocSection
@WithName("elasticsearch")
@WithUnnamedKey
@ConfigDocMapKey("backend-name")
@WithUnnamedKey Map<String,io.quarkus.hibernate.search.backend.elasticsearch.common.runtime.HibernateSearchBackendElasticsearchRuntimeConfig> backends()

Configuration for Elasticsearch/OpenSearch backends.

schemaManagement

HibernateSearchStandaloneRuntimeConfig.SchemaManagementConfig schemaManagement()

Configuration for automatic creation and validation of the Elasticsearch schema: indexes, their mapping, their settings.

indexing

HibernateSearchStandaloneRuntimeConfig.IndexingConfig indexing()

Configuration for indexing.

extensionPropertyKey

static String extensionPropertyKey(String radical)

mapperPropertyKey

static String mapperPropertyKey(String radical)

mapperPropertyKeys

static List<String> mapperPropertyKeys(String radical)

backendPropertyKey

static String backendPropertyKey(String backendName,
 String indexName,
 String radical)

defaultBackendPropertyKeys

static List<String> defaultBackendPropertyKeys(String radical)