PageStoreOptions (Alluxio Parent 2.6.2 API)

java.lang.Object
- alluxio.client.file.cache.store.PageStoreOptions

Direct Known Subclasses:

LocalPageStoreOptions, RocksPageStoreOptions
```
public abstract class PageStoreOptions
extends Object
```
Options used to instantiate a PageStore.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`mAlluxioVersion` Alluxio client version.
`protected long`	`mCacheSize` Cache size for the data.
`protected double`	`mOverheadRatio` A fraction value representing the storage overhead.
`protected long`	`mPageSize` Page size for the data.
`protected String`	`mRootDir` Root directory where the data is stored.
`protected long`	`mTimeoutDuration` Timeout duration for page store operations in ms.
`protected int`	`mTimeoutThreads` Number of threads for page store operations.

Constructor Summary

Constructors
Constructor and Description

PageStoreOptions()

Constructors
Constructor and Description
`PageStoreOptions()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static PageStoreOptions`	`create(AlluxioConfiguration conf)`
`String`	`getAlluxioVersion()`
`long`	`getCacheSize()`
`double`	`getOverheadRatio()`
`long`	`getPageSize()`
`String`	`getRootDir()`
`long`	`getTimeoutDuration()`
`int`	`getTimeoutThreads()`
`abstract PageStoreType`	`getType()`
`PageStoreOptions`	`setAlluxioVersion(String alluxioVersion)`
`PageStoreOptions`	`setCacheSize(long cacheSize)`
`PageStoreOptions`	`setOverheadRatio(double overheadRatio)`
`PageStoreOptions`	`setPageSize(long pageSize)`
`PageStoreOptions`	`setRootDir(String rootDir)`
`PageStoreOptions`	`setTimeoutDuration(long timeout)`
`PageStoreOptions`	`setTimeoutThreads(int threads)`
`<T> T`	`toOptions()`

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

- Field Detail
  - mRootDir
```
protected String mRootDir
```
    Root directory where the data is stored.
  - mPageSize
```
protected long mPageSize
```
    Page size for the data.
  - mCacheSize
```
protected long mCacheSize
```
    Cache size for the data.
  - mAlluxioVersion
```
protected String mAlluxioVersion
```
    Alluxio client version.
  - mTimeoutDuration
```
protected long mTimeoutDuration
```
    Timeout duration for page store operations in ms.
  - mTimeoutThreads
```
protected int mTimeoutThreads
```
    Number of threads for page store operations.
  - mOverheadRatio
```
protected double mOverheadRatio
```
    A fraction value representing the storage overhead. i.e., with 1GB allocated cache space, and 10% storage overhead we expect no more than 1024MB / (1 + 10%) user data to store
- Constructor Detail
  - PageStoreOptions
```
public PageStoreOptions()
```
- Method Detail
  - create
```
public static PageStoreOptions create(AlluxioConfiguration conf)
```
    Parameters:
    
    conf - configuration
    
    Returns:
    
    a new instance of PageStoreOptions
  - getType
```
public abstract PageStoreType getType()
```
    Returns:
    
    the type corresponding to the page store
  - toOptions
```
public <T> T toOptions()
```
    Type Parameters:
    
    T - The type corresponding to the underlying options
    
    Returns:
    
    the options casted to the required type
  - setRootDir
```
public PageStoreOptions setRootDir(String rootDir)
```
    Parameters:
    
    rootDir - the root directory where pages are stored
    
    Returns:
    
    the updated options
  - getRootDir
```
public String getRootDir()
```
    Returns:
    
    the root directory where pages are stored
  - getPageSize
```
public long getPageSize()
```
    Returns:
    
    the size of the page in bytes
  - setPageSize
```
public PageStoreOptions setPageSize(long pageSize)
```
    Parameters:
    
    pageSize - the size of the page in bytes
    
    Returns:
    
    the updated options
  - getCacheSize
```
public long getCacheSize()
```
    Returns:
    
    the size of the cache in bytes
  - setCacheSize
```
public PageStoreOptions setCacheSize(long cacheSize)
```
    Parameters:
    
    cacheSize - the size of the cache in bytes
    
    Returns:
    
    the updated options
  - getAlluxioVersion
```
public String getAlluxioVersion()
```
    Returns:
    
    the Alluxio client version
  - setAlluxioVersion
```
public PageStoreOptions setAlluxioVersion(String alluxioVersion)
```
    Parameters:
    
    alluxioVersion - Alluxio client version
    
    Returns:
    
    the updated options
  - getTimeoutDuration
```
public long getTimeoutDuration()
```
    Returns:
    
    timeout duration for page store operations in ms
  - setTimeoutDuration
```
public PageStoreOptions setTimeoutDuration(long timeout)
```
    Parameters:
    
    timeout - timeout duration for page store operations in ms
    
    Returns:
    
    the updated options
  - getTimeoutThreads
```
public int getTimeoutThreads()
```
    Returns:
    
    number of threads for handling timeout
  - setTimeoutThreads
```
public PageStoreOptions setTimeoutThreads(int threads)
```
    Parameters:
    
    threads - number of threads for handling timeout
    
    Returns:
    
    the updated options
  - getOverheadRatio
```
public double getOverheadRatio()
```
    Returns:
    
    the fraction of space allocated for storage overhead
  - setOverheadRatio
```
public PageStoreOptions setOverheadRatio(double overheadRatio)
```
    Parameters:
    
    overheadRatio - the fraction of space allocated for storage overhead
    
    Returns:
    
    the updated options

Class PageStoreOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mRootDir

mPageSize

mCacheSize

mAlluxioVersion

mTimeoutDuration

mTimeoutThreads

mOverheadRatio

Constructor Detail

PageStoreOptions

Method Detail

create

getType

toOptions

setRootDir

getRootDir

getPageSize

setPageSize

getCacheSize

setCacheSize

getAlluxioVersion

setAlluxioVersion

getTimeoutDuration

setTimeoutDuration

getTimeoutThreads

setTimeoutThreads

getOverheadRatio

setOverheadRatio