HColumnDescriptor (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.HColumnDescriptor

All Implemented Interfaces:

Comparable<HColumnDescriptor>, ColumnFamilyDescriptor

Deprecated.
```
@InterfaceAudience.Public
 @Deprecated
public class HColumnDescriptor
extends Object
implements ColumnFamilyDescriptor, Comparable<HColumnDescriptor>
```
An HColumnDescriptor 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.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BLOCKCACHE` Deprecated.
`static String`	`BLOCKSIZE` Deprecated.
`static String`	`BLOOMFILTER` Deprecated.
`static String`	`CACHE_BLOOMS_ON_WRITE` Deprecated.
`static String`	`CACHE_DATA_IN_L1` Deprecated.
`static String`	`CACHE_DATA_ON_WRITE` Deprecated.
`static String`	`CACHE_INDEX_ON_WRITE` Deprecated.
`static String`	`COMPRESS_TAGS` Deprecated.
`static String`	`COMPRESSION` Deprecated.
`static String`	`COMPRESSION_COMPACT` Deprecated.
`static String`	`COMPRESSION_COMPACT_MAJOR` Deprecated.
`static String`	`COMPRESSION_COMPACT_MINOR` Deprecated.
`static String`	`DATA_BLOCK_ENCODING` Deprecated.
`static boolean`	`DEFAULT_BLOCKCACHE` Deprecated.
`static int`	`DEFAULT_BLOCKSIZE` Deprecated.
`static String`	`DEFAULT_BLOOMFILTER` Deprecated.
`static boolean`	`DEFAULT_CACHE_BLOOMS_ON_WRITE` Deprecated.
`static boolean`	`DEFAULT_CACHE_DATA_IN_L1` Deprecated.
`static boolean`	`DEFAULT_CACHE_DATA_ON_WRITE` Deprecated.
`static boolean`	`DEFAULT_CACHE_INDEX_ON_WRITE` Deprecated.
`static boolean`	`DEFAULT_COMPRESS_TAGS` Deprecated.
`static String`	`DEFAULT_COMPRESSION` Deprecated.
`static String`	`DEFAULT_DATA_BLOCK_ENCODING` Deprecated.
`static short`	`DEFAULT_DFS_REPLICATION` Deprecated.
`static boolean`	`DEFAULT_ENCODE_ON_DISK` Deprecated.
`static boolean`	`DEFAULT_EVICT_BLOCKS_ON_CLOSE` Deprecated.
`static boolean`	`DEFAULT_IN_MEMORY` Deprecated.
`static KeepDeletedCells`	`DEFAULT_KEEP_DELETED` Deprecated.
`static int`	`DEFAULT_MIN_VERSIONS` Deprecated.
`static MobCompactPartitionPolicy`	`DEFAULT_MOB_COMPACT_PARTITION_POLICY` Deprecated.
`static long`	`DEFAULT_MOB_THRESHOLD` Deprecated.
`static boolean`	`DEFAULT_NEW_VERSION_BEHAVIOR` Deprecated.
`static boolean`	`DEFAULT_PREFETCH_BLOCKS_ON_OPEN` Deprecated.
`static int`	`DEFAULT_REPLICATION_SCOPE` Deprecated.
`static int`	`DEFAULT_TTL` Deprecated.
`static int`	`DEFAULT_VERSIONS` Deprecated.
`protected org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`delegatee` Deprecated.
`static String`	`DFS_REPLICATION` Deprecated.
`static String`	`ENCODE_ON_DISK` Deprecated.
`static String`	`ENCRYPTION` Deprecated.
`static String`	`ENCRYPTION_KEY` Deprecated.
`static String`	`EVICT_BLOCKS_ON_CLOSE` Deprecated.
`static String`	`FOREVER` Deprecated.
`static String`	`IN_MEMORY_COMPACTION` Deprecated.
`static String`	`IS_MOB` Deprecated.
`static byte[]`	`IS_MOB_BYTES` Deprecated.
`static String`	`KEEP_DELETED_CELLS` Deprecated.
`static String`	`LENGTH` Deprecated.
`static String`	`MIN_VERSIONS` Deprecated.
`static String`	`MOB_COMPACT_PARTITION_POLICY` Deprecated.
`static byte[]`	`MOB_COMPACT_PARTITION_POLICY_BYTES` Deprecated.
`static String`	`MOB_THRESHOLD` Deprecated.
`static byte[]`	`MOB_THRESHOLD_BYTES` Deprecated.
`static String`	`NEW_VERSION_BEHAVIOR` Deprecated.
`static String`	`PREFETCH_BLOCKS_ON_OPEN` Deprecated.
`static String`	`REPLICATION_SCOPE` Deprecated.
`static byte[]`	`REPLICATION_SCOPE_BYTES` Deprecated.
`static String`	`STORAGE_POLICY` Deprecated.
`static String`	`TTL` Deprecated.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`HColumnDescriptor(byte[] familyName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18433). Use `ColumnFamilyDescriptorBuilder.of(byte[])`.
`protected`	`HColumnDescriptor(org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor delegate)` Deprecated.
	`HColumnDescriptor(HColumnDescriptor desc)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18433). Use `ColumnFamilyDescriptorBuilder.copy(ColumnFamilyDescriptor)`.
`protected`	`HColumnDescriptor(HColumnDescriptor desc, boolean deepClone)` Deprecated.
	`HColumnDescriptor(String familyName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18433). Use `ColumnFamilyDescriptorBuilder.of(String)`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(HColumnDescriptor other)` Deprecated.
`boolean`	`equals(Object obj)` Deprecated.
`int`	`getBlocksize()` Deprecated. Returns The storefile/hfile blocksize for this column family.
`BloomType`	`getBloomFilterType()` Deprecated. Returns bloom filter type used for new StoreFiles in ColumnFamily
`Compression.Algorithm`	`getCompactionCompression()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-13655). Use `getCompactionCompressionType()`.
`Compression.Algorithm`	`getCompactionCompressionType()` Deprecated. Returns Compression type setting.
`Compression.Algorithm`	`getCompression()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-13655). Use `getCompressionType()`.
`Compression.Algorithm`	`getCompressionType()` Deprecated. Returns Compression type setting.
`Map<String,String>`	`getConfiguration()` Deprecated. Returns an unmodifiable map.
`String`	`getConfigurationValue(String key)` Deprecated. Returns accessing the configuration value by key.
`DataBlockEncoding`	`getDataBlockEncoding()` Deprecated. Returns the data block encoding algorithm used in block cache and optionally on disk
`static Map<String,String>`	`getDefaultValues()` Deprecated.
`protected org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`getDelegateeForModification()` Deprecated.
`short`	`getDFSReplication()` Deprecated. Returns replication factor set for this CF
`byte[]`	`getEncryptionKey()` Deprecated. Returns Return the raw crypto key attribute for the family, or null if not set
`String`	`getEncryptionType()` Deprecated. Returns Return the encryption algorithm in use by this family
`MemoryCompactionPolicy`	`getInMemoryCompaction()` Deprecated. Returns in-memory compaction policy if set for the cf.
`KeepDeletedCells`	`getKeepDeletedCells()` Deprecated. Returns return the KeepDeletedCells
`Compression.Algorithm`	`getMajorCompactionCompressionType()` Deprecated. Returns Compression type setting for major compactions.
`int`	`getMaxVersions()` Deprecated. Returns maximum number of versions
`Compression.Algorithm`	`getMinorCompactionCompressionType()` Deprecated. Returns Compression type setting for minor compactions.
`int`	`getMinVersions()` Deprecated. Returns The minimum number of versions to keep.
`MobCompactPartitionPolicy`	`getMobCompactPartitionPolicy()` Deprecated. Get the mob compact partition policy for this family n
`long`	`getMobThreshold()` Deprecated. Gets the mob threshold of the family.
`byte[]`	`getName()` Deprecated. Returns Name of this column family
`String`	`getNameAsString()` Deprecated. Returns The name string of this column family
`int`	`getScope()` Deprecated. Returns the scope tag
`String`	`getStoragePolicy()` Deprecated. Not using `enum` here because HDFS is not using `enum` for storage policy, see org.apache.hadoop.hdfs.server.blockmanagement.BlockStoragePolicySuite for more details.
`int`	`getTimeToLive()` Deprecated. Returns Time-to-live of cell contents, in seconds.
`static org.apache.hadoop.hbase.util.PrettyPrinter.Unit`	`getUnit(String key)` Deprecated.
`byte[]`	`getValue(byte[] key)` Deprecated. Get a configuration value.
`Bytes`	`getValue(Bytes key)` Deprecated. Get a configuration value.
`String`	`getValue(String key)` Deprecated. Get a configuration value.
`Map<Bytes,Bytes>`	`getValues()` Deprecated. Get all configuration values.
`int`	`hashCode()` Deprecated.
`boolean`	`isBlockCacheEnabled()` Deprecated. Returns True if hfile DATA type blocks should be cached (You cannot disable caching of INDEX and BLOOM type blocks).
`boolean`	`isCacheBloomsOnWrite()` Deprecated. Returns true if we should cache bloomfilter blocks on write
`boolean`	`isCacheDataOnWrite()` Deprecated. Returns true if we should cache data blocks on write
`boolean`	`isCacheIndexesOnWrite()` Deprecated. Returns true if we should cache index blocks on write
`boolean`	`isCompressTags()` Deprecated. Returns Whether KV tags should be compressed along with DataBlockEncoding.
`boolean`	`isEvictBlocksOnClose()` Deprecated. Returns true if we should evict cached blocks from the blockcache on close
`boolean`	`isInMemory()` Deprecated. Returns True if we are to favor keeping all values for this column family in the HRegionServer cache.
`static byte[]`	`isLegalFamilyName(byte[] b)` Deprecated. since 2.0.0 and will be removed in 3.0.0. Use `ColumnFamilyDescriptorBuilder.isLegalColumnFamilyName(byte[])` instead.
`boolean`	`isMobEnabled()` Deprecated. Gets whether the mob is enabled for the family.
`boolean`	`isNewVersionBehavior()` Deprecated. By default, HBase only consider timestamp in versions.
`boolean`	`isPrefetchBlocksOnOpen()` Deprecated. Returns true if we should prefetch blocks into the blockcache on open
`static HColumnDescriptor`	`parseFrom(byte[] bytes)` Deprecated. Parse a serialized representation of a `HColumnDescriptor`
`void`	`remove(byte[] key)` Deprecated.
`void`	`removeConfiguration(String key)` Deprecated. Remove a configuration setting represented by the key.
`HColumnDescriptor`	`setBlockCacheEnabled(boolean value)` Deprecated. Set or clear the block cache enabled flag.
`HColumnDescriptor`	`setBlocksize(int value)` Deprecated. Set block size to use when writing
`HColumnDescriptor`	`setBlocksize(String value)` Deprecated.
`HColumnDescriptor`	`setBloomFilterType(BloomType value)` Deprecated. Set the bloom filter type.
`HColumnDescriptor`	`setCacheBloomsOnWrite(boolean value)` Deprecated. Set or clear the cache bloom filters on write flag.
`HColumnDescriptor`	`setCacheDataInL1(boolean value)` Deprecated. Since 2.0 and will be removed in 3.0 with out any replacement. Caching data in on heap Cache, when there are both on heap LRU Cache and Bucket Cache will no longer be supported from 2.0.
`HColumnDescriptor`	`setCacheDataOnWrite(boolean value)` Deprecated. Set or clear the cache data on write flag.
`HColumnDescriptor`	`setCacheIndexesOnWrite(boolean value)` Deprecated. Set or clear the cache indexes on write flag.
`HColumnDescriptor`	`setCompactionCompressionType(Compression.Algorithm value)` Deprecated. Compression types supported in hbase.
`HColumnDescriptor`	`setCompressionType(Compression.Algorithm value)` Deprecated. Compression types supported in hbase.
`HColumnDescriptor`	`setCompressTags(boolean value)` Deprecated. Set whether the tags should be compressed along with DataBlockEncoding.
`HColumnDescriptor`	`setConfiguration(String key, String value)` Deprecated. Setter for storing a configuration setting.
`HColumnDescriptor`	`setDataBlockEncoding(DataBlockEncoding value)` Deprecated. Set data block encoding algorithm used in block cache.
`HColumnDescriptor`	`setDFSReplication(short value)` Deprecated. Set the replication factor to hfile(s) belonging to this family
`HColumnDescriptor`	`setEncryptionKey(byte[] value)` Deprecated. Set the raw crypto key attribute for the family
`HColumnDescriptor`	`setEncryptionType(String value)` Deprecated. Set the encryption algorithm for use with this family n
`HColumnDescriptor`	`setEvictBlocksOnClose(boolean value)` Deprecated. Set or clear the evict bloom filters on close flag.
`HColumnDescriptor`	`setInMemory(boolean value)` Deprecated. Set or clear the in memory flag.
`HColumnDescriptor`	`setInMemoryCompaction(MemoryCompactionPolicy value)` Deprecated. Set the in memory compaction policy.
`HColumnDescriptor`	`setKeepDeletedCells(KeepDeletedCells value)` Deprecated. Set the keep deleted cells policy.
`HColumnDescriptor`	`setMajorCompactionCompressionType(Compression.Algorithm value)` Deprecated.
`HColumnDescriptor`	`setMaxVersions(int value)` Deprecated. Set maximum versions to keep
`HColumnDescriptor`	`setMinorCompactionCompressionType(Compression.Algorithm value)` Deprecated.
`HColumnDescriptor`	`setMinVersions(int value)` Deprecated. Set the minimum number of versions to keep.
`HColumnDescriptor`	`setMobCompactPartitionPolicy(MobCompactPartitionPolicy value)` Deprecated. Set the mob compact partition policy for the family.
`HColumnDescriptor`	`setMobEnabled(boolean value)` Deprecated. Enables the mob for the family.
`HColumnDescriptor`	`setMobThreshold(long value)` Deprecated. Sets the mob threshold of the family.
`HColumnDescriptor`	`setNewVersionBehavior(boolean newVersionBehavior)` Deprecated.
`HColumnDescriptor`	`setPrefetchBlocksOnOpen(boolean value)` Deprecated. Set or clear the prefetch on open flag.
`HColumnDescriptor`	`setScope(int value)` Deprecated.
`HColumnDescriptor`	`setStoragePolicy(String value)` Deprecated. Set the storage policy for use with this family
`HColumnDescriptor`	`setTimeToLive(int value)` Deprecated. Set the time to live of cell contents
`HColumnDescriptor`	`setTimeToLive(String value)` Deprecated. Set the time to live of cell contents
`HColumnDescriptor`	`setValue(byte[] key, byte[] value)` Deprecated.
`HColumnDescriptor`	`setValue(String key, String value)` Deprecated.
`HColumnDescriptor`	`setVersions(int minVersions, int maxVersions)` Deprecated. Set minimum and maximum versions to keep
`byte[]`	`toByteArray()` Deprecated. Returns This instance serialized with pb with pb magic prefix
`String`	`toString()` Deprecated.
`String`	`toStringCustomizedValues()` Deprecated. Returns Column family descriptor with only the customized attributes.

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

- Field Detail
  - IN_MEMORY_COMPACTION
```
public static final String IN_MEMORY_COMPACTION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - COMPRESSION
```
public static final String COMPRESSION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - COMPRESSION_COMPACT
```
public static final String COMPRESSION_COMPACT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - COMPRESSION_COMPACT_MAJOR
```
public static final String COMPRESSION_COMPACT_MAJOR
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - COMPRESSION_COMPACT_MINOR
```
public static final String COMPRESSION_COMPACT_MINOR
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ENCODE_ON_DISK
```
public static final String ENCODE_ON_DISK
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATA_BLOCK_ENCODING
```
public static final String DATA_BLOCK_ENCODING
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - BLOCKCACHE
```
public static final String BLOCKCACHE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CACHE_DATA_ON_WRITE
```
public static final String CACHE_DATA_ON_WRITE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CACHE_INDEX_ON_WRITE
```
public static final String CACHE_INDEX_ON_WRITE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CACHE_BLOOMS_ON_WRITE
```
public static final String CACHE_BLOOMS_ON_WRITE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - EVICT_BLOCKS_ON_CLOSE
```
public static final String EVICT_BLOCKS_ON_CLOSE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CACHE_DATA_IN_L1
```
public static final String CACHE_DATA_IN_L1
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PREFETCH_BLOCKS_ON_OPEN
```
public static final String PREFETCH_BLOCKS_ON_OPEN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - BLOCKSIZE
```
public static final String BLOCKSIZE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - LENGTH
```
public static final String LENGTH
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - TTL
```
public static final String TTL
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - BLOOMFILTER
```
public static final String BLOOMFILTER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - FOREVER
```
public static final String FOREVER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - REPLICATION_SCOPE
```
public static final String REPLICATION_SCOPE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - REPLICATION_SCOPE_BYTES
```
public static final byte[] REPLICATION_SCOPE_BYTES
```
    Deprecated.
  - MIN_VERSIONS
```
public static final String MIN_VERSIONS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - KEEP_DELETED_CELLS
```
public static final String KEEP_DELETED_CELLS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - COMPRESS_TAGS
```
public static final String COMPRESS_TAGS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ENCRYPTION
```
public static final String ENCRYPTION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ENCRYPTION_KEY
```
public static final String ENCRYPTION_KEY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - IS_MOB
```
public static final String IS_MOB
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - IS_MOB_BYTES
```
public static final byte[] IS_MOB_BYTES
```
    Deprecated.
  - MOB_THRESHOLD
```
public static final String MOB_THRESHOLD
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - MOB_THRESHOLD_BYTES
```
public static final byte[] MOB_THRESHOLD_BYTES
```
    Deprecated.
  - DEFAULT_MOB_THRESHOLD
```
public static final long DEFAULT_MOB_THRESHOLD
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - MOB_COMPACT_PARTITION_POLICY
```
public static final String MOB_COMPACT_PARTITION_POLICY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - MOB_COMPACT_PARTITION_POLICY_BYTES
```
public static final byte[] MOB_COMPACT_PARTITION_POLICY_BYTES
```
    Deprecated.
  - DEFAULT_MOB_COMPACT_PARTITION_POLICY
```
public static final MobCompactPartitionPolicy DEFAULT_MOB_COMPACT_PARTITION_POLICY
```
    Deprecated.
  - DFS_REPLICATION
```
public static final String DFS_REPLICATION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DFS_REPLICATION
```
public static final short DEFAULT_DFS_REPLICATION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - STORAGE_POLICY
```
public static final String STORAGE_POLICY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMPRESSION
```
public static final String DEFAULT_COMPRESSION
```
    Deprecated.
  - DEFAULT_ENCODE_ON_DISK
```
public static final boolean DEFAULT_ENCODE_ON_DISK
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DATA_BLOCK_ENCODING
```
public static final String DEFAULT_DATA_BLOCK_ENCODING
```
    Deprecated.
  - DEFAULT_VERSIONS
```
public static final int DEFAULT_VERSIONS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_VERSIONS
```
public static final int DEFAULT_MIN_VERSIONS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IN_MEMORY
```
public static final boolean DEFAULT_IN_MEMORY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_KEEP_DELETED
```
public static final KeepDeletedCells DEFAULT_KEEP_DELETED
```
    Deprecated.
  - DEFAULT_BLOCKCACHE
```
public static final boolean DEFAULT_BLOCKCACHE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_DATA_ON_WRITE
```
public static final boolean DEFAULT_CACHE_DATA_ON_WRITE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_DATA_IN_L1
```
public static final boolean DEFAULT_CACHE_DATA_IN_L1
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_INDEX_ON_WRITE
```
public static final boolean DEFAULT_CACHE_INDEX_ON_WRITE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BLOCKSIZE
```
public static final int DEFAULT_BLOCKSIZE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BLOOMFILTER
```
public static final String DEFAULT_BLOOMFILTER
```
    Deprecated.
  - DEFAULT_CACHE_BLOOMS_ON_WRITE
```
public static final boolean DEFAULT_CACHE_BLOOMS_ON_WRITE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TTL
```
public static final int DEFAULT_TTL
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REPLICATION_SCOPE
```
public static final int DEFAULT_REPLICATION_SCOPE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EVICT_BLOCKS_ON_CLOSE
```
public static final boolean DEFAULT_EVICT_BLOCKS_ON_CLOSE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMPRESS_TAGS
```
public static final boolean DEFAULT_COMPRESS_TAGS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PREFETCH_BLOCKS_ON_OPEN
```
public static final boolean DEFAULT_PREFETCH_BLOCKS_ON_OPEN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - NEW_VERSION_BEHAVIOR
```
public static final String NEW_VERSION_BEHAVIOR
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NEW_VERSION_BEHAVIOR
```
public static final boolean DEFAULT_NEW_VERSION_BEHAVIOR
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - delegatee
```
protected final org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor delegatee
```
    Deprecated.
- Constructor Detail
  - HColumnDescriptor
```
@Deprecated
public HColumnDescriptor(String familyName)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18433). Use ColumnFamilyDescriptorBuilder.of(String).
    
    Construct a column descriptor specifying only the family name The other attributes are defaulted.
    
    Parameters:
    
    familyName - Column family name. Must be 'printable' -- digit or letter -- and may not contain a :
  - HColumnDescriptor
```
@Deprecated
public HColumnDescriptor(byte[] familyName)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18433). Use ColumnFamilyDescriptorBuilder.of(byte[]).
    
    Construct a column descriptor specifying only the family name The other attributes are defaulted.
    
    Parameters:
    
    familyName - Column family name. Must be 'printable' -- digit or letter -- and may not contain a :
  - HColumnDescriptor
```
@Deprecated
public HColumnDescriptor(HColumnDescriptor desc)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18433). Use ColumnFamilyDescriptorBuilder.copy(ColumnFamilyDescriptor).
    
    Constructor. Makes a deep copy of the supplied descriptor. Can make a modifiable descriptor from an UnmodifyableHColumnDescriptor.
    
    Parameters:
    
    desc - The descriptor.
  - HColumnDescriptor
```
protected HColumnDescriptor(HColumnDescriptor desc,
                            boolean deepClone)
```
    Deprecated.
  - HColumnDescriptor
```
protected HColumnDescriptor(org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor delegate)
```
    Deprecated.
- Method Detail
  - isLegalFamilyName
```
@Deprecated
public static byte[] isLegalFamilyName(byte[] b)
```
    Deprecated. since 2.0.0 and will be removed in 3.0.0. Use ColumnFamilyDescriptorBuilder.isLegalColumnFamilyName(byte[]) instead.
    
    Check if a given family name is allowed.
    
    Parameters:
    
    b - Family name.
    
    Returns:
    
    b
    
    Throws:
    
    IllegalArgumentException - If not null and not a legitimate family name: i.e. 'printable' and ends in a ':' (Null passes are allowed because b can be null when deserializing). Cannot start with a '.' either. Also Family can not be an empty value or equal "recovered.edits".
    
    See Also:
    
    ColumnFamilyDescriptorBuilder.isLegalColumnFamilyName(byte[]), HBASE-18008
  - getName
```
public byte[] getName()
```
    Deprecated.
    
    Returns Name of this column family
    
    Specified by:
    
    getName in interface ColumnFamilyDescriptor
  - getNameAsString
```
public String getNameAsString()
```
    Deprecated.
    
    Returns The name string of this column family
    
    Specified by:
    
    getNameAsString in interface ColumnFamilyDescriptor
  - getValue
```
public byte[] getValue(byte[] key)
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Get a configuration value.
    
    Specified by:
    
    getValue in interface ColumnFamilyDescriptor
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    A clone value. Null if no mapping for the key
  - getValue
```
public String getValue(String key)
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Get a configuration value.
    
    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()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Get all configuration values. It clone all bytes of all elements.
    
    Specified by:
    
    getValues in interface ColumnFamilyDescriptor
    
    Returns:
    
    All values
  - setValue
```
public HColumnDescriptor setValue(byte[] key,
                                  byte[] value)
```
    Deprecated.
  - remove
```
public void remove(byte[] key)
```
    Deprecated.
  - setValue
```
public HColumnDescriptor setValue(String key,
                                  String value)
```
    Deprecated.
  - getCompression
```
@Deprecated
public Compression.Algorithm getCompression()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-13655). Use getCompressionType().
    
    Returns compression type being used for the column family
  - getCompactionCompression
```
@Deprecated
public Compression.Algorithm getCompactionCompression()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-13655). Use getCompactionCompressionType().
    
    Returns compression type being used for the column family for major compaction
  - getMaxVersions
```
public int getMaxVersions()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns maximum number of versions
    
    Specified by:
    
    getMaxVersions in interface ColumnFamilyDescriptor
  - setMaxVersions
```
public HColumnDescriptor setMaxVersions(int value)
```
    Deprecated.
    
    Set maximum versions to keep
    
    Parameters:
    
    value - maximum number of versions
    
    Returns:
    
    this (for chained invocation)
  - setVersions
```
public HColumnDescriptor setVersions(int minVersions,
                                     int maxVersions)
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns The storefile/hfile blocksize for this column family.
    
    Specified by:
    
    getBlocksize in interface ColumnFamilyDescriptor
  - setBlocksize
```
public HColumnDescriptor setBlocksize(int value)
```
    Deprecated.
    
    Set block size to use when writing
    
    Parameters:
    
    value - Blocksize to use when writing out storefiles/hfiles on this column family.
    
    Returns:
    
    this (for chained invocation)
  - setBlocksize
```
public HColumnDescriptor setBlocksize(String value)
                               throws org.apache.hadoop.hbase.exceptions.HBaseException
```
    Deprecated.
    
    Throws:
    
    org.apache.hadoop.hbase.exceptions.HBaseException
  - getCompressionType
```
public Compression.Algorithm getCompressionType()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns Compression type setting.
    
    Specified by:
    
    getCompressionType in interface ColumnFamilyDescriptor
  - setCompressionType
```
public HColumnDescriptor setCompressionType(Compression.Algorithm value)
```
    Deprecated.
    
    Compression types supported in hbase. LZO is not bundled as part of the hbase distribution. See LZO Compression for how to enable it.
    
    Parameters:
    
    value - Compression type setting.
    
    Returns:
    
    this (for chained invocation)
  - getDataBlockEncoding
```
public DataBlockEncoding getDataBlockEncoding()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns the data block encoding algorithm used in block cache and optionally on disk
    
    Specified by:
    
    getDataBlockEncoding in interface ColumnFamilyDescriptor
  - setDataBlockEncoding
```
public HColumnDescriptor setDataBlockEncoding(DataBlockEncoding value)
```
    Deprecated.
    
    Set data block encoding algorithm used in block cache.
    
    Parameters:
    
    value - What kind of data block encoding will be used.
    
    Returns:
    
    this (for chained invocation)
  - setCompressTags
```
public HColumnDescriptor setCompressTags(boolean value)
```
    Deprecated.
    
    Set whether the tags should be compressed along with DataBlockEncoding. When no DataBlockEncoding is been used, this is having no effect. n * @return this (for chained invocation)
  - isCompressTags
```
public boolean isCompressTags()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns Whether KV tags should be compressed along with DataBlockEncoding. When no DataBlockEncoding is been used, this is having no effect.
    
    Specified by:
    
    isCompressTags in interface ColumnFamilyDescriptor
  - getCompactionCompressionType
```
public Compression.Algorithm getCompactionCompressionType()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns Compression type setting.
    
    Specified by:
    
    getCompactionCompressionType in interface ColumnFamilyDescriptor
  - getMajorCompactionCompressionType
```
public Compression.Algorithm getMajorCompactionCompressionType()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns Compression type setting for major compactions.
    
    Specified by:
    
    getMajorCompactionCompressionType in interface ColumnFamilyDescriptor
  - getMinorCompactionCompressionType
```
public Compression.Algorithm getMinorCompactionCompressionType()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns Compression type setting for minor compactions.
    
    Specified by:
    
    getMinorCompactionCompressionType in interface ColumnFamilyDescriptor
  - setCompactionCompressionType
```
public HColumnDescriptor setCompactionCompressionType(Compression.Algorithm value)
```
    Deprecated.
    
    Compression types supported in hbase. LZO is not bundled as part of the hbase distribution. See LZO Compression for how to enable it.
    
    Parameters:
    
    value - Compression type setting.
    
    Returns:
    
    this (for chained invocation)
  - setMajorCompactionCompressionType
```
public HColumnDescriptor setMajorCompactionCompressionType(Compression.Algorithm value)
```
    Deprecated.
  - setMinorCompactionCompressionType
```
public HColumnDescriptor setMinorCompactionCompressionType(Compression.Algorithm value)
```
    Deprecated.
  - isInMemory
```
public boolean isInMemory()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns True if we are to favor keeping all values for this column family in the HRegionServer cache.
    
    Specified by:
    
    isInMemory in interface ColumnFamilyDescriptor
  - setInMemory
```
public HColumnDescriptor setInMemory(boolean value)
```
    Deprecated.
    
    Set or clear the in memory flag.
    
    Parameters:
    
    value - 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()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns in-memory compaction policy if set for the cf. Returns null if no policy is set for for this column family
    
    Specified by:
    
    getInMemoryCompaction in interface ColumnFamilyDescriptor
  - setInMemoryCompaction
```
public HColumnDescriptor setInMemoryCompaction(MemoryCompactionPolicy value)
```
    Deprecated.
    
    Set the in memory compaction policy.
    
    Parameters:
    
    value - the prefered in-memory compaction policy for this column family
    
    Returns:
    
    this (for chained invocation)
  - getKeepDeletedCells
```
public KeepDeletedCells getKeepDeletedCells()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns return the KeepDeletedCells
    
    Specified by:
    
    getKeepDeletedCells in interface ColumnFamilyDescriptor
  - setKeepDeletedCells
```
public HColumnDescriptor setKeepDeletedCells(KeepDeletedCells value)
```
    Deprecated.
    
    Set the keep deleted cells policy.
    
    Parameters:
    
    value - True if deleted rows should not be collected immediately.
    
    Returns:
    
    this (for chained invocation)
  - isNewVersionBehavior
```
public boolean isNewVersionBehavior()
```
    Deprecated.
    
    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 HColumnDescriptor setNewVersionBehavior(boolean newVersionBehavior)
```
    Deprecated.
  - getTimeToLive
```
public int getTimeToLive()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns Time-to-live of cell contents, in seconds.
    
    Specified by:
    
    getTimeToLive in interface ColumnFamilyDescriptor
  - setTimeToLive
```
public HColumnDescriptor setTimeToLive(int value)
```
    Deprecated.
    
    Set the time to live of cell contents
    
    Parameters:
    
    value - Time-to-live of cell contents, in seconds.
    
    Returns:
    
    this (for chained invocation)
  - setTimeToLive
```
public HColumnDescriptor setTimeToLive(String value)
                                throws org.apache.hadoop.hbase.exceptions.HBaseException
```
    Deprecated.
    
    Set the time to live of cell contents
    
    Parameters:
    
    value - Time to live of cell contents, in human readable format
    
    Returns:
    
    this (for chained invocation)
    
    Throws:
    
    org.apache.hadoop.hbase.exceptions.HBaseException
    
    See Also:
    
    PrettyPrinter.format(String, Unit)
  - getMinVersions
```
public int getMinVersions()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns The minimum number of versions to keep.
    
    Specified by:
    
    getMinVersions in interface ColumnFamilyDescriptor
  - setMinVersions
```
public HColumnDescriptor setMinVersions(int value)
```
    Deprecated.
    
    Set the minimum number of versions to keep.
    
    Parameters:
    
    value - The minimum number of versions to keep. (used when timeToLive is set)
    
    Returns:
    
    this (for chained invocation)
  - isBlockCacheEnabled
```
public boolean isBlockCacheEnabled()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns True if hfile DATA type blocks should be cached (You cannot disable caching of INDEX and BLOOM type blocks).
    
    Specified by:
    
    isBlockCacheEnabled in interface ColumnFamilyDescriptor
  - setBlockCacheEnabled
```
public HColumnDescriptor setBlockCacheEnabled(boolean value)
```
    Deprecated.
    
    Set or clear the block cache enabled flag.
    
    Parameters:
    
    value - 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()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns bloom filter type used for new StoreFiles in ColumnFamily
    
    Specified by:
    
    getBloomFilterType in interface ColumnFamilyDescriptor
  - setBloomFilterType
```
public HColumnDescriptor setBloomFilterType(BloomType value)
```
    Deprecated.
    
    Set the bloom filter type.
    
    Parameters:
    
    value - bloom filter type
    
    Returns:
    
    this (for chained invocation)
  - getScope
```
public int getScope()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns the scope tag
    
    Specified by:
    
    getScope in interface ColumnFamilyDescriptor
  - setScope
```
public HColumnDescriptor setScope(int value)
```
    Deprecated.
  - isCacheDataOnWrite
```
public boolean isCacheDataOnWrite()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns true if we should cache data blocks on write
    
    Specified by:
    
    isCacheDataOnWrite in interface ColumnFamilyDescriptor
  - setCacheDataOnWrite
```
public HColumnDescriptor setCacheDataOnWrite(boolean value)
```
    Deprecated.
    
    Set or clear the cache data on write flag.
    
    Parameters:
    
    value - true if we should cache data blocks on write
    
    Returns:
    
    this (for chained invocation)
  - setCacheDataInL1
```
@Deprecated
public HColumnDescriptor setCacheDataInL1(boolean value)
```
    Deprecated. Since 2.0 and will be removed in 3.0 with out any replacement. Caching data in on heap Cache, when there are both on heap LRU Cache and Bucket Cache will no longer be supported from 2.0.
    
    Set or clear the cache in L1 flag. This is a noop call from HBase 2.0 onwards
    
    Returns:
    
    this (for chained invocation)
  - isCacheIndexesOnWrite
```
public boolean isCacheIndexesOnWrite()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns true if we should cache index blocks on write
    
    Specified by:
    
    isCacheIndexesOnWrite in interface ColumnFamilyDescriptor
  - setCacheIndexesOnWrite
```
public HColumnDescriptor setCacheIndexesOnWrite(boolean value)
```
    Deprecated.
    
    Set or clear the cache indexes on write flag.
    
    Parameters:
    
    value - true if we should cache index blocks on write
    
    Returns:
    
    this (for chained invocation)
  - isCacheBloomsOnWrite
```
public boolean isCacheBloomsOnWrite()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns true if we should cache bloomfilter blocks on write
    
    Specified by:
    
    isCacheBloomsOnWrite in interface ColumnFamilyDescriptor
  - setCacheBloomsOnWrite
```
public HColumnDescriptor setCacheBloomsOnWrite(boolean value)
```
    Deprecated.
    
    Set or clear the cache bloom filters on write flag.
    
    Parameters:
    
    value - true if we should cache bloomfilter blocks on write
    
    Returns:
    
    this (for chained invocation)
  - isEvictBlocksOnClose
```
public boolean isEvictBlocksOnClose()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns true if we should evict cached blocks from the blockcache on close
    
    Specified by:
    
    isEvictBlocksOnClose in interface ColumnFamilyDescriptor
  - setEvictBlocksOnClose
```
public HColumnDescriptor setEvictBlocksOnClose(boolean value)
```
    Deprecated.
    
    Set or clear the evict bloom filters on close flag.
    
    Parameters:
    
    value - true if we should evict cached blocks from the blockcache on close
    
    Returns:
    
    this (for chained invocation)
  - isPrefetchBlocksOnOpen
```
public boolean isPrefetchBlocksOnOpen()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns true if we should prefetch blocks into the blockcache on open
    
    Specified by:
    
    isPrefetchBlocksOnOpen in interface ColumnFamilyDescriptor
  - setPrefetchBlocksOnOpen
```
public HColumnDescriptor setPrefetchBlocksOnOpen(boolean value)
```
    Deprecated.
    
    Set or clear the prefetch on open flag.
    
    Parameters:
    
    value - true if we should prefetch blocks into the blockcache on open
    
    Returns:
    
    this (for chained invocation)
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object
  - toStringCustomizedValues
```
public String toStringCustomizedValues()
```
    Deprecated.
    
    Returns Column family descriptor with only the customized attributes.
    
    Specified by:
    
    toStringCustomizedValues in interface ColumnFamilyDescriptor
  - getUnit
```
public static org.apache.hadoop.hbase.util.PrettyPrinter.Unit getUnit(String key)
```
    Deprecated.
  - getDefaultValues
```
public static Map<String,String> getDefaultValues()
```
    Deprecated.
  - equals
```
public boolean equals(Object obj)
```
    Deprecated.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(HColumnDescriptor other)
```
    Deprecated.
    
    Specified by:
    
    compareTo in interface Comparable<HColumnDescriptor>
  - toByteArray
```
public byte[] toByteArray()
```
    Deprecated.
    
    Returns This instance serialized with pb with pb magic prefix
    
    See Also:
    
    parseFrom(byte[])
  - parseFrom
```
public static HColumnDescriptor parseFrom(byte[] bytes)
                                   throws org.apache.hadoop.hbase.exceptions.DeserializationException
```
    Deprecated.
    
    Parse a serialized representation of a HColumnDescriptor
    
    Parameters:
    
    bytes - A pb serialized HColumnDescriptor instance with pb magic prefix
    
    Returns:
    
    An instance of HColumnDescriptor made from bytes n * @see #toByteArray()
    
    Throws:
    
    org.apache.hadoop.hbase.exceptions.DeserializationException
  - getConfigurationValue
```
public String getConfigurationValue(String key)
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns accessing the configuration value by key.
    
    Specified by:
    
    getConfigurationValue in interface ColumnFamilyDescriptor
  - getConfiguration
```
public Map<String,String> getConfiguration()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns an unmodifiable map.
    
    Specified by:
    
    getConfiguration in interface ColumnFamilyDescriptor
  - setConfiguration
```
public HColumnDescriptor setConfiguration(String key,
                                          String value)
```
    Deprecated.
    
    Setter for storing a configuration setting.
    
    Parameters:
    
    key - Config key. Same as XML config key e.g. hbase.something.or.other.
    
    value - String value. If null, removes the configuration.
  - removeConfiguration
```
public void removeConfiguration(String key)
```
    Deprecated.
    
    Remove a configuration setting represented by the key.
  - getEncryptionType
```
public String getEncryptionType()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns Return the encryption algorithm in use by this family
    
    Specified by:
    
    getEncryptionType in interface ColumnFamilyDescriptor
  - setEncryptionType
```
public HColumnDescriptor setEncryptionType(String value)
```
    Deprecated.
    
    Set the encryption algorithm for use with this family n
  - getEncryptionKey
```
public byte[] getEncryptionKey()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns Return the raw crypto key attribute for the family, or null if not set
    
    Specified by:
    
    getEncryptionKey in interface ColumnFamilyDescriptor
  - setEncryptionKey
```
public HColumnDescriptor setEncryptionKey(byte[] value)
```
    Deprecated.
    
    Set the raw crypto key attribute for the family
  - getMobThreshold
```
public long getMobThreshold()
```
    Deprecated.
    
    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 HColumnDescriptor setMobThreshold(long value)
```
    Deprecated.
    
    Sets the mob threshold of the family.
    
    Parameters:
    
    value - The mob threshold.
    
    Returns:
    
    this (for chained invocation)
  - isMobEnabled
```
public boolean isMobEnabled()
```
    Deprecated.
    
    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 HColumnDescriptor setMobEnabled(boolean value)
```
    Deprecated.
    
    Enables the mob for the family.
    
    Parameters:
    
    value - Whether to enable the mob for the family.
    
    Returns:
    
    this (for chained invocation)
  - getMobCompactPartitionPolicy
```
public MobCompactPartitionPolicy getMobCompactPartitionPolicy()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Get the mob compact partition policy for this family n
    
    Specified by:
    
    getMobCompactPartitionPolicy in interface ColumnFamilyDescriptor
  - setMobCompactPartitionPolicy
```
public HColumnDescriptor setMobCompactPartitionPolicy(MobCompactPartitionPolicy value)
```
    Deprecated.
    
    Set the mob compact partition policy for the family.
    
    Parameters:
    
    value - policy type
    
    Returns:
    
    this (for chained invocation)
  - getDFSReplication
```
public short getDFSReplication()
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Returns replication factor set for this CF
    
    Specified by:
    
    getDFSReplication in interface ColumnFamilyDescriptor
  - setDFSReplication
```
public HColumnDescriptor setDFSReplication(short value)
```
    Deprecated.
    
    Set the replication factor to hfile(s) belonging to this family
    
    Parameters:
    
    value - number of replicas the blocks(s) belonging to this CF should have, or DEFAULT_DFS_REPLICATION for the default replication factor set in the filesystem
    
    Returns:
    
    this (for chained invocation)
  - getStoragePolicy
```
public String getStoragePolicy()
```
    Deprecated.
    
    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 HColumnDescriptor setStoragePolicy(String value)
```
    Deprecated.
    
    Set the storage policy for use with this family
    
    Parameters:
    
    value - the policy to set, valid setting includes: "LAZY_PERSIST", "ALL_SSD", "ONE_SSD", "HOT", "WARM", "COLD"
  - getValue
```
public Bytes getValue(Bytes key)
```
    Deprecated.
    
    Description copied from interface: ColumnFamilyDescriptor
    
    Get a configuration value.
    
    Specified by:
    
    getValue in interface ColumnFamilyDescriptor
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    A clone value. Null if no mapping for the key
  - getDelegateeForModification
```
protected org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor getDelegateeForModification()
```
    Deprecated.

Class HColumnDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IN_MEMORY_COMPACTION

COMPRESSION

COMPRESSION_COMPACT

COMPRESSION_COMPACT_MAJOR

COMPRESSION_COMPACT_MINOR

ENCODE_ON_DISK

DATA_BLOCK_ENCODING

BLOCKCACHE

CACHE_DATA_ON_WRITE

CACHE_INDEX_ON_WRITE

CACHE_BLOOMS_ON_WRITE

EVICT_BLOCKS_ON_CLOSE

CACHE_DATA_IN_L1

PREFETCH_BLOCKS_ON_OPEN

BLOCKSIZE

LENGTH

TTL

BLOOMFILTER

FOREVER

REPLICATION_SCOPE

REPLICATION_SCOPE_BYTES

MIN_VERSIONS

KEEP_DELETED_CELLS

COMPRESS_TAGS

ENCRYPTION

ENCRYPTION_KEY

IS_MOB

IS_MOB_BYTES

MOB_THRESHOLD

MOB_THRESHOLD_BYTES

DEFAULT_MOB_THRESHOLD

MOB_COMPACT_PARTITION_POLICY

MOB_COMPACT_PARTITION_POLICY_BYTES

DEFAULT_MOB_COMPACT_PARTITION_POLICY

DFS_REPLICATION

DEFAULT_DFS_REPLICATION

STORAGE_POLICY

DEFAULT_COMPRESSION

DEFAULT_ENCODE_ON_DISK

DEFAULT_DATA_BLOCK_ENCODING

DEFAULT_VERSIONS

DEFAULT_MIN_VERSIONS

DEFAULT_IN_MEMORY

DEFAULT_KEEP_DELETED

DEFAULT_BLOCKCACHE

DEFAULT_CACHE_DATA_ON_WRITE

DEFAULT_CACHE_DATA_IN_L1

DEFAULT_CACHE_INDEX_ON_WRITE

DEFAULT_BLOCKSIZE

DEFAULT_BLOOMFILTER

DEFAULT_CACHE_BLOOMS_ON_WRITE

DEFAULT_TTL

DEFAULT_REPLICATION_SCOPE

DEFAULT_EVICT_BLOCKS_ON_CLOSE

DEFAULT_COMPRESS_TAGS

DEFAULT_PREFETCH_BLOCKS_ON_OPEN

NEW_VERSION_BEHAVIOR

DEFAULT_NEW_VERSION_BEHAVIOR

delegatee

Constructor Detail

HColumnDescriptor

HColumnDescriptor

HColumnDescriptor

HColumnDescriptor

HColumnDescriptor

Method Detail

isLegalFamilyName

getName

getNameAsString

getValue

getValue

getValues

setValue

remove