VMware GemFire Java API Reference
Interface RestoreRedundancyResults
-
- All Superinterfaces:
JsonSerializable,OperationResult,java.io.Serializable
@Experimental public interface RestoreRedundancyResults extends OperationResult
A class to collect the results of restore redundancy operations for one or more regions and determine the success of failure of the operation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classRestoreRedundancyResults.StatusRestoreRedundancyResults.Status.SUCCESSis defined as every included region having fully satisfied redundancy.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<java.lang.String>getIncludedRegionsWithNoMembers()If user specified "includedRegion" list, but some of the regions in the list are not found in any members, this list would include those regions.java.lang.StringgetRegionOperationMessage()Returns a message describing the results of this restore redundancy operation.RestoreRedundancyResults.StatusgetRegionOperationStatus()Returns theRestoreRedundancyResults.Statusof this restore redundancy operation.RegionRedundancyStatusgetRegionResult(java.lang.String regionName)Returns theRegionRedundancyStatusfor a specific region or null if that region is not present in thisRestoreRedundancyResults.java.util.Map<java.lang.String,RegionRedundancyStatus>getRegionResults()Returns all theRegionRedundancyStatusescontained in thisRestoreRedundancyResults.java.util.Map<java.lang.String,RegionRedundancyStatus>getSatisfiedRedundancyRegionResults()Returns all theRegionRedundancyStatusesfor regions with redundancy satisfied.intgetTotalPrimaryTransfersCompleted()Returns the total number of primaries that were transferred as part of the restore redundancy operations.longgetTotalPrimaryTransferTime()Returns the total time spent transferring primaries as part of the restore redundancy operations.java.util.Map<java.lang.String,RegionRedundancyStatus>getUnderRedundancyRegionResults()Returns all theRegionRedundancyStatusesfor regions with with at least one redundant copy, but fewer than the configured number of redundant copies.java.util.Map<java.lang.String,RegionRedundancyStatus>getZeroRedundancyRegionResults()Returns all theRegionRedundancyStatusesfor regions with configured redundancy but zero actual redundant copies.-
Methods inherited from interface org.apache.geode.management.runtime.OperationResult
getStatusMessage, getSuccess
-
-
-
-
Method Detail
-
getRegionOperationStatus
RestoreRedundancyResults.Status getRegionOperationStatus()
Returns theRestoreRedundancyResults.Statusof this restore redundancy operation. Possible statuses areRestoreRedundancyResults.Status.SUCCESS,RestoreRedundancyResults.Status.FAILURE- Returns:
- The
RestoreRedundancyResults.Statusof this restore redundancy operation.
-
getRegionOperationMessage
java.lang.String getRegionOperationMessage()
Returns a message describing the results of this restore redundancy operation.- Returns:
- A
Stringdescribing the results of this restore redundancy operation.
-
getRegionResult
RegionRedundancyStatus getRegionResult(java.lang.String regionName)
Returns theRegionRedundancyStatusfor a specific region or null if that region is not present in thisRestoreRedundancyResults.- Parameters:
regionName- The region to which theRegionRedundancyStatusto be returned belongs.- Returns:
- A
RegionRedundancyStatusfor the specified region or null if that region is not present in thisRestoreRedundancyResults.
-
getZeroRedundancyRegionResults
java.util.Map<java.lang.String,RegionRedundancyStatus> getZeroRedundancyRegionResults()
Returns all theRegionRedundancyStatusesfor regions with configured redundancy but zero actual redundant copies.- Returns:
- A
MapofStringregion name toRegionRedundancyStatusfor every region contained in thisRestoreRedundancyResultswith configured redundancy but zero actual redundant copies.
-
getUnderRedundancyRegionResults
java.util.Map<java.lang.String,RegionRedundancyStatus> getUnderRedundancyRegionResults()
Returns all theRegionRedundancyStatusesfor regions with with at least one redundant copy, but fewer than the configured number of redundant copies.- Returns:
- A
MapofStringregion name toRegionRedundancyStatusfor every region contained in thisRestoreRedundancyResultswith at least one redundant copy, but fewer than the configured number of redundant copies.
-
getSatisfiedRedundancyRegionResults
java.util.Map<java.lang.String,RegionRedundancyStatus> getSatisfiedRedundancyRegionResults()
Returns all theRegionRedundancyStatusesfor regions with redundancy satisfied.- Returns:
- A
MapofStringregion name toRegionRedundancyStatusfor every region contained in thisRestoreRedundancyResultswith redundancy satisfied.
-
getRegionResults
java.util.Map<java.lang.String,RegionRedundancyStatus> getRegionResults()
Returns all theRegionRedundancyStatusescontained in thisRestoreRedundancyResults. This method may return the actual backing map depending on implementation.- Returns:
- A
MapofStringregion name toRegionRedundancyStatusfor every region contained in thisRestoreRedundancyResults.
-
getTotalPrimaryTransfersCompleted
int getTotalPrimaryTransfersCompleted()
Returns the total number of primaries that were transferred as part of the restore redundancy operations.- Returns:
- the total number of primaries that were transferred
-
getTotalPrimaryTransferTime
long getTotalPrimaryTransferTime()
Returns the total time spent transferring primaries as part of the restore redundancy operations.- Returns:
- A
longrepresenting the total time in milliseconds spent transferring primaries
-
getIncludedRegionsWithNoMembers
java.util.List<java.lang.String> getIncludedRegionsWithNoMembers()
If user specified "includedRegion" list, but some of the regions in the list are not found in any members, this list would include those regions.- Returns:
- a List of region names for which no hosting members were found
-
-