public interface FamilyDescriptor
extends java.lang.Cloneable
Modifier and Type | Interface and Description |
---|---|
static class |
FamilyDescriptor.Compression |
Modifier and Type | Method and Description |
---|---|
FamilyDescriptor |
clone()
Creates and returns a copy of this FamilyDescriptor.
|
FamilyDescriptor.Compression |
getCompression() |
org.ojai.FieldPath |
getJsonFieldPath() |
java.lang.String |
getName() |
long |
getTTL() |
boolean |
hasName() |
boolean |
isInMemory() |
FamilyDescriptor |
setCompression(FamilyDescriptor.Compression compression)
Sets the
FamilyDescriptor.Compression scheme used to store data in the family |
FamilyDescriptor |
setInMemory(boolean inMemory)
Sets whether preference is given to data of this family when data is evicted from the
in-memory cache.
|
FamilyDescriptor |
setJsonFieldPath(org.ojai.FieldPath fieldPath)
Sets the JSON field path of this family
|
FamilyDescriptor |
setJsonFieldPath(java.lang.String fieldPath)
Sets the JSON field path of this family
|
FamilyDescriptor |
setName(java.lang.String name)
Sets the name of this family.
|
FamilyDescriptor |
setTTL(long ttlInSec)
Sets the Time-To-Live for the data stored in this family
|
boolean hasName()
java.lang.String getName()
FamilyDescriptor setName(java.lang.String name)
name
- family namethis
for chain invocationorg.ojai.FieldPath getJsonFieldPath()
FamilyDescriptor setJsonFieldPath(java.lang.String fieldPath)
fieldPath
- this
for chain invocationFamilyDescriptor setJsonFieldPath(org.ojai.FieldPath fieldPath)
fieldPath
- this
for chain invocationlong getTTL()
FamilyDescriptor setTTL(long ttlInSec)
ttlInSec
- time to live in secondsthis
for chain invocationboolean isInMemory()
true
if higher preference is given to the data stored in this family while
evicting data from in-memory cacheFamilyDescriptor setInMemory(boolean inMemory)
inMemory
- this
for chain invocationFamilyDescriptor.Compression getCompression()
FamilyDescriptor.Compression
scheme used to store data in the familyFamilyDescriptor setCompression(FamilyDescriptor.Compression compression)
FamilyDescriptor.Compression
scheme used to store data in the familycompression
- the Compression schemethis
for chain invocationFamilyDescriptor clone()