StorageStatus (Spark 2.2.0 JavaDoc)

Object
- org.apache.spark.storage.StorageStatus

Deprecated.
This class may be removed or made private in a future release. Since 2.2.0.
```
public class StorageStatus
extends Object
```
:: DeveloperApi :: Storage information for each BlockManager.
This class assumes BlockId and BlockStatus are immutable, such that the consumers of this class cannot mutate the source of the information. Accesses are not thread-safe.

Constructor Summary

Constructors
Constructor and Description
`StorageStatus(BlockManagerId blockManagerId, long maxMemory, scala.Option<Object> maxOnHeapMem, scala.Option<Object> maxOffHeapMem)` Deprecated.
`StorageStatus(BlockManagerId bmid, long maxMemory, scala.Option<Object> maxOnHeapMem, scala.Option<Object> maxOffHeapMem, scala.collection.Map<BlockId,BlockStatus> initialBlocks)` Deprecated. Create a storage status with an initial set of blocks, leaving the source unmodified.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BlockManagerId`	`blockManagerId()` Deprecated.
`scala.collection.Map<BlockId,BlockStatus>`	`blocks()` Deprecated. Return the blocks stored in this block manager.
`long`	`cacheSize()` Deprecated. Return the memory used by caching RDDs
`boolean`	`containsBlock(BlockId blockId)` Deprecated. Return whether the given block is stored in this block manager in O(1) time.
`long`	`diskUsed()` Deprecated. Return the disk space used by this block manager.
`long`	`diskUsedByRdd(int rddId)` Deprecated. Return the disk space used by the given RDD in this block manager in O(1) time.
`scala.Option<BlockStatus>`	`getBlock(BlockId blockId)` Deprecated. Return the given block stored in this block manager in O(1) time.
`long`	`maxMem()` Deprecated. Return the max memory can be used by this block manager.
`long`	`maxMemory()` Deprecated.
`scala.Option<Object>`	`maxOffHeapMem()` Deprecated.
`scala.Option<Object>`	`maxOnHeapMem()` Deprecated.
`long`	`memRemaining()` Deprecated. Return the memory remaining in this block manager.
`long`	`memUsed()` Deprecated. Return the memory used by this block manager.
`long`	`memUsedByRdd(int rddId)` Deprecated. Return the memory used by the given RDD in this block manager in O(1) time.
`int`	`numBlocks()` Deprecated. Return the number of blocks stored in this block manager in O(RDDs) time.
`int`	`numRddBlocks()` Deprecated. Return the number of RDD blocks stored in this block manager in O(RDDs) time.
`int`	`numRddBlocksById(int rddId)` Deprecated. Return the number of blocks that belong to the given RDD in O(1) time.
`scala.Option<Object>`	`offHeapCacheSize()` Deprecated. Return the memory used by off-heap caching RDDs
`scala.Option<Object>`	`offHeapMemRemaining()` Deprecated. Return the off-heap memory remaining in this block manager.
`scala.Option<Object>`	`offHeapMemUsed()` Deprecated. Return the off-heap memory used by this block manager.
`scala.Option<Object>`	`onHeapCacheSize()` Deprecated. Return the memory used by on-heap caching RDDs
`scala.Option<Object>`	`onHeapMemRemaining()` Deprecated. Return the on-heap memory remaining in this block manager.
`scala.Option<Object>`	`onHeapMemUsed()` Deprecated. Return the on-heap memory used by this block manager.
`scala.collection.Map<BlockId,BlockStatus>`	`rddBlocks()` Deprecated. Return the RDD blocks stored in this block manager.
`scala.collection.Map<BlockId,BlockStatus>`	`rddBlocksById(int rddId)` Deprecated. Return the blocks that belong to the given RDD stored in this block manager.
`scala.Option<StorageLevel>`	`rddStorageLevel(int rddId)` Deprecated. Return the storage level, if any, used by the given RDD in this block manager.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StorageStatus
```
public StorageStatus(BlockManagerId blockManagerId,
                     long maxMemory,
                     scala.Option<Object> maxOnHeapMem,
                     scala.Option<Object> maxOffHeapMem)
```
    Deprecated.
  - StorageStatus
```
public StorageStatus(BlockManagerId bmid,
                     long maxMemory,
                     scala.Option<Object> maxOnHeapMem,
                     scala.Option<Object> maxOffHeapMem,
                     scala.collection.Map<BlockId,BlockStatus> initialBlocks)
```
    Deprecated.
    
    Create a storage status with an initial set of blocks, leaving the source unmodified.
- Method Detail
  - blockManagerId
```
public BlockManagerId blockManagerId()
```
    Deprecated.
  - maxMemory
```
public long maxMemory()
```
    Deprecated.
  - maxOnHeapMem
```
public scala.Option<Object> maxOnHeapMem()
```
    Deprecated.
  - maxOffHeapMem
```
public scala.Option<Object> maxOffHeapMem()
```
    Deprecated.
  - blocks
```
public scala.collection.Map<BlockId,BlockStatus> blocks()
```
    Deprecated.
    
    Return the blocks stored in this block manager.
    
    Returns:
    
    (undocumented)
    
    Note:
    
    This is somewhat expensive, as it involves cloning the underlying maps and then concatenating them together. Much faster alternatives exist for common operations such as contains, get, and size.
  - rddBlocks
```
public scala.collection.Map<BlockId,BlockStatus> rddBlocks()
```
    Deprecated.
    
    Return the RDD blocks stored in this block manager.
    
    Returns:
    
    (undocumented)
    
    Note:
    
    This is somewhat expensive, as it involves cloning the underlying maps and then concatenating them together. Much faster alternatives exist for common operations such as getting the memory, disk, and off-heap memory sizes occupied by this RDD.
  - rddBlocksById
```
public scala.collection.Map<BlockId,BlockStatus> rddBlocksById(int rddId)
```
    Deprecated.
    
    Return the blocks that belong to the given RDD stored in this block manager.
  - containsBlock
```
public boolean containsBlock(BlockId blockId)
```
    Deprecated.
    
    Return whether the given block is stored in this block manager in O(1) time.
    
    Parameters:
    
    blockId - (undocumented)
    
    Returns:
    
    (undocumented)
    
    Note:
    
    This is much faster than this.blocks.contains, which is O(blocks) time.
  - getBlock
```
public scala.Option<BlockStatus> getBlock(BlockId blockId)
```
    Deprecated.
    
    Return the given block stored in this block manager in O(1) time.
    
    Parameters:
    
    blockId - (undocumented)
    
    Returns:
    
    (undocumented)
    
    Note:
    
    This is much faster than this.blocks.get, which is O(blocks) time.
  - numBlocks
```
public int numBlocks()
```
    Deprecated.
    
    Return the number of blocks stored in this block manager in O(RDDs) time.
    
    Returns:
    
    (undocumented)
    
    Note:
    
    This is much faster than this.blocks.size, which is O(blocks) time.
  - numRddBlocks
```
public int numRddBlocks()
```
    Deprecated.
    
    Return the number of RDD blocks stored in this block manager in O(RDDs) time.
    
    Returns:
    
    (undocumented)
    
    Note:
    
    This is much faster than this.rddBlocks.size, which is O(RDD blocks) time.
  - numRddBlocksById
```
public int numRddBlocksById(int rddId)
```
    Deprecated.
    
    Return the number of blocks that belong to the given RDD in O(1) time.
    
    Parameters:
    
    rddId - (undocumented)
    
    Returns:
    
    (undocumented)
    
    Note:
    
    This is much faster than this.rddBlocksById(rddId).size, which is O(blocks in this RDD) time.
  - maxMem
```
public long maxMem()
```
    Deprecated.
    
    Return the max memory can be used by this block manager.
  - memRemaining
```
public long memRemaining()
```
    Deprecated.
    
    Return the memory remaining in this block manager.
  - cacheSize
```
public long cacheSize()
```
    Deprecated.
    
    Return the memory used by caching RDDs
  - memUsed
```
public long memUsed()
```
    Deprecated.
    
    Return the memory used by this block manager.
  - onHeapMemRemaining
```
public scala.Option<Object> onHeapMemRemaining()
```
    Deprecated.
    
    Return the on-heap memory remaining in this block manager.
  - offHeapMemRemaining
```
public scala.Option<Object> offHeapMemRemaining()
```
    Deprecated.
    
    Return the off-heap memory remaining in this block manager.
  - onHeapMemUsed
```
public scala.Option<Object> onHeapMemUsed()
```
    Deprecated.
    
    Return the on-heap memory used by this block manager.
  - offHeapMemUsed
```
public scala.Option<Object> offHeapMemUsed()
```
    Deprecated.
    
    Return the off-heap memory used by this block manager.
  - onHeapCacheSize
```
public scala.Option<Object> onHeapCacheSize()
```
    Deprecated.
    
    Return the memory used by on-heap caching RDDs
  - offHeapCacheSize
```
public scala.Option<Object> offHeapCacheSize()
```
    Deprecated.
    
    Return the memory used by off-heap caching RDDs
  - diskUsed
```
public long diskUsed()
```
    Deprecated.
    
    Return the disk space used by this block manager.
  - memUsedByRdd
```
public long memUsedByRdd(int rddId)
```
    Deprecated.
    
    Return the memory used by the given RDD in this block manager in O(1) time.
  - diskUsedByRdd
```
public long diskUsedByRdd(int rddId)
```
    Deprecated.
    
    Return the disk space used by the given RDD in this block manager in O(1) time.
  - rddStorageLevel
```
public scala.Option<StorageLevel> rddStorageLevel(int rddId)
```
    Deprecated.
    
    Return the storage level, if any, used by the given RDD in this block manager.

Class StorageStatus

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

StorageStatus

StorageStatus

Method Detail

blockManagerId

maxMemory

maxOnHeapMem

maxOffHeapMem

blocks

rddBlocks

rddBlocksById

containsBlock

getBlock

numBlocks

numRddBlocks

numRddBlocksById

maxMem

memRemaining

cacheSize

memUsed

onHeapMemRemaining

offHeapMemRemaining

onHeapMemUsed

offHeapMemUsed

onHeapCacheSize

offHeapCacheSize

diskUsed

memUsedByRdd

diskUsedByRdd

rddStorageLevel