Class ApiFault
java.lang.Object
com.microsoft.store.partnercenter.models.ResourceBase
com.microsoft.store.partnercenter.models.ApiFault
public class ApiFault extends ResourceBase
Represents API failures.
-
Constructor Summary
Constructors Modifier Constructor Description protectedApiFault()Initializes a new instance of the ApiFault class. -
Method Summary
Modifier and Type Method Description StringgetErrorCode()Gets the error code.Iterable<Object>getErrorData()Gets the additional fault information if present.StringgetErrorMessage()Gets the error message.booleangetIsRetryable()Gets a flag indicating whether or not the fault is retryable.voidsetErrorCode(String value)Sets the error code.voidsetErrorData(Iterable<Object> value)Sets the additional fault information.voidsetErrorMessage(String value)Sets the error message.voidsetIsRetryable(boolean value)Sets a flag indicating whether or not the fault is retryable.StringtoString()Returns a meaningful summary about the API fault.
-
Constructor Details
-
ApiFault
protected ApiFault()Initializes a new instance of the ApiFault class.
-
-
Method Details
-
getErrorCode
Gets the error code.- Returns:
- The error code.
-
setErrorCode
Sets the error code.- Parameters:
value- The error code.
-
getErrorMessage
Gets the error message.- Returns:
- The error message.
-
setErrorMessage
Sets the error message.- Parameters:
value- The error message.
-
getErrorData
Gets the additional fault information if present.- Returns:
- The additional fault information if present.
-
setErrorData
Sets the additional fault information.- Parameters:
value- The additional fault information.
-
getIsRetryable
public boolean getIsRetryable()Gets a flag indicating whether or not the fault is retryable.- Returns:
- A flag indicating whether or not the fault is retryable.
-
setIsRetryable
public void setIsRetryable(boolean value)Sets a flag indicating whether or not the fault is retryable.- Parameters:
value- A flag indicating whether or not the fault is retryable.
-
toString
Returns a meaningful summary about the API fault.
-