com.textkernel.tx.exceptions

Class TxException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.textkernel.tx.exceptions.TxException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TxUsableJobException, TxUsableResumeException

public class TxException
extends Exception

The most generic exception thrown by the SDK as a result of an error response from the API

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	HttpStatusCode The HTTP Status Code of the response.
Exception	InnerException If this exception was caused by another exception, the root cause will be here.
String	RequestBody The JSON request body, will only have a value if TxClient.ShowFullRequestBodyInExceptions is true
okhttp3.Response	RestResponse The raw response from the API
String	TransactionId The Id of the transaction, use this when reporting errors to Support
String	TxErrorCode The Info.Code of the response.

Constructor Summary

Constructors

Constructor and Description
TxException(String requestBody, okhttp3.Response response, ApiResponseInfo errorInfo)
TxException(String requestBody, okhttp3.Response response, ApiResponseInfoLite errorInfo, String transactionId)

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RestResponse

public okhttp3.Response RestResponse

The raw response from the API

HttpStatusCode

public int HttpStatusCode

The HTTP Status Code of the response. See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes

TxErrorCode

public String TxErrorCode

The Info.Code of the response. This will indicate what type of error occurred. See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes

TransactionId

public String TransactionId

The Id of the transaction, use this when reporting errors to Support

RequestBody

public String RequestBody

The JSON request body, will only have a value if TxClient.ShowFullRequestBodyInExceptions is true

InnerException

public Exception InnerException

If this exception was caused by another exception, the root cause will be here.

Constructor Detail

TxException

public TxException(String requestBody,
                   okhttp3.Response response,
                   ApiResponseInfoLite errorInfo,
                   String transactionId)

TxException

public TxException(String requestBody,
                   okhttp3.Response response,
                   ApiResponseInfo errorInfo)