Gemfire JavaDocs
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 java.lang.Object
This base class provides the common attributes returned from allClusterManagementService
methods
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClusterManagementResult.StatusCode
these 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, java.lang.String message)
for internal use only
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
ClusterManagementResult.StatusCode
getStatusCode()
Returns theClusterManagementResult.StatusCode
for this request, such as ERROR or OK.java.lang.String
getStatusMessage()
Returns an optional message to accompanygetStatusCode()
int
hashCode()
boolean
isSuccessful()
Returns true ifgetStatusCode()
has a non-error valuevoid
setLinks(Links links)
for internal use onlyvoid
setStatus(ClusterManagementResult.StatusCode statusCode, java.lang.String message)
for internal use onlyjava.lang.String
toString()
Returns the status code and message
-
-
-
Constructor Detail
-
ClusterManagementResult
public ClusterManagementResult()
for internal use only
-
ClusterManagementResult
public ClusterManagementResult(ClusterManagementResult.StatusCode statusCode, java.lang.String message)
for internal use only- Parameters:
statusCode
- theClusterManagementResult.StatusCode
to setmessage
- the status message to set
-
ClusterManagementResult
public ClusterManagementResult(ClusterManagementResult copyFrom)
for internal use only- Parameters:
copyFrom
- theClusterManagementResult
to copy from
-
-
Method Detail
-
setStatus
public void setStatus(ClusterManagementResult.StatusCode statusCode, java.lang.String message)
for internal use only- Parameters:
statusCode
- theClusterManagementResult.StatusCode
to setmessage
- the status message to set
-
getStatusMessage
public java.lang.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
- theLinks
to 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.StatusCode
for this request, such as ERROR or OK.- Returns:
- the
ClusterManagementResult.StatusCode
for this request
-
toString
public java.lang.String toString()
Returns the status code and message- Overrides:
toString
in classjava.lang.Object
- Returns:
- the status code and message as a String
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-