VMware GemFire Java API Reference
Package org.apache.geode.management.api
Class ClusterManagementResult
- java.lang.Object
-
- org.apache.geode.management.api.ClusterManagementResult
-
- Direct Known Subclasses:
ClusterManagementGetResult,ClusterManagementListOperationsResult,ClusterManagementListResult,ClusterManagementOperationResult,ClusterManagementRealizationResult
@Experimental public class ClusterManagementResult extends Object
This base class provides the common attributes returned from allClusterManagementServicemethods
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classClusterManagementResult.StatusCodethese status codes generally have a one-to-one mapping to the http status code returned by the REST controller
-
Constructor Summary
Constructors Constructor Description ClusterManagementResult()for internal use onlyClusterManagementResult(ClusterManagementResult copyFrom)for internal use onlyClusterManagementResult(ClusterManagementResult.StatusCode statusCode, String message)for internal use only
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)ClusterManagementResult.StatusCodegetStatusCode()Returns theClusterManagementResult.StatusCodefor this request, such as ERROR or OK.StringgetStatusMessage()Returns an optional message to accompanygetStatusCode()inthashCode()booleanisSuccessful()Returns true ifgetStatusCode()has a non-error valuevoidsetLinks(Links links)for internal use onlyvoidsetStatus(ClusterManagementResult.StatusCode statusCode, String message)for internal use onlyStringtoString()Returns the status code and message
-
-
-
Constructor Detail
-
ClusterManagementResult
public ClusterManagementResult()
for internal use only
-
ClusterManagementResult
public ClusterManagementResult(ClusterManagementResult.StatusCode statusCode, String message)
for internal use only- Parameters:
statusCode- theClusterManagementResult.StatusCodeto setmessage- the status message to set
-
ClusterManagementResult
public ClusterManagementResult(ClusterManagementResult copyFrom)
for internal use only- Parameters:
copyFrom- theClusterManagementResultto copy from
-
-
Method Detail
-
setStatus
public void setStatus(ClusterManagementResult.StatusCode statusCode, String message)
for internal use only- Parameters:
statusCode- theClusterManagementResult.StatusCodeto setmessage- the status message to set
-
getStatusMessage
public String getStatusMessage()
Returns an optional message to accompanygetStatusCode()- Returns:
- an optional message to accompany
getStatusCode()
-
setLinks
public void setLinks(Links links)
for internal use only- Parameters:
links- theLinksto set
-
isSuccessful
public boolean isSuccessful()
Returns true ifgetStatusCode()has a non-error value- Returns:
- true if
getStatusCode()has a non-error value
-
getStatusCode
public ClusterManagementResult.StatusCode getStatusCode()
Returns theClusterManagementResult.StatusCodefor this request, such as ERROR or OK.- Returns:
- the
ClusterManagementResult.StatusCodefor this request
-
toString
public String toString()
Returns the status code and message
-
-