ApiFault Class

public class ApiFault extends ResourceBase

Represents API failures.

Constructor Summary

Modifier Constructor Description
protected ApiFault()

Initializes a new instance of the ApiFault class.

Method Summary

Modifier and Type Method and Description
java.lang.String getErrorCode()

Gets the error code.

java.lang.Iterable<java.lang.Object> getErrorData()

Gets the additional fault information if present.

java.lang.String getErrorMessage()

Gets the error message.

boolean getIsRetryable()

Gets a flag indicating whether or not the fault is retryable.

void setErrorCode(String value)

Sets the error code.

void setErrorData(Iterable<Object> value)

Sets the additional fault information.

void setErrorMessage(String value)

Sets the error message.

void setIsRetryable(boolean value)

Sets a flag indicating whether or not the fault is retryable.

java.lang.String toString()

Returns a meaningful summary about the API fault.

Inherited Members

ResourceBase.getAttributes() java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructor Details

ApiFault

protected ApiFault()

Initializes a new instance of the ApiFault class.

Method Details

getErrorCode

public String getErrorCode()

Gets the error code.

Returns:

The error code.

getErrorData

public Iterable getErrorData()

Gets the additional fault information if present.

Returns:

The additional fault information if present.

getErrorMessage

public String getErrorMessage()

Gets the error message.

Returns:

The error message.

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.

setErrorCode

public void setErrorCode(String value)

Sets the error code.

Parameters:

value - The error code.

setErrorData

public void setErrorData(Iterable value)

Sets the additional fault information.

Parameters:

value - The additional fault information.

setErrorMessage

public void setErrorMessage(String value)

Sets the error message.

Parameters:

value - The error message.

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

public String toString()

Returns a meaningful summary about the API fault.

Overrides:

ApiFault.toString()

Returns:

The API fault summary.

Applies to