CustomIndexConfiguration (Flowable Work 3.10.0)

java.lang.Object
- com.flowable.indexing.config.CustomIndexConfiguration

```
public class CustomIndexConfiguration
extends Object
```
A custom indexing configuration based on a list of types to be indexed within this index.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`customIndex`
`protected com.fasterxml.jackson.databind.JsonNode`	`customIndexingFilter`
`protected String`	`description`
`protected Map<String,IndexedField>`	`fields`
`protected IndexedDocumentTypeFilter`	`filter`
`static String`	`INDEX_TYPE_ALIAS`
`static String`	`INDEX_TYPE_DEFAULT`
`static String`	`INDEX_TYPE_QUERY`
`protected Map<String,Object>`	`indexSettings`
`protected String`	`key`
`static String`	`KEY_NUMBER_OF_REPLICAS`
`static String`	`KEY_NUMBER_OF_SHARDS`
`static String`	`KEY_REFRESH_INTERVAL`
`protected com.fasterxml.jackson.databind.node.ObjectNode`	`mappings`
`protected String`	`name`
`protected Map<String,ConfigParameter>`	`parameters`
`protected Map<String,SortParameter>`	`sortParameters`
`protected String`	`sourceIndex`
`protected String`	`templateResource`
`protected String`	`type`
`protected int`	`version`

Constructor Summary

Constructors
Constructor and Description

CustomIndexConfiguration()

Constructors
Constructor and Description
`CustomIndexConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCustomIndex()`
`com.fasterxml.jackson.databind.JsonNode`	`getCustomIndexingFilter()`
`String`	`getDescription()`
`Map<String,IndexedField>`	`getFields()`
`IndexedDocumentTypeFilter`	`getFilter()`
`Map<String,Object>`	`getIndexSettings()`
`String`	`getKey()`
`com.fasterxml.jackson.databind.node.ObjectNode`	`getMappings()`
`String`	`getName()`
`Map<String,ConfigParameter>`	`getParameters()`
`String`	`getPublicName()`
`Map<String,SortParameter>`	`getSortParameters()`
`String`	`getSourceIndex()`
`String`	`getTemplateResource()`
`String`	`getType()`
`int`	`getVersion()`
`boolean`	`hasIndexSettings()`
`void`	`initializeConfiguration(IndexManager indexManager)` Must be invoked after fully loading to be initialized.
`boolean`	`isCustomAlias()`
`boolean`	`isIndex()`
`void`	`setCustomIndex(String customIndex)`
`void`	`setCustomIndexingFilter(com.fasterxml.jackson.databind.JsonNode customIndexingFilter)`
`void`	`setDescription(String description)`
`void`	`setFields(Map<String,IndexedField> fields)`
`void`	`setFilter(IndexedDocumentTypeFilter filter)`
`void`	`setIndexSettings(Map<String,Object> indexSettings)`
`void`	`setKey(String key)`
`void`	`setMappings(com.fasterxml.jackson.databind.node.ObjectNode mappings)`
`void`	`setName(String name)`
`void`	`setParameters(Map<String,ConfigParameter> parameters)`
`void`	`setSortParameters(Map<String,SortParameter> sortParameters)`
`void`	`setSourceIndex(String sourceIndex)`
`void`	`setTemplateResource(String templateResource)`
`void`	`setType(String type)`
`void`	`setVersion(int version)`
`void`	`updateFields()`

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

Field Detail

KEY_NUMBER_OF_SHARDS

public static final String KEY_NUMBER_OF_SHARDS

See Also:: Constant Field Values

KEY_NUMBER_OF_REPLICAS

public static final String KEY_NUMBER_OF_REPLICAS

See Also:: Constant Field Values

KEY_REFRESH_INTERVAL

public static final String KEY_REFRESH_INTERVAL

See Also:: Constant Field Values

INDEX_TYPE_QUERY

public static final String INDEX_TYPE_QUERY

See Also:: Constant Field Values

INDEX_TYPE_ALIAS

public static final String INDEX_TYPE_ALIAS

See Also:: Constant Field Values

INDEX_TYPE_DEFAULT

public static final String INDEX_TYPE_DEFAULT

See Also:: Constant Field Values

name
```
protected String name
```

key
```
protected String key
```

description
```
protected String description
```

version
```
protected int version
```

sourceIndex
```
protected String sourceIndex
```

customIndex
```
protected String customIndex
```

type
```
protected String type
```

indexSettings

protected Map<String,Object> indexSettings

filter

protected IndexedDocumentTypeFilter filter

fields

protected Map<String,IndexedField> fields

mappings

protected com.fasterxml.jackson.databind.node.ObjectNode mappings

parameters

protected Map<String,ConfigParameter> parameters

sortParameters

protected Map<String,SortParameter> sortParameters

customIndexingFilter

protected com.fasterxml.jackson.databind.JsonNode customIndexingFilter

templateResource
```
protected String templateResource
```

Constructor Detail
- CustomIndexConfiguration
```
public CustomIndexConfiguration()
```

Method Detail

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getKey
```
public String getKey()
```

setKey
```
public void setKey(String key)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getCustomIndexingFilter

public com.fasterxml.jackson.databind.JsonNode getCustomIndexingFilter()

setCustomIndexingFilter

public void setCustomIndexingFilter(com.fasterxml.jackson.databind.JsonNode customIndexingFilter)

getTemplateResource
```
public String getTemplateResource()
```

setTemplateResource

public void setTemplateResource(String templateResource)

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getParameters

public Map<String,ConfigParameter> getParameters()

setParameters

public void setParameters(Map<String,ConfigParameter> parameters)

getSortParameters

public Map<String,SortParameter> getSortParameters()

setSortParameters

public void setSortParameters(Map<String,SortParameter> sortParameters)

initializeConfiguration
```
public void initializeConfiguration(IndexManager indexManager)
```
Must be invoked after fully loading to be initialized. This method will also invoke the initialize method on all configured types and indexed fields.

getPublicName
```
public String getPublicName()
```

getIndexSettings

public Map<String,Object> getIndexSettings()

getVersion
```
public int getVersion()
```

setVersion
```
public void setVersion(int version)
```

setIndexSettings

public void setIndexSettings(Map<String,Object> indexSettings)

hasIndexSettings
```
public boolean hasIndexSettings()
```

getFilter

public IndexedDocumentTypeFilter getFilter()

setFilter

public void setFilter(IndexedDocumentTypeFilter filter)

setFields

public void setFields(Map<String,IndexedField> fields)

isCustomAlias
```
public boolean isCustomAlias()
```

isIndex
```
public boolean isIndex()
```

getSourceIndex
```
public String getSourceIndex()
```

setSourceIndex

public void setSourceIndex(String sourceIndex)

getCustomIndex
```
public String getCustomIndex()
```

setCustomIndex

public void setCustomIndex(String customIndex)

getMappings

public com.fasterxml.jackson.databind.node.ObjectNode getMappings()

setMappings

public void setMappings(com.fasterxml.jackson.databind.node.ObjectNode mappings)

updateFields
```
public void updateFields()
```

getFields

public Map<String,IndexedField> getFields()

Class CustomIndexConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_NUMBER_OF_SHARDS

KEY_NUMBER_OF_REPLICAS

KEY_REFRESH_INTERVAL

INDEX_TYPE_QUERY

INDEX_TYPE_ALIAS

INDEX_TYPE_DEFAULT

name

key

description

version

sourceIndex

customIndex

type

indexSettings

filter

fields

mappings

parameters

sortParameters

customIndexingFilter

templateResource

Constructor Detail

CustomIndexConfiguration

Method Detail

getName

setName

getKey

setKey

getDescription

setDescription

getCustomIndexingFilter

setCustomIndexingFilter

getTemplateResource

setTemplateResource

getType

setType

getParameters

setParameters

getSortParameters

setSortParameters

initializeConfiguration

getPublicName

getIndexSettings

getVersion

setVersion

setIndexSettings

hasIndexSettings

getFilter

setFilter

setFields

isCustomAlias

isIndex

getSourceIndex

setSourceIndex

getCustomIndex

setCustomIndex

getMappings

setMappings

updateFields

getFields