io.nexusrpc

Class Header

java.lang.Object

io.nexusrpc.Header

public class Header
extends java.lang.Object

Collection of well-known headers for Nexus.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_ID Deprecated. Use OPERATION_TOKEN instead.
static java.lang.String	OPERATION_START_TIME Header for to set time the operation started.
static java.lang.String	OPERATION_TIMEOUT Total time to complete a Nexus operation.
static java.lang.String	OPERATION_TOKEN Header for the unique token returned by the StartOperation response for async operations.
static java.lang.String	REQUEST_TIMEOUT Header for the total time to complete a Nexus request.
static java.lang.String	RETRYABLE Handlers may specify the Nexus-Request-Retryable header to explicitly instruct a caller whether to retry a request.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_TIMEOUT

public static final java.lang.String REQUEST_TIMEOUT

Header for the total time to complete a Nexus request.

See Also:

Constant Field Values

OPERATION_TIMEOUT

public static final java.lang.String OPERATION_TIMEOUT

Total time to complete a Nexus operation. Unlike REQUEST_TIMEOUT, this applies to the whole operation, not just a single HTTP request.

See Also:

Constant Field Values

OPERATION_ID

@Deprecated
public static final java.lang.String OPERATION_ID

Deprecated. Use OPERATION_TOKEN instead.

Header for the unique ID returned by the StartOperation response for async operations. Must be set on callback headers to support completing operations before the start response is received.

See Also:

Constant Field Values

OPERATION_TOKEN

public static final java.lang.String OPERATION_TOKEN

Header for the unique token returned by the StartOperation response for async operations. Must be set on callback headers to support completing operations before the start response is received.

See Also:

Constant Field Values

OPERATION_START_TIME

public static final java.lang.String OPERATION_START_TIME

Header for to set time the operation started. Used when a completion request is received before a started response. Should be in a valid HTTP/1.1 format per https://www.rfc-editor.org/rfc/rfc5322.html#section-3.3. If is omitted, the time the completion is received will be used as operation start time.

See Also:

Constant Field Values

RETRYABLE

public static final java.lang.String RETRYABLE

Handlers may specify the Nexus-Request-Retryable header to explicitly instruct a caller whether to retry a request. Unless specified, retry behavior is determined from the predefined handler error type. For example INTERNAL errors is not retryable by default unless specified otherwise.

See Also:

Constant Field Values