java.lang.Object
- org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchIndexSettings

```
public final class ElasticsearchIndexSettings
extends Object
```
Configuration properties for Elasticsearch indexes.
Constants in this class are to be appended to a prefix to form a property key; see IndexSettings for details.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ElasticsearchIndexSettings.Defaults`	Default values for the different settings if no values are given.
`static class`	`ElasticsearchIndexSettings.IndexingRadicals`	Configuration property keys for indexing, without the `prefix`.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ANALYSIS_CONFIGURER`	The analysis configurer applied to this index.
`static String`	`DYNAMIC_MAPPING`	Specify the default behavior to handle dynamically-mapped fields in the Elasticsearch mapping.
`static String`	`INDEXING_MAX_BULK_SIZE`	The maximum size of bulk requests created when processing indexing queues.
`static String`	`INDEXING_PREFIX`	The prefix for indexing-related property keys.
`static String`	`INDEXING_QUEUE_COUNT`	The number of indexing queues assigned to each index.
`static String`	`INDEXING_QUEUE_SIZE`	The size of indexing queues.
`static String`	`SCHEMA_MANAGEMENT_MAPPING_FILE`	The path to a mappings file, allowing to add custom mappings to indexes created by Hibernate Search as part of schema management.
`static String`	`SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS`	The minimal required status of an index on startup, before Hibernate Search can start using it.
`static String`	`SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT`	The timeout when waiting for the `required status`.
`static String`	`SCHEMA_MANAGEMENT_SETTINGS_FILE`	The path to a settings file, allowing to add custom settings to indexes created by Hibernate Search as part of schema management.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ANALYSIS_CONFIGURER
```
public static final String ANALYSIS_CONFIGURER
```
    The analysis configurer applied to this index.
    Expects a reference to a bean of type ElasticsearchAnalysisConfigurer.
    Defaults to no value.
    
    See Also:
    
    The core documentation of configuration properties, which includes a description of the "bean reference" properties and accepted values., Constant Field Values
  - SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS
```
public static final String SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS
```
    The minimal required status of an index on startup, before Hibernate Search can start using it.
    Expects an IndexStatus value, or a String representation of such value.
    Defaults to ElasticsearchIndexSettings.Defaults.SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS.
    
    See Also:
    
    Constant Field Values
  - SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT
```
public static final String SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT
```
    The timeout when waiting for the required status.
    Expects a positive Integer value in milliseconds, such as 60000, or a String that can be parsed into such Integer value.
    Defaults to ElasticsearchIndexSettings.Defaults.SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT.
    
    See Also:
    
    Constant Field Values
  - SCHEMA_MANAGEMENT_SETTINGS_FILE
```
public static final String SCHEMA_MANAGEMENT_SETTINGS_FILE
```
    The path to a settings file, allowing to add custom settings to indexes created by Hibernate Search as part of schema management.
    Expects a string representing the path to a file in the classpath, encoded in UTF-8. The file must contain index settings expressed in JSON format, with the exact same syntax as expected by the Elasticsearch server under the "settings" property when creating an index. For example, if the file content is {"index.codec": "best_compression"}, it will set index.codec to best_compression.
    Note that the settings generated by Hibernate Search will be overridden in case of conflict of some definitions. For instance, if an analyzer "myAnalyzer" is defined by the ANALYSIS_CONFIGURER and this settings file, the definition from the settings file will win. If it is only defined in either the analysis configurer or the settings file, but not both, it will be preserved as-is.
    Defaults to no value. Because by default index settings are generated by Hibernate Search.
    
    See Also:
    
    Constant Field Values
  - SCHEMA_MANAGEMENT_MAPPING_FILE
```
public static final String SCHEMA_MANAGEMENT_MAPPING_FILE
```
    The path to a mappings file, allowing to add custom mappings to indexes created by Hibernate Search as part of schema management.
    Expects a string representing the path to a file in the classpath, encoded in UTF-8. The file must contain index settings expressed in JSON format, with the exact same syntax as expected by the Elasticsearch server under the "mappings" property when defining the mapping for an index.
    The file does not need to contain the full mapping: Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
    Conflicts between the given mapping and the mapping generated by Hibernate Search will be handled as follows:
    
    Mapping parameters other than properties at the mapping root will be those from the given mapping; those generated by Hibernate Search will be ignored.
    
    properties will be merged, using properties defined in both the given mapping and the mapping generated by Hibernate Search. If a property is defined on both sides, mapping parameters from the given mapping will be used, except for properties, which will be merged recursively in the same way.
    
    Defaults to no value. Because by default index mappings are generated by Hibernate Search.
    See Also:
    
    Constant Field Values
  - DYNAMIC_MAPPING
```
public static final String DYNAMIC_MAPPING
```
    Specify the default behavior to handle dynamically-mapped fields in the Elasticsearch mapping.
    Defaults to ElasticsearchIndexSettings.Defaults.DYNAMIC_MAPPING.
    In case of dynamic fields with field templates, the value will be ignored, since this feature requires a DynamicMapping.TRUE to operate.
    
    See Also:
    
    DynamicMapping, Constant Field Values
  - INDEXING_PREFIX
```
public static final String INDEXING_PREFIX
```
    The prefix for indexing-related property keys.
    
    See Also:
    
    Constant Field Values
  - INDEXING_QUEUE_COUNT
```
public static final String INDEXING_QUEUE_COUNT
```
    The number of indexing queues assigned to each index.
    Expects a strictly positive integer value, or a string that can be parsed to such integer value.
    Defaults to ElasticsearchIndexSettings.Defaults.INDEXING_QUEUE_COUNT.
    See the reference documentation, section "Elasticsearch backend - Indexing", for more information about this setting and its implications.
    
    See Also:
    
    Constant Field Values
  - INDEXING_QUEUE_SIZE
```
public static final String INDEXING_QUEUE_SIZE
```
    The size of indexing queues.
    Expects a strictly positive integer value, or a string that can be parsed to such integer value.
    Defaults to ElasticsearchIndexSettings.Defaults.INDEXING_QUEUE_SIZE.
    See the reference documentation, section "Elasticsearch backend - Indexing", for more information about this setting and its implications.
    
    See Also:
    
    Constant Field Values
  - INDEXING_MAX_BULK_SIZE
```
public static final String INDEXING_MAX_BULK_SIZE
```
    The maximum size of bulk requests created when processing indexing queues.
    Expects a strictly positive integer value, or a string that can be parsed to such integer value.
    Defaults to ElasticsearchIndexSettings.Defaults.INDEXING_MAX_BULK_SIZE.
    See the reference documentation, section "Elasticsearch backend - Indexing", for more information about this setting and its implications.
    
    See Also:
    
    Constant Field Values

Class ElasticsearchIndexSettings

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANALYSIS_CONFIGURER

SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS

SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT

SCHEMA_MANAGEMENT_SETTINGS_FILE

SCHEMA_MANAGEMENT_MAPPING_FILE

DYNAMIC_MAPPING

INDEXING_PREFIX

INDEXING_QUEUE_COUNT

INDEXING_QUEUE_SIZE

INDEXING_MAX_BULK_SIZE