ElasticSearchIndexConfig (Nuxeo ECM Projects 7.10 API)

java.lang.Object
- org.nuxeo.elasticsearch.config.ElasticSearchIndexConfig

public class ElasticSearchIndexConfig
extends Object

XMap descriptor for configuring an index

Author:: Tiry

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`create`
`static String`	`DEFAULT_MAPPING`
`static String`	`DEFAULT_SETTING`
`protected String[]`	`excludes`
`protected String[]`	`includes`
`protected boolean`	`isEnabled`
`protected String`	`mapping`
`protected String`	`name`
`protected String`	`repositoryName`
`protected String`	`settings`
`protected String`	`type`

Constructor Summary

Constructors
Constructor and Description

ElasticSearchIndexConfig()

Constructors
Constructor and Description
`ElasticSearchIndexConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`getExcludes()`
`String[]`	`getIncludes()`
`String`	`getMapping()`
`String`	`getName()`
`String`	`getRepositoryName()`
`String`	`getSettings()`
`String`	`getType()`
`boolean`	`isDocumentIndex()` Return true if the index/mapping is associated with a Nuxeo document repository
`boolean`	`isEnabled()`
`void`	`merge(ElasticSearchIndexConfig other)` Use `other` mapping and settings if not defined.
`boolean`	`mustCreate()`
`void`	`setEnabled(boolean isEnabled)`
`String`	`toString()`

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

Field Detail

isEnabled
```
protected boolean isEnabled
```

name
```
protected String name
```

repositoryName
```
protected String repositoryName
```

type
```
protected String type
```

create
```
protected boolean create
```

settings
```
protected String settings
```

DEFAULT_SETTING

public static final String DEFAULT_SETTING

See Also:: Constant Field Values

mapping
```
protected String mapping
```

DEFAULT_MAPPING

public static final String DEFAULT_MAPPING

See Also:: Constant Field Values

excludes
```
protected String[] excludes
```

includes
```
protected String[] includes
```

Constructor Detail
- ElasticSearchIndexConfig
```
public ElasticSearchIndexConfig()
```

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

getExcludes
```
public String[] getExcludes()
```

getIncludes
```
public String[] getIncludes()
```

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

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

getSettings
```
public String getSettings()
```

getMapping
```
public String getMapping()
```

mustCreate
```
public boolean mustCreate()
```

getRepositoryName
```
public String getRepositoryName()
```

isEnabled
```
public boolean isEnabled()
```

setEnabled

public void setEnabled(boolean isEnabled)

isDocumentIndex
```
public boolean isDocumentIndex()
```
Return true if the index/mapping is associated with a Nuxeo document repository

Since:

7.4

merge

public void merge(ElasticSearchIndexConfig other)

Use other mapping and settings if not defined.

Class ElasticSearchIndexConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isEnabled

name

repositoryName

type

create

settings

DEFAULT_SETTING

mapping

DEFAULT_MAPPING

excludes

includes

Constructor Detail

ElasticSearchIndexConfig

Method Detail

toString

getExcludes

getIncludes

getName

getType

getSettings

getMapping

mustCreate

getRepositoryName

isEnabled

setEnabled

isDocumentIndex

merge