Gemfire JavaDocs
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 class
RestoreRedundancyResults.Status
RestoreRedundancyResults.Status.SUCCESS
is 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.String
getRegionOperationMessage()
Returns a message describing the results of this restore redundancy operation.RestoreRedundancyResults.Status
getRegionOperationStatus()
Returns theRestoreRedundancyResults.Status
of this restore redundancy operation.RegionRedundancyStatus
getRegionResult(java.lang.String regionName)
Returns theRegionRedundancyStatus
for a specific region or null if that region is not present in thisRestoreRedundancyResults
.java.util.Map<java.lang.String,RegionRedundancyStatus>
getRegionResults()
Returns all theRegionRedundancyStatuses
contained in thisRestoreRedundancyResults
.java.util.Map<java.lang.String,RegionRedundancyStatus>
getSatisfiedRedundancyRegionResults()
Returns all theRegionRedundancyStatuses
for regions with redundancy satisfied.int
getTotalPrimaryTransfersCompleted()
Returns the total number of primaries that were transferred as part of the restore redundancy operations.long
getTotalPrimaryTransferTime()
Returns the total time spent transferring primaries as part of the restore redundancy operations.java.util.Map<java.lang.String,RegionRedundancyStatus>
getUnderRedundancyRegionResults()
Returns all theRegionRedundancyStatuses
for 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 theRegionRedundancyStatuses
for 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.Status
of this restore redundancy operation. Possible statuses areRestoreRedundancyResults.Status.SUCCESS
,RestoreRedundancyResults.Status.FAILURE
- Returns:
- The
RestoreRedundancyResults.Status
of this restore redundancy operation.
-
getRegionOperationMessage
java.lang.String getRegionOperationMessage()
Returns a message describing the results of this restore redundancy operation.- Returns:
- A
String
describing the results of this restore redundancy operation.
-
getRegionResult
RegionRedundancyStatus getRegionResult(java.lang.String regionName)
Returns theRegionRedundancyStatus
for a specific region or null if that region is not present in thisRestoreRedundancyResults
.- Parameters:
regionName
- The region to which theRegionRedundancyStatus
to be returned belongs.- Returns:
- A
RegionRedundancyStatus
for the specified region or null if that region is not present in thisRestoreRedundancyResults
.
-
getZeroRedundancyRegionResults
java.util.Map<java.lang.String,RegionRedundancyStatus> getZeroRedundancyRegionResults()
Returns all theRegionRedundancyStatuses
for regions with configured redundancy but zero actual redundant copies.- Returns:
- A
Map
ofString
region name toRegionRedundancyStatus
for every region contained in thisRestoreRedundancyResults
with configured redundancy but zero actual redundant copies.
-
getUnderRedundancyRegionResults
java.util.Map<java.lang.String,RegionRedundancyStatus> getUnderRedundancyRegionResults()
Returns all theRegionRedundancyStatuses
for regions with with at least one redundant copy, but fewer than the configured number of redundant copies.- Returns:
- A
Map
ofString
region name toRegionRedundancyStatus
for every region contained in thisRestoreRedundancyResults
with 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 theRegionRedundancyStatuses
for regions with redundancy satisfied.- Returns:
- A
Map
ofString
region name toRegionRedundancyStatus
for every region contained in thisRestoreRedundancyResults
with redundancy satisfied.
-
getRegionResults
java.util.Map<java.lang.String,RegionRedundancyStatus> getRegionResults()
Returns all theRegionRedundancyStatuses
contained in thisRestoreRedundancyResults
. This method may return the actual backing map depending on implementation.- Returns:
- A
Map
ofString
region name toRegionRedundancyStatus
for 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
long
representing 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
-
-