com.gemstone.gemfire.cache.control.RebalanceResults Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
There is a newer version: 2.0-BETA
/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License. You
 * may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License. See accompanying
 * LICENSE file.
 */

package com.gemstone.gemfire.cache.control;

import java.util.Set;

import com.gemstone.gemfire.cache.partition.PartitionRebalanceInfo;

/**
 * The results of rebalancing Cache resources.
 * 
 * @since 6.0
 */
public interface RebalanceResults {
  
  /**
   * Returns a Set of detailed information about each partitioned
   * region that was rebalanced.
   * 
   * @return a Set of detailed information about each partitioned
   * region that was rebalanced
   */
  public Set getPartitionRebalanceDetails();
  
  /**
   * Returns the total time, in milliseconds, that the rebalance operation took.
   * 
   * @return the total time, in milliseconds, that the rebalance operation took
   */
  public long getTotalTime();
  
  /**
   * Returns the total number of buckets created during the rebalance operation.
   * 
   * @return the total number of buckets created during the rebalance operation
   */
  public int getTotalBucketCreatesCompleted();
  
  /**
   * Returns the total size, in bytes, of all of the buckets that were created
   * as part of the rebalance operation.
   * 
   * @return the total size, in bytes, of all of the buckets that were created
   * as part of the rebalance operation
   */
  public long getTotalBucketCreateBytes();
  
  /**
   * Returns the total time, in milliseconds, taken to create buckets.
   * 
   * @return the total time, in milliseconds, taken to create buckets
   */
  public long getTotalBucketCreateTime();
  
  /**
   * Returns the total number of buckets transferred.
   * 
   * @return the total number of buckets transferred
   */
  public int getTotalBucketTransfersCompleted();
  
  /**
   * Returns the total size, in bytes, of buckets that were transferred.
   * 
   * @return the total size, in bytes, of buckets that were transferred
   */
  public long getTotalBucketTransferBytes();
  
  /**
   * Returns the total amount of time, in milliseconds, it took to transfer
   * buckets.
   * 
   * @return the total amount of time, in milliseconds, it took to transfer 
   * buckets
   */
  public long getTotalBucketTransferTime();
  
  /**
   * Returns the total number of primaries that were transferred.
   * 
   * @return the total number of primaries that were transferred
   */
  public int getTotalPrimaryTransfersCompleted();
  
  /**
   * Returns the total time, in milliseconds, spent transferring primaries.
   * 
   * @return the total time, in milliseconds, spent transferring primaries
   */
  public long getTotalPrimaryTransferTime();
}