TranslogConfig (server 7.4.2 API)

java.lang.Object
- org.elasticsearch.index.translog.TranslogConfig

public final class TranslogConfig
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field Description

static ByteSizeValue DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors
Constructor	Description
`TranslogConfig(ShardId shardId, java.nio.file.Path translogPath, IndexSettings indexSettings, BigArrays bigArrays)`	Creates a new TranslogConfig instance

Method Summary

Modifier and Type	Method	Description
`BigArrays`	`getBigArrays()`	Returns a BigArrays instance for this engine
`ByteSizeValue`	`getBufferSize()`	The translog buffer size.
`IndexSettings`	`getIndexSettings()`	Returns the index indexSettings
`ShardId`	`getShardId()`	Returns the shard ID this config is created for
`java.nio.file.Path`	`getTranslogPath()`	Returns the translog path for this engine

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

- Field Detail
  - DEFAULT_BUFFER_SIZE
```
public static final ByteSizeValue DEFAULT_BUFFER_SIZE
```
- Constructor Detail
  - TranslogConfig
```
public TranslogConfig(ShardId shardId,
                      java.nio.file.Path translogPath,
                      IndexSettings indexSettings,
                      BigArrays bigArrays)
```
    Creates a new TranslogConfig instance
    
    Parameters:
    
    shardId - the shard ID this translog belongs to
    
    translogPath - the path to use for the transaction log files
    
    indexSettings - the index settings used to set internal variables
    
    bigArrays - a bigArrays instance used for temporarily allocating write operations
- Method Detail
  - getIndexSettings
```
public IndexSettings getIndexSettings()
```
    Returns the index indexSettings
  - getShardId
```
public ShardId getShardId()
```
    Returns the shard ID this config is created for
  - getBigArrays
```
public BigArrays getBigArrays()
```
    Returns a BigArrays instance for this engine
  - getTranslogPath
```
public java.nio.file.Path getTranslogPath()
```
    Returns the translog path for this engine
  - getBufferSize
```
public ByteSizeValue getBufferSize()
```
    The translog buffer size. Default is 8kb