ESMetaData (esclientrhl 7.0.2 API)

```
@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface ESMetaData
```
program: esdemo description: es索引元数据的注解，在es entity class上添加 author: X-Pacific zhang create: 2019-01-18 16:12

必需元素概要

所需元素
限定符和类型必需的元素和说明

String indexName
索引名称，必须配置

所需元素
限定符和类型	必需的元素和说明
`String`	`indexName` 索引名称，必须配置

可选元素概要

可选元素
限定符和类型	可选元素和说明
`boolean`	`alias` 别名、如果配置了后续增删改查都基于这个alias 当配置了此项后自动创建索引功能将失效 indexName为aliasName
`String[]`	`aliasIndex` 别名对应的索引名称当前配置仅生效于配置了alias但没有配置rollover 注意：所有配置的index必须存在
`boolean`	`autoCreateIndex` 是否自动创建索引
`boolean`	`autoRollover` 自动执行rollover相关配置自动执行rollover开关
`long`	`autoRolloverInitialDelay` 自动执行rollover相关配置项目启动后延迟autoRolloverInitialDelay时间后开始执行
`long`	`autoRolloverPeriod` 自动执行rollover相关配置项目启动后每间隔autoRolloverPeriod执行一次
`TimeUnit`	`autoRolloverTimeUnit` 自动执行rollover相关配置单位时间配置，与autoRolloverPeriod、autoRolloverInitialDelay对应
`String`	`indexType` 索引类型，可以不配置，不配置默认和indexName相同，墙裂建议每个index下只有一个type
`long`	`maxResultWindow` 最大分页深度
`int`	`number_of_replicas` 备份分片数量
`int`	`number_of_shards` 主分片数量
`boolean`	`printLog` 是否打印日志
`boolean`	`rollover` 当配置了rollover为true时，开启rollover功能（并忽略其他alias的配置） aliasName为indexName 索引名字规格为：indexName-yyyy.mm.dd-00000n 索引滚动生成策略如下
`long`	`rolloverMaxIndexAgeCondition` 当前索引超过此项配置的时间后生成新的索引
`TimeUnit`	`rolloverMaxIndexAgeTimeUnit` 与rolloverMaxIndexAgeCondition联合使用，对应rolloverMaxIndexAgeCondition的单位
`long`	`rolloverMaxIndexDocsCondition` 当前索引文档数量超过此项配置的数字后生成新的索引
`org.elasticsearch.common.unit.ByteSizeUnit`	`rolloverMaxIndexSizeByteSizeUnit` 与rolloverMaxIndexSizeCondition联合使用，对应rolloverMaxIndexSizeCondition的单位
`long`	`rolloverMaxIndexSizeCondition` 当前索引大小超过此项配置的数字后生成新的索引
`String[]`	`searchIndexNames` 检索时的索引名称，如果不配置则默认为和indexName一致，该注解项仅支持搜索并不建议这么做，建议通过特定方法来做跨索引查询
`boolean`	`suffix` 索引名称是否自动包含后缀
`String`	`writeIndex` 当配置了alias后，指定哪个index为writeIndex 当前配置仅生效于配置了alias但没有配置rollover 注意：配置的index必须存在切在aliasIndex中

- 元素详细资料
  - indexName
```
public abstract String indexName
```
    索引名称，必须配置
- - searchIndexNames
```
public abstract String[] searchIndexNames
```
    检索时的索引名称，如果不配置则默认为和indexName一致，该注解项仅支持搜索并不建议这么做，建议通过特定方法来做跨索引查询
    
    默认值:
    
    {}
- - indexType
```
public abstract String indexType
```
    索引类型，可以不配置，不配置默认和indexName相同，墙裂建议每个index下只有一个type
    
    默认值:
    
    ""
- - number_of_shards
```
public abstract int number_of_shards
```
    主分片数量
    
    返回:
    
    默认值:
    
    1
- - number_of_replicas
```
public abstract int number_of_replicas
```
    备份分片数量
    
    返回:
    
    默认值:
    
    1
- - printLog
```
public abstract boolean printLog
```
    是否打印日志
    
    返回:
    
    默认值:
    
    false
- - alias
```
public abstract boolean alias
```
    别名、如果配置了后续增删改查都基于这个alias 当配置了此项后自动创建索引功能将失效 indexName为aliasName
    
    返回:
    
    默认值:
    
    false
- - aliasIndex
```
public abstract String[] aliasIndex
```
    别名对应的索引名称当前配置仅生效于配置了alias但没有配置rollover 注意：所有配置的index必须存在
    
    返回:
    
    默认值:
    
    {}
- - writeIndex
```
public abstract String writeIndex
```
    当配置了alias后，指定哪个index为writeIndex 当前配置仅生效于配置了alias但没有配置rollover 注意：配置的index必须存在切在aliasIndex中
    
    返回:
    
    默认值:
    
    ""
- - rollover
```
public abstract boolean rollover
```
    当配置了rollover为true时，开启rollover功能（并忽略其他alias的配置） aliasName为indexName 索引名字规格为：indexName-yyyy.mm.dd-00000n 索引滚动生成策略如下
    
    返回:
    
    默认值:
    
    false
- - autoRollover
```
public abstract boolean autoRollover
```
    自动执行rollover相关配置自动执行rollover开关
    
    返回:
    
    默认值:
    
    false
- - autoRolloverInitialDelay
```
public abstract long autoRolloverInitialDelay
```
    自动执行rollover相关配置项目启动后延迟autoRolloverInitialDelay时间后开始执行
    
    返回:
    
    默认值:
    
    0L
- - autoRolloverPeriod
```
public abstract long autoRolloverPeriod
```
    自动执行rollover相关配置项目启动后每间隔autoRolloverPeriod执行一次
    
    返回:
    
    默认值:
    
    4L
- - autoRolloverTimeUnit
```
public abstract TimeUnit autoRolloverTimeUnit
```
    自动执行rollover相关配置单位时间配置，与autoRolloverPeriod、autoRolloverInitialDelay对应
    
    返回:
    
    默认值:
    
    java.util.concurrent.TimeUnit.HOURS
- - rolloverMaxIndexAgeCondition
```
public abstract long rolloverMaxIndexAgeCondition
```
    当前索引超过此项配置的时间后生成新的索引
    
    返回:
    
    默认值:
    
    0L
- - rolloverMaxIndexAgeTimeUnit
```
public abstract TimeUnit rolloverMaxIndexAgeTimeUnit
```
    与rolloverMaxIndexAgeCondition联合使用，对应rolloverMaxIndexAgeCondition的单位
    
    返回:
    
    默认值:
    
    java.util.concurrent.TimeUnit.DAYS
- - rolloverMaxIndexDocsCondition
```
public abstract long rolloverMaxIndexDocsCondition
```
    当前索引文档数量超过此项配置的数字后生成新的索引
    
    返回:
    
    默认值:
    
    0L
- - rolloverMaxIndexSizeCondition
```
public abstract long rolloverMaxIndexSizeCondition
```
    当前索引大小超过此项配置的数字后生成新的索引
    
    返回:
    
    默认值:
    
    0L
- - rolloverMaxIndexSizeByteSizeUnit
```
public abstract org.elasticsearch.common.unit.ByteSizeUnit rolloverMaxIndexSizeByteSizeUnit
```
    与rolloverMaxIndexSizeCondition联合使用，对应rolloverMaxIndexSizeCondition的单位
    
    返回:
    
    默认值:
    
    org.elasticsearch.common.unit.ByteSizeUnit.GB
- - maxResultWindow
```
public abstract long maxResultWindow
```
    最大分页深度
    
    返回:
    
    默认值:
    
    10000L
- - suffix
```
public abstract boolean suffix
```
    索引名称是否自动包含后缀
    
    返回:
    
    默认值:
    
    false
- - autoCreateIndex
```
public abstract boolean autoCreateIndex
```
    是否自动创建索引
    
    返回:
    
    默认值:
    
    true

注释类型 ESMetaData

必需元素概要

可选元素概要

元素详细资料

indexName

searchIndexNames

indexType

number_of_shards

number_of_replicas

printLog

alias

aliasIndex

writeIndex

rollover

autoRollover

autoRolloverInitialDelay

autoRolloverPeriod

autoRolloverTimeUnit

rolloverMaxIndexAgeCondition

rolloverMaxIndexAgeTimeUnit

rolloverMaxIndexDocsCondition

rolloverMaxIndexSizeCondition

rolloverMaxIndexSizeByteSizeUnit

maxResultWindow

suffix

autoCreateIndex