ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor (Apache HBase 3.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor

All Implemented Interfaces:

Comparable<ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor>, ColumnFamilyDescriptor

Enclosing class:

ColumnFamilyDescriptorBuilder
```
@InterfaceAudience.Private
public static class ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor
extends Object
implements ColumnFamilyDescriptor, Comparable<ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor>
```
An ModifyableFamilyDescriptor contains information about a column family such as the number of versions, compression settings, etc. It is used as input when creating a table or adding a column. TODO: make this package-private after removing the HColumnDescriptor

Field Summary

Fields
Modifier and Type	Field and Description
`private Map<String,String>`	`configuration` A map which holds the configuration specific to the column family.
`private byte[]`	`name`
`private Map<Bytes,Bytes>`	`values`

Fields inherited from interface org.apache.hadoop.hbase.client.ColumnFamilyDescriptor
COMPARATOR, COMPARATOR_IGNORE_REPLICATION, REPLICATION_SCOPE_BYTES

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ModifyableColumnFamilyDescriptor(byte[] name)` Construct a column descriptor specifying only the family name The other attributes are defaulted.
`private`	`ModifyableColumnFamilyDescriptor(byte[] name, Map<Bytes,Bytes> values, Map<String,String> config)`
	`ModifyableColumnFamilyDescriptor(ColumnFamilyDescriptor desc)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor other)`
`boolean`	`equals(Object obj)`
`int`	`getBlocksize()`
`BloomType`	`getBloomFilterType()`
`Compression.Algorithm`	`getCompactionCompressionType()`
`Compression.Algorithm`	`getCompressionType()`
`Map<String,String>`	`getConfiguration()`
`String`	`getConfigurationValue(String key)`
`DataBlockEncoding`	`getDataBlockEncoding()`
`short`	`getDFSReplication()`
`byte[]`	`getEncryptionKey()`
`String`	`getEncryptionType()`
`MemoryCompactionPolicy`	`getInMemoryCompaction()`
`KeepDeletedCells`	`getKeepDeletedCells()`
`int`	`getMaxVersions()`
`int`	`getMinVersions()`
`MobCompactPartitionPolicy`	`getMobCompactPartitionPolicy()` Get the mob compact partition policy for this family
`long`	`getMobThreshold()` Gets the mob threshold of the family.
`byte[]`	`getName()`
`String`	`getNameAsString()`
`private <T> T`	`getOrDefault(Bytes key, Function<byte[],T> function, T defaultValue)`
`int`	`getScope()`
`String`	`getStoragePolicy()` Not using `enum` here because HDFS is not using `enum` for storage policy, see org.apache.hadoop.hdfs.server.blockmanagement.BlockStoragePolicySuite for more details.
`private <T> T`	`getStringOrDefault(Bytes key, Function<String,T> function, T defaultValue)`
`int`	`getTimeToLive()`
`byte[]`	`getValue(byte[] key)`
`Bytes`	`getValue(Bytes key)`
`Map<Bytes,Bytes>`	`getValues()` It clone all bytes of all elements.
`private StringBuilder`	`getValues(boolean printDefaults)`
`int`	`hashCode()`
`boolean`	`isBlockCacheEnabled()`
`boolean`	`isCacheBloomsOnWrite()`
`boolean`	`isCacheDataOnWrite()`
`boolean`	`isCacheIndexesOnWrite()`
`boolean`	`isCompressTags()`
`boolean`	`isEvictBlocksOnClose()`
`boolean`	`isInMemory()`
`boolean`	`isMobEnabled()` Gets whether the mob is enabled for the family.
`boolean`	`isNewVersionBehavior()` By default, HBase only consider timestamp in versions.
`boolean`	`isPrefetchBlocksOnOpen()`
`private static ColumnFamilyDescriptor`	`parseFrom(byte[] bytes)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`removeConfiguration(String key)` Remove a configuration setting represented by the key from the `configuration` map.
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`removeValue(Bytes key)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setBlockCacheEnabled(boolean blockCacheEnabled)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setBlocksize(int s)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setBloomFilterType(BloomType bt)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setCacheBloomsOnWrite(boolean value)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setCacheDataOnWrite(boolean value)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setCacheIndexesOnWrite(boolean value)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setCompactionCompressionType(Compression.Algorithm type)` Compression types supported in hbase.
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setCompressionType(Compression.Algorithm type)` Compression types supported in hbase.
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setCompressTags(boolean compressTags)` Set whether the tags should be compressed along with DataBlockEncoding.
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setConfiguration(String key, String value)` Setter for storing a configuration setting in `configuration` map.
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setDataBlockEncoding(DataBlockEncoding type)` Set data block encoding algorithm used in block cache.
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setDFSReplication(short replication)` Set the replication factor to hfile(s) belonging to this family
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setEncryptionKey(byte[] keyBytes)` Set the raw crypto key attribute for the family
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setEncryptionType(String algorithm)` Set the encryption algorithm for use with this family
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setEvictBlocksOnClose(boolean value)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setInMemory(boolean inMemory)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setInMemoryCompaction(MemoryCompactionPolicy inMemoryCompaction)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setKeepDeletedCells(KeepDeletedCells keepDeletedCells)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setMaxVersions(int maxVersions)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setMinVersions(int minVersions)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setMobCompactPartitionPolicy(MobCompactPartitionPolicy policy)` Set the mob compact partition policy for the family.
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setMobEnabled(boolean isMobEnabled)` Enables the mob for the family.
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setMobThreshold(long threshold)` Sets the mob threshold of the family.
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setNewVersionBehavior(boolean newVersionBehavior)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setPrefetchBlocksOnOpen(boolean value)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setScope(int scope)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setStoragePolicy(String policy)` Set the storage policy for use with this family
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setTimeToLive(int timeToLive)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setTimeToLive(String timeToLive)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setValue(byte[] key, byte[] value)`
`private ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setValue(Bytes key, Bytes value)`
`private ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setValue(Bytes key, String value)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setValue(String key, String value)`
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setVersions(int minVersions, int maxVersions)` Set minimum and maximum versions to keep
`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`setVersionsWithTimeToLive(int retentionInterval, int versionAfterInterval)` Retain all versions for a given TTL(retentionInterval), and then only a specific number of versions(versionAfterInterval) after that interval elapses.
`private byte[]`	`toByteArray()`
`private static <T> Bytes`	`toBytesOrNull(T t, Function<T,byte[]> f)`
`String`	`toString()`
`String`	`toStringCustomizedValues()`

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

- Field Detail
  - name
```
private final byte[] name
```
  - values
```
private final Map<Bytes,Bytes> values
```
  - configuration
```
private final Map<String,String> configuration
```
    A map which holds the configuration specific to the column family. The keys of the map have the same names as config keys and override the defaults with cf-specific settings. Example usage may be for compactions, etc.
- Constructor Detail
  - ModifyableColumnFamilyDescriptor
```
@InterfaceAudience.Private
public ModifyableColumnFamilyDescriptor(byte[] name)
```
    Construct a column descriptor specifying only the family name The other attributes are defaulted.
    
    Parameters:
    
    name - Column family name. Must be 'printable' -- digit or letter -- and may not contain a : TODO: make this private after the HCD is removed.
  - ModifyableColumnFamilyDescriptor
```
@InterfaceAudience.Private
public ModifyableColumnFamilyDescriptor(ColumnFamilyDescriptor desc)
```
    Constructor. Makes a deep copy of the supplied descriptor. TODO: make this private after the HCD is removed.
    
    Parameters:
    
    desc - The descriptor.
  - ModifyableColumnFamilyDescriptor
```
private ModifyableColumnFamilyDescriptor(byte[] name,
                                         Map<Bytes,Bytes> values,
                                         Map<String,String> config)
```
- Method Detail
  - getName
```
public byte[] getName()
```
    Specified by:
    
    getName in interface ColumnFamilyDescriptor
    
    Returns:
    
    a copy of Name of this column family
  - getNameAsString
```
public String getNameAsString()
```
    Specified by:
    
    getNameAsString in interface ColumnFamilyDescriptor
    
    Returns:
    
    Name of this column family
  - getValue
```
public Bytes getValue(Bytes key)
```
    Specified by:
    
    getValue in interface ColumnFamilyDescriptor
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    A clone value. Null if no mapping for the key
  - getValue
```
public byte[] getValue(byte[] key)
```
    Specified by:
    
    getValue in interface ColumnFamilyDescriptor
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    A clone value. Null if no mapping for the key
  - getValues
```
public Map<Bytes,Bytes> getValues()
```
    Description copied from interface: ColumnFamilyDescriptor
    
    It clone all bytes of all elements.
    
    Specified by:
    
    getValues in interface ColumnFamilyDescriptor
    
    Returns:
    
    All values
  - setValue
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setValue(byte[] key,
                                                                               byte[] value)
```
    Parameters:
    
    key - The key.
    
    value - The value.
    
    Returns:
    
    this (for chained invocation)
  - setValue
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setValue(String key,
                                                                               String value)
```
  - setValue
```
private ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setValue(Bytes key,
                                                                                String value)
```
  - setValue
```
private ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setValue(Bytes key,
                                                                                Bytes value)
```
    Parameters:
    
    key - The key.
    
    value - The value.
    
    Returns:
    
    this (for chained invocation)
  - removeValue
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor removeValue(Bytes key)
```
    Parameters:
    
    key - Key whose key and value we're to remove from HCD parameters.
    
    Returns:
    
    this (for chained invocation)
  - toBytesOrNull
```
private static <T> Bytes toBytesOrNull(T t,
                                       Function<T,byte[]> f)
```
  - getStringOrDefault
```
private <T> T getStringOrDefault(Bytes key,
                                 Function<String,T> function,
                                 T defaultValue)
```
  - getOrDefault
```
private <T> T getOrDefault(Bytes key,
                           Function<byte[],T> function,
                           T defaultValue)
```
  - getMaxVersions
```
public int getMaxVersions()
```
    Specified by:
    
    getMaxVersions in interface ColumnFamilyDescriptor
    
    Returns:
    
    maximum number of versions
  - setMaxVersions
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMaxVersions(int maxVersions)
```
    Parameters:
    
    maxVersions - maximum number of versions
    
    Returns:
    
    this (for chained invocation)
  - setVersions
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setVersions(int minVersions,
                                                                                  int maxVersions)
```
    Set minimum and maximum versions to keep
    
    Parameters:
    
    minVersions - minimal number of versions
    
    maxVersions - maximum number of versions
    
    Returns:
    
    this (for chained invocation)
  - getBlocksize
```
public int getBlocksize()
```
    Specified by:
    
    getBlocksize in interface ColumnFamilyDescriptor
    
    Returns:
    
    The storefile/hfile blocksize for this column family.
  - setBlocksize
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setBlocksize(int s)
```
    Parameters:
    
    s - Blocksize to use when writing out storefiles/hfiles on this column family.
    
    Returns:
    
    this (for chained invocation)
  - getCompressionType
```
public Compression.Algorithm getCompressionType()
```
    Specified by:
    
    getCompressionType in interface ColumnFamilyDescriptor
    
    Returns:
    
    Compression type setting.
  - setCompressionType
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCompressionType(Compression.Algorithm type)
```
    Compression types supported in hbase. LZO is not bundled as part of the hbase distribution. See See LZO Compression for how to enable it.
    
    Parameters:
    
    type - Compression type setting.
    
    Returns:
    
    this (for chained invocation)
  - getDataBlockEncoding
```
public DataBlockEncoding getDataBlockEncoding()
```
    Specified by:
    
    getDataBlockEncoding in interface ColumnFamilyDescriptor
    
    Returns:
    
    the data block encoding algorithm used in block cache and optionally on disk
  - setDataBlockEncoding
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setDataBlockEncoding(DataBlockEncoding type)
```
    Set data block encoding algorithm used in block cache.
    
    Parameters:
    
    type - What kind of data block encoding will be used.
    
    Returns:
    
    this (for chained invocation)
  - setCompressTags
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCompressTags(boolean compressTags)
```
    Set whether the tags should be compressed along with DataBlockEncoding. When no DataBlockEncoding is been used, this is having no effect.
    
    Parameters:
    
    compressTags -
    
    Returns:
    
    this (for chained invocation)
  - isCompressTags
```
public boolean isCompressTags()
```
    Specified by:
    
    isCompressTags in interface ColumnFamilyDescriptor
    
    Returns:
    
    Whether KV tags should be compressed along with DataBlockEncoding. When no DataBlockEncoding is been used, this is having no effect.
  - getCompactionCompressionType
```
public Compression.Algorithm getCompactionCompressionType()
```
    Specified by:
    
    getCompactionCompressionType in interface ColumnFamilyDescriptor
    
    Returns:
    
    Compression type setting.
  - setCompactionCompressionType
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCompactionCompressionType(Compression.Algorithm type)
```
    Compression types supported in hbase. LZO is not bundled as part of the hbase distribution. See See LZO Compression for how to enable it.
    
    Parameters:
    
    type - Compression type setting.
    
    Returns:
    
    this (for chained invocation)
  - isInMemory
```
public boolean isInMemory()
```
    Specified by:
    
    isInMemory in interface ColumnFamilyDescriptor
    
    Returns:
    
    True if we are to favor keeping all values for this column family in the HRegionServer cache.
  - setInMemory
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setInMemory(boolean inMemory)
```
    Parameters:
    
    inMemory - True if we are to favor keeping all values for this column family in the HRegionServer cache
    
    Returns:
    
    this (for chained invocation)
  - getInMemoryCompaction
```
public MemoryCompactionPolicy getInMemoryCompaction()
```
    Specified by:
    
    getInMemoryCompaction in interface ColumnFamilyDescriptor
    
    Returns:
    
    in-memory compaction policy if set for the cf. Returns null if no policy is set for for this column family
  - setInMemoryCompaction
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setInMemoryCompaction(MemoryCompactionPolicy inMemoryCompaction)
```
    Parameters:
    
    inMemoryCompaction - the prefered in-memory compaction policy for this column family
    
    Returns:
    
    this (for chained invocation)
  - getKeepDeletedCells
```
public KeepDeletedCells getKeepDeletedCells()
```
    Specified by:
    
    getKeepDeletedCells in interface ColumnFamilyDescriptor
    
    Returns:
    
    return the KeepDeletedCells
  - setKeepDeletedCells
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setKeepDeletedCells(KeepDeletedCells keepDeletedCells)
```
    Parameters:
    
    keepDeletedCells - True if deleted rows should not be collected immediately.
    
    Returns:
    
    this (for chained invocation)
  - isNewVersionBehavior
```
public boolean isNewVersionBehavior()
```
    By default, HBase only consider timestamp in versions. So a previous Delete with higher ts will mask a later Put with lower ts. Set this to true to enable new semantics of versions. We will also consider mvcc in versions. See HBASE-15968 for details.
    
    Specified by:
    
    isNewVersionBehavior in interface ColumnFamilyDescriptor
  - setNewVersionBehavior
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setNewVersionBehavior(boolean newVersionBehavior)
```
  - getTimeToLive
```
public int getTimeToLive()
```
    Specified by:
    
    getTimeToLive in interface ColumnFamilyDescriptor
    
    Returns:
    
    Time-to-live of cell contents, in seconds.
  - setTimeToLive
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setTimeToLive(int timeToLive)
```
    Parameters:
    
    timeToLive - Time-to-live of cell contents, in seconds.
    
    Returns:
    
    this (for chained invocation)
  - setTimeToLive
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setTimeToLive(String timeToLive)
                                                                             throws HBaseException
```
    Parameters:
    
    timeToLive - Time-to-live of cell contents, in seconds.
    
    Returns:
    
    this (for chained invocation)
    
    Throws:
    
    HBaseException
  - getMinVersions
```
public int getMinVersions()
```
    Specified by:
    
    getMinVersions in interface ColumnFamilyDescriptor
    
    Returns:
    
    The minimum number of versions to keep.
  - setMinVersions
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMinVersions(int minVersions)
```
    Parameters:
    
    minVersions - The minimum number of versions to keep. (used when timeToLive is set)
    
    Returns:
    
    this (for chained invocation)
  - setVersionsWithTimeToLive
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setVersionsWithTimeToLive(int retentionInterval,
                                                                                                int versionAfterInterval)
```
    Retain all versions for a given TTL(retentionInterval), and then only a specific number of versions(versionAfterInterval) after that interval elapses.
    
    Parameters:
    
    retentionInterval - Retain all versions for this interval
    
    versionAfterInterval - Retain no of versions to retain after retentionInterval
    
    Returns:
    
    this (for chained invocation)
  - isBlockCacheEnabled
```
public boolean isBlockCacheEnabled()
```
    Specified by:
    
    isBlockCacheEnabled in interface ColumnFamilyDescriptor
    
    Returns:
    
    True if hfile DATA type blocks should be cached (You cannot disable caching of INDEX and BLOOM type blocks).
  - setBlockCacheEnabled
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setBlockCacheEnabled(boolean blockCacheEnabled)
```
    Parameters:
    
    blockCacheEnabled - True if hfile DATA type blocks should be cached (We always cache INDEX and BLOOM blocks; you cannot turn this off).
    
    Returns:
    
    this (for chained invocation)
  - getBloomFilterType
```
public BloomType getBloomFilterType()
```
    Specified by:
    
    getBloomFilterType in interface ColumnFamilyDescriptor
    
    Returns:
    
    bloom filter type used for new StoreFiles in ColumnFamily
  - setBloomFilterType
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setBloomFilterType(BloomType bt)
```
  - getScope
```
public int getScope()
```
    Specified by:
    
    getScope in interface ColumnFamilyDescriptor
    
    Returns:
    
    the scope tag
  - setScope
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setScope(int scope)
```
    Parameters:
    
    scope - the scope tag
    
    Returns:
    
    this (for chained invocation)
  - isCacheDataOnWrite
```
public boolean isCacheDataOnWrite()
```
    Specified by:
    
    isCacheDataOnWrite in interface ColumnFamilyDescriptor
    
    Returns:
    
    true if we should cache data blocks on write
  - setCacheDataOnWrite
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCacheDataOnWrite(boolean value)
```
    Parameters:
    
    value - true if we should cache data blocks on write
    
    Returns:
    
    this (for chained invocation)
  - isCacheIndexesOnWrite
```
public boolean isCacheIndexesOnWrite()
```
    Specified by:
    
    isCacheIndexesOnWrite in interface ColumnFamilyDescriptor
    
    Returns:
    
    true if we should cache index blocks on write
  - setCacheIndexesOnWrite
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCacheIndexesOnWrite(boolean value)
```
    Parameters:
    
    value - true if we should cache index blocks on write
    
    Returns:
    
    this (for chained invocation)
  - isCacheBloomsOnWrite
```
public boolean isCacheBloomsOnWrite()
```
    Specified by:
    
    isCacheBloomsOnWrite in interface ColumnFamilyDescriptor
    
    Returns:
    
    true if we should cache bloomfilter blocks on write
  - setCacheBloomsOnWrite
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCacheBloomsOnWrite(boolean value)
```
    Parameters:
    
    value - true if we should cache bloomfilter blocks on write
    
    Returns:
    
    this (for chained invocation)
  - isEvictBlocksOnClose
```
public boolean isEvictBlocksOnClose()
```
    Specified by:
    
    isEvictBlocksOnClose in interface ColumnFamilyDescriptor
    
    Returns:
    
    true if we should evict cached blocks from the blockcache on close
  - setEvictBlocksOnClose
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setEvictBlocksOnClose(boolean value)
```
    Parameters:
    
    value - true if we should evict cached blocks from the blockcache on close
    
    Returns:
    
    this (for chained invocation)
  - isPrefetchBlocksOnOpen
```
public boolean isPrefetchBlocksOnOpen()
```
    Specified by:
    
    isPrefetchBlocksOnOpen in interface ColumnFamilyDescriptor
    
    Returns:
    
    true if we should prefetch blocks into the blockcache on open
  - setPrefetchBlocksOnOpen
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setPrefetchBlocksOnOpen(boolean value)
```
    Parameters:
    
    value - true if we should prefetch blocks into the blockcache on open
    
    Returns:
    
    this (for chained invocation)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringCustomizedValues
```
public String toStringCustomizedValues()
```
    Specified by:
    
    toStringCustomizedValues in interface ColumnFamilyDescriptor
    
    Returns:
    
    Column family descriptor with only the customized attributes.
  - getValues
```
private StringBuilder getValues(boolean printDefaults)
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor other)
```
    Specified by:
    
    compareTo in interface Comparable<ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor>
  - toByteArray
```
private byte[] toByteArray()
```
    Returns:
    
    This instance serialized with pb with pb magic prefix
    
    See Also:
    
    parseFrom(byte[])
  - parseFrom
```
private static ColumnFamilyDescriptor parseFrom(byte[] bytes)
                                         throws DeserializationException
```
    Parameters:
    
    bytes - A pb serialized ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor instance with pb magic prefix
    
    Returns:
    
    An instance of ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor made from bytes
    
    Throws:
    
    DeserializationException
    
    See Also:
    
    toByteArray()
  - getConfigurationValue
```
public String getConfigurationValue(String key)
```
    Specified by:
    
    getConfigurationValue in interface ColumnFamilyDescriptor
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    accessing the configuration value by key.
  - getConfiguration
```
public Map<String,String> getConfiguration()
```
    Specified by:
    
    getConfiguration in interface ColumnFamilyDescriptor
    
    Returns:
    
    an unmodifiable map.
  - setConfiguration
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setConfiguration(String key,
                                                                                       String value)
```
    Setter for storing a configuration setting in configuration map.
    
    Parameters:
    
    key - Config key. Same as XML config key e.g. hbase.something.or.other.
    
    value - String value. If null, removes the configuration.
    
    Returns:
    
    this (for chained invocation)
  - removeConfiguration
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor removeConfiguration(String key)
```
    Remove a configuration setting represented by the key from the configuration map.
    
    Parameters:
    
    key -
    
    Returns:
    
    this (for chained invocation)
  - getEncryptionType
```
public String getEncryptionType()
```
    Specified by:
    
    getEncryptionType in interface ColumnFamilyDescriptor
    
    Returns:
    
    Return the encryption algorithm in use by this family
  - setEncryptionType
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setEncryptionType(String algorithm)
```
    Set the encryption algorithm for use with this family
    
    Parameters:
    
    algorithm -
    
    Returns:
    
    this (for chained invocation)
  - getEncryptionKey
```
public byte[] getEncryptionKey()
```
    Specified by:
    
    getEncryptionKey in interface ColumnFamilyDescriptor
    
    Returns:
    
    Return the raw crypto key attribute for the family, or null if not set
  - setEncryptionKey
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setEncryptionKey(byte[] keyBytes)
```
    Set the raw crypto key attribute for the family
    
    Parameters:
    
    keyBytes -
    
    Returns:
    
    this (for chained invocation)
  - getMobThreshold
```
public long getMobThreshold()
```
    Description copied from interface: ColumnFamilyDescriptor
    
    Gets the mob threshold of the family. If the size of a cell value is larger than this threshold, it's regarded as a mob. The default threshold is 1024*100(100K)B.
    
    Specified by:
    
    getMobThreshold in interface ColumnFamilyDescriptor
    
    Returns:
    
    The mob threshold.
  - setMobThreshold
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMobThreshold(long threshold)
```
    Sets the mob threshold of the family.
    
    Parameters:
    
    threshold - The mob threshold.
    
    Returns:
    
    this (for chained invocation)
  - isMobEnabled
```
public boolean isMobEnabled()
```
    Description copied from interface: ColumnFamilyDescriptor
    
    Gets whether the mob is enabled for the family.
    
    Specified by:
    
    isMobEnabled in interface ColumnFamilyDescriptor
    
    Returns:
    
    True if the mob is enabled for the family.
  - setMobEnabled
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMobEnabled(boolean isMobEnabled)
```
    Enables the mob for the family.
    
    Parameters:
    
    isMobEnabled - Whether to enable the mob for the family.
    
    Returns:
    
    this (for chained invocation)
  - getMobCompactPartitionPolicy
```
public MobCompactPartitionPolicy getMobCompactPartitionPolicy()
```
    Description copied from interface: ColumnFamilyDescriptor
    
    Get the mob compact partition policy for this family
    
    Specified by:
    
    getMobCompactPartitionPolicy in interface ColumnFamilyDescriptor
    
    Returns:
    
    MobCompactPartitionPolicy
  - setMobCompactPartitionPolicy
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMobCompactPartitionPolicy(MobCompactPartitionPolicy policy)
```
    Set the mob compact partition policy for the family.
    
    Parameters:
    
    policy - policy type
    
    Returns:
    
    this (for chained invocation)
  - getDFSReplication
```
public short getDFSReplication()
```
    Specified by:
    
    getDFSReplication in interface ColumnFamilyDescriptor
    
    Returns:
    
    replication factor set for this CF
  - setDFSReplication
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setDFSReplication(short replication)
```
    Set the replication factor to hfile(s) belonging to this family
    
    Parameters:
    
    replication - number of replicas the blocks(s) belonging to this CF should have, or ColumnFamilyDescriptorBuilder.DEFAULT_DFS_REPLICATION for the default replication factor set in the filesystem
    
    Returns:
    
    this (for chained invocation)
  - getStoragePolicy
```
public String getStoragePolicy()
```
    Description copied from interface: ColumnFamilyDescriptor
    
    Not using enum here because HDFS is not using enum for storage policy, see org.apache.hadoop.hdfs.server.blockmanagement.BlockStoragePolicySuite for more details.
    
    Specified by:
    
    getStoragePolicy in interface ColumnFamilyDescriptor
    
    Returns:
    
    Return the storage policy in use by this family
  - setStoragePolicy
```
public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setStoragePolicy(String policy)
```
    Set the storage policy for use with this family
    
    Parameters:
    
    policy - the policy to set, valid setting includes: "LAZY_PERSIST", "ALL_SSD", "ONE_SSD", "HOT", "WARM", "COLD"
    
    Returns:
    
    this (for chained invocation)

Class ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.client.ColumnFamilyDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

values

configuration

Constructor Detail

ModifyableColumnFamilyDescriptor

ModifyableColumnFamilyDescriptor

ModifyableColumnFamilyDescriptor

Method Detail

getName

getNameAsString

getValue

getValue

getValues

setValue

setValue

setValue

setValue

removeValue

toBytesOrNull

getStringOrDefault

getOrDefault

getMaxVersions

setMaxVersions

setVersions

getBlocksize

setBlocksize

getCompressionType

setCompressionType

getDataBlockEncoding

setDataBlockEncoding

setCompressTags

isCompressTags

getCompactionCompressionType

setCompactionCompressionType

isInMemory

setInMemory

getInMemoryCompaction

setInMemoryCompaction

getKeepDeletedCells

setKeepDeletedCells

isNewVersionBehavior

setNewVersionBehavior

getTimeToLive

setTimeToLive

setTimeToLive

getMinVersions

setMinVersions

setVersionsWithTimeToLive

isBlockCacheEnabled

setBlockCacheEnabled

getBloomFilterType

setBloomFilterType

getScope

setScope

isCacheDataOnWrite

setCacheDataOnWrite

isCacheIndexesOnWrite

setCacheIndexesOnWrite

isCacheBloomsOnWrite

setCacheBloomsOnWrite

isEvictBlocksOnClose

setEvictBlocksOnClose

isPrefetchBlocksOnOpen

setPrefetchBlocksOnOpen

toString

toStringCustomizedValues

getValues

equals

hashCode

compareTo

toByteArray

parseFrom

getConfigurationValue