BlockPlacementStatus (Apache Hadoop HDFS 3.5.0 API)
Description: declaration: package: org.apache.hadoop.hdfs.server.blockmanagement, interface: BlockPlacementStatus

Package org.apache.hadoop.hdfs.server.blockmanagement

# Interface BlockPlacementStatus

All Known Implementing Classes:
  `BlockPlacementStatusDefault`, `BlockPlacementStatusWithNodeGroup`, `BlockPlacementStatusWithUpgradeDomain`

@Private @Evolving public interface BlockPlacementStatus

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getAdditionalReplicasRequired()`
  Return the number of additional replicas needed to ensure the block placement policy is satisfied.
  `String`
  `getErrorDescription()`
  Get description info for log or printed in case replicas are failed to meet requirement of placement policy
  `boolean`
  `isPlacementPolicySatisfied()`
  Boolean value to identify if replicas of this block satisfy requirement of placement policy

- ## Method Details

  - ### isPlacementPolicySatisfied

    boolean isPlacementPolicySatisfied()
    Boolean value to identify if replicas of this block satisfy requirement of placement policy
    Returns:
      if replicas satisfy placement policy's requirement

  - ### getErrorDescription

    String getErrorDescription()
    Get description info for log or printed in case replicas are failed to meet requirement of placement policy
    Returns:
      description in case replicas are failed to meet requirement of placement policy

  - ### getAdditionalReplicasRequired

    int getAdditionalReplicasRequired()
    Return the number of additional replicas needed to ensure the block placement policy is satisfied.
    Returns:
      The number of new replicas needed to satisify the placement policy or zero if no extra are needed