Package dev.restate.sdk.common

Class TerminalException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

dev.restate.sdk.common.TerminalException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TimeoutException

public class TerminalException
extends RuntimeException

When thrown in a Restate service method, it will complete the invocation with an error.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ABORTED_CODE
static final int	BAD_REQUEST_CODE
static final int	CANCELLED_CODE
static final int	INTERNAL_SERVER_ERROR_CODE

Constructor Summary

Constructors

Constructor	Description
TerminalException()
TerminalException(int code)	Like TerminalException(int, String), without message.
TerminalException(int code, String message)	Create a new TerminalException.
TerminalException(int code, String message, Map<String,String> metadata)	Create a new TerminalException.
TerminalException(String message)	Like TerminalException(int, String), with code INTERNAL_SERVER_ERROR_CODE.
TerminalException(String message, Map<String,String> metadata)	Create a new TerminalException.

Method Summary

Modifier and Type	Method	Description
int	getCode()
Map<String,String>	getMetadata()

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 Details

ABORTED_CODE

public static final int ABORTED_CODE

See Also:

• Constant Field Values

CANCELLED_CODE

public static final int CANCELLED_CODE

See Also:

• Constant Field Values

BAD_REQUEST_CODE

public static final int BAD_REQUEST_CODE

See Also:

• Constant Field Values

INTERNAL_SERVER_ERROR_CODE

public static final int INTERNAL_SERVER_ERROR_CODE

See Also:

• Constant Field Values

Constructor Details

TerminalException

public TerminalException()

TerminalException

public TerminalException(int code)

Like TerminalException(int, String), without message.

TerminalException

public TerminalException(int code,
 String message)

Create a new TerminalException.

Parameters:

code - HTTP response status code

message - error message

TerminalException

public TerminalException(String message)

Like TerminalException(int, String), with code INTERNAL_SERVER_ERROR_CODE.

TerminalException

public TerminalException(int code,
 String message,
 Map<String,String> metadata)

Create a new TerminalException.

Parameters:

code - HTTP response status code

message - error message

metadata - error metadata (supported only from Restate > 1.6)

TerminalException

public TerminalException(String message,
 Map<String,String> metadata)

Create a new TerminalException.

Parameters:

message - error message

metadata - error metadata (supported only from Restate > 1.6)

Method Details

getCode

public int getCode()

Returns:

status code

getMetadata

public Map<String,String> getMetadata()

Returns:

the error metadata