Gemfire JavaDocs
Package org.apache.geode.management.api
Class ClusterManagementOperationResult<A extends ClusterManagementOperation<V>,V extends OperationResult>
- java.lang.Object
-
- org.apache.geode.management.api.ClusterManagementResult
-
- org.apache.geode.management.api.ClusterManagementOperationResult<A,V>
-
- Type Parameters:
V
- the type of the operation's result
@Experimental public class ClusterManagementOperationResult<A extends ClusterManagementOperation<V>,V extends OperationResult> extends ClusterManagementResult
Returned byClusterManagementService.start(ClusterManagementOperation)
to convey status of launching the async operation, and byClusterManagementService.get(ClusterManagementOperation, String)
to describe the status of a started async operation.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.geode.management.api.ClusterManagementResult
ClusterManagementResult.StatusCode
-
-
Constructor Summary
Constructors Constructor Description ClusterManagementOperationResult()
for internal use onlyClusterManagementOperationResult(ClusterManagementResult.StatusCode statusCode, java.lang.String message, java.util.Date operationStart, java.util.Date operationEnd, A operation, java.lang.String operationId, V operationResult, java.lang.Throwable throwable)
normally called byClusterManagementService.start(ClusterManagementOperation)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description A
getOperation()
Returns the async operation.java.util.Date
getOperationEnd()
Returns the time the operation was completed.java.lang.String
getOperationId()
returns the operation id started by this operation.V
getOperationResult()
Returns the operation result as an extension ofOperationResult
java.util.Date
getOperationStart()
Returns the time the operation was startedjava.lang.Throwable
getThrowable()
Returns any exceptions that might be returned as a result of the operation.-
Methods inherited from class org.apache.geode.management.api.ClusterManagementResult
equals, getStatusCode, getStatusMessage, hashCode, isSuccessful, setLinks, setStatus, toString
-
-
-
-
Constructor Detail
-
ClusterManagementOperationResult
public ClusterManagementOperationResult()
for internal use only
-
ClusterManagementOperationResult
public ClusterManagementOperationResult(ClusterManagementResult.StatusCode statusCode, java.lang.String message, java.util.Date operationStart, java.util.Date operationEnd, A operation, java.lang.String operationId, V operationResult, java.lang.Throwable throwable)
normally called byClusterManagementService.start(ClusterManagementOperation)
- Parameters:
statusCode
- theStatusCode
of the resultmessage
- the status message to setoperationStart
- aDate
representing the time the operation startedoperationEnd
- aDate
representing the time the operation endedoperation
- the operationoperationId
- the ID of the operationoperationResult
- the operation's resultthrowable
- an exception that occurred as a result of the operation, if any
-
-
Method Detail
-
getOperation
public A getOperation()
Returns the async operation.- Returns:
- the operation that this
ClusterManagementOperationResult
describes
-
getOperationId
public java.lang.String getOperationId()
returns the operation id started by this operation.- Returns:
- the operation ID of the operation that this
ClusterManagementOperationResult
describes
-
getOperationStart
public java.util.Date getOperationStart()
Returns the time the operation was started- Returns:
- the time the operation was started
-
getOperationEnd
public java.util.Date getOperationEnd()
Returns the time the operation was completed. This value is null while the operation is in process.- Returns:
- the time at which the operation completed, or null if the operation has not completed
-
getOperationResult
public V getOperationResult()
Returns the operation result as an extension ofOperationResult
- Returns:
- the result of the operation
-
getThrowable
public java.lang.Throwable getThrowable()
Returns any exceptions that might be returned as a result of the operation. Null in case no exceptions occurred.- Returns:
- any exceptions that might be returned as a result of the operation
-
-