Package org.apache.geode.management.operation

Class RebalanceOperation

java.lang.Object
org.apache.geode.management.operation.RebalanceOperation
All Implemented Interfaces:
Serializable, ClusterManagementOperation<RebalanceResult>, JsonSerializable
@Experimental public class RebalanceOperation extends Object implements ClusterManagementOperation<RebalanceResult>
Defines a distributed system request to optimize bucket allocation across members.
See Also:

  • Field Details

  • Constructor Details

    • RebalanceOperation

      public RebalanceOperation()
      by default, requests all partitioned regions to be rebalanced

    • RebalanceOperation

      public RebalanceOperation(RebalanceOperation other)
      Copy constructor
      Parameters:
      other - The RebalanceOperation to copy

  • Method Details

    • isSimulate

      public boolean isSimulate()
      Returns true if a "dry run" only is requested
      Returns:
      true if a "dry run" only is requested

    • setSimulate

      public void setSimulate(boolean simulate)
      true requests a "dry run" (no actual buckets will be moved) default is false
      Parameters:
      simulate - boolean specifying if the rebalance should be simulated

    • getIncludeRegions

      public List<String> getIncludeRegions()
      Returns the list of regions to be rebalanced (or an empty list for all-except-excluded)
      Returns:
      the list of regions to be rebalanced (or an empty list for all-except-excluded)

    • setIncludeRegions

      public void setIncludeRegions(List<String> includeRegions)
      Requests rebalance of the specified region(s) only. When at least one region is specified, this takes precedence over any excluded regions.
      Parameters:
      includeRegions - a list of region names to include in the rebalance operation

    • getExcludeRegions

      public List<String> getExcludeRegions()
      Returns the list of regions NOT to be rebalanced (iff getIncludeRegions() is empty)
      Returns:
      the list of regions NOT to be rebalanced (iff getIncludeRegions() is empty

    • setExcludeRegions

      public void setExcludeRegions(List<String> excludeRegions)
      Excludes specific regions from the rebalance, if getIncludeRegions() is empty, otherwise has no effect default: no regions are excluded
      Parameters:
      excludeRegions - a list of region names to exclude from the rebalance operation

    • getEndpoint

      public String getEndpoint()
      Description copied from interface: ClusterManagementOperation
      must match the REST controller's RequestMapping
      Specified by:
      getEndpoint in interface ClusterManagementOperation<RebalanceResult>
      Returns:
      the portion after /management/v1, e.g. /operations/name

    • getOperator

      public String getOperator()
      Specified by:
      getOperator in interface ClusterManagementOperation<RebalanceResult>

    • setOperator

      public void setOperator(String operator)