All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.gemstone.gemfire.cache.partition.PartitionRegionInfo Maven / Gradle / Ivy

There is a newer version: 2.0-BETA
Show newest version
/*
 * 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.partition;

import java.util.Set;

import com.gemstone.gemfire.cache.control.ResourceManager;

/**
 * Information describing the data storage and distribution of a 
 * partitioned region. The {@link PartitionRegionHelper} is used to gather 
 * PartitionRegionInfo. Each instance describes a single 
 * partitioned region identified by {@link #getRegionPath()}.
 * 

* This is an immutable snapshot of the information. * * @since 6.0 */ public interface PartitionRegionInfo { /** * Returns the {@link com.gemstone.gemfire.cache.Region#getFullPath() * full path} of the partitioned region that this object describes. * * @return the full path of the partitioned region that this info describes */ public String getRegionPath(); /** * Returns an immutable set of PartitionMemberInfo * representing every member that is configured to provide storage space to * the partitioned region. * * @return set of member info configured for storage space */ public Set getPartitionMemberInfo(); /** * Returns the {@link * com.gemstone.gemfire.cache.PartitionAttributes#getTotalNumBuckets() * configured number of buckets} for the partitioned region. * * @return the configured number of buckets */ public int getConfiguredBucketCount(); /** * Returns the number of actual buckets that have been created to hold data * for the partitioned region. This is less than or equal to {#link * #getConfiguredBucketCount()}. * * @return the current number of actual buckets that have been created */ public int getCreatedBucketCount(); /** * Returns the number of created buckets that have fewer than the {@link * #getConfiguredRedundantCopies() configured redundant copies} for this * partitioned region. * * @return the number of created buckets that have fewer than the configured * redundant copies * @see #getActualRedundantCopies() */ public int getLowRedundancyBucketCount(); /** * Returns the number of {@link * com.gemstone.gemfire.cache.PartitionAttributes#getRedundantCopies() * redundant copies} the partitioned region was configured for. * * @return the number of redundant copies the partitioned region was * configured for */ public int getConfiguredRedundantCopies(); /** * Returns the lowest number of redundant copies for any bucket holding * data for the partitioned region. If all data is currently at full * redundancy then this will return the same value as {@link * #getConfiguredRedundantCopies}. * * @return the lowest number of redundant copies for any bucket of the * partitioned region. */ public int getActualRedundantCopies(); /** * Returns the {@link com.gemstone.gemfire.cache.Region#getFullPath() * full path} of the partitioned region that this region has been configured * to be {@link com.gemstone.gemfire.cache.PartitionAttributes#getColocatedWith() * colocated with} or null if it is not colocated. * * @return the full path of the partitioned region that the region is * colocated with or null if there is none. */ public String getColocatedWith(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy