Types -
http
- CachingPolicy CACHE_CONTROL_AND_VALIDATORS | RFC_7234
-
Used for configuring the caching behaviour. Setting the
policy
field in theCacheConfig
record allows the user to control the caching behaviour.
- Chunking CHUNKING_AUTO | CHUNKING_ALWAYS | CHUNKING_NEVER
-
Defines the possible values for the chunking configuration in HTTP services and clients.
AUTO
: If the payload is less than 8KB, content-length header is set in the outbound request/response, otherwise chunking header is set in the outbound request/responseALWAYS
: Always set chunking header in the responseNEVER
: Never set the chunking header even if the payload is larger than 8KB in the outbound request/response
- CircuitState CB_OPEN_STATE | CB_HALF_OPEN_STATE | CB_CLOSED_STATE
-
A finite type for modeling the states of the Circuit Breaker. The Circuit Breaker starts in the
CLOSED
state. If any failure thresholds are exceeded during execution, the circuit trips and goes to theOPEN
state. After the specified timeout period expires, the circuit goes to theHALF_OPEN
state. If the trial request sent while in theHALF_OPEN
state succeeds, the circuit goes back to theCLOSED
state.
- ClientAuthError AuthenticationError | AuthorizationError
-
Defines the Auth error types that returned from client
- ClientError ResiliencyError | ClientAuthError | OutboundRequestError | InboundResponseError | UnsupportedActionError | Http2ClientError | MaximumWaitTimeExceededError | SslError | GenericClientError
-
Defines the possible client error types
- Compression COMPRESSION_AUTO | COMPRESSION_ALWAYS | COMPRESSION_NEVER
-
Options to compress using gzip or deflate.
AUTO
: When service behaves as a HTTP gateway inbound request/response accept-encoding option is set as the outbound request/response accept-encoding/content-encoding optionALWAYS
: Always set accept-encoding/content-encoding in outbound request/responseNEVER
: Never set accept-encoding/content-encoding header in outbound request/response
- CredentialBearer AUTH_HEADER_BEARER | POST_BODY_BEARER | NO_BEARER
-
Specifies how to send the authentication credentials when exchanging tokens.
- HttpOperation HTTP_FORWARD | HTTP_GET | HTTP_POST | HTTP_DELETE | HTTP_OPTIONS | HTTP_PUT | HTTP_PATCH | HTTP_HEAD | HTTP_SUBMIT | HTTP_NONE
-
Defines the HTTP operations related to circuit breaker, failover and load balancer.
FORWARD
: Forward the specified payloadGET
: Request a resourcePOST
: Create a new resourceDELETE
: Deletes the specified resourceOPTIONS
: Request communication options availablePUT
: Replace the target resourcePATCH
: Apply partial modification to the resourceHEAD
: Identical toGET
but no resource body should be returnedSUBMIT
: Submits a http request and returns an HttpFuture objectNONE
: No operation should be performed
- InboundRequestError InitializingInboundRequestError | ReadingInboundRequestHeadersError | ReadingInboundRequestBodyError
-
Defines the listener error types that returned while receiving inbound request
- InboundResponseError InitializingInboundResponseError | ReadingInboundResponseHeadersError | ReadingInboundResponseBodyError
-
Defines the client error types that returned while receiving inbound response
- KeepAlive KEEPALIVE_AUTO | KEEPALIVE_ALWAYS | KEEPALIVE_NEVER
-
Defines the possible values for the keep-alive configuration in service and client endpoints.
- ListenerError GenericListenerError | InboundRequestError | OutboundResponseError
-
Defines the possible listener error types
- OutboundRequestError InitializingOutboundRequestError | WritingOutboundRequestHeadersError | WritingOutboundRequestBodyError
-
Defines the client error types that returned while sending outbound request
- OutboundResponseError InitializingOutboundResponseError | WritingOutboundResponseHeadersError | WritingOutboundResponseBodyError | Initiating100ContinueResponseError | Writing100ContinueResponseError
-
Defines the listener error types that returned while sending outbound response
- RedirectCode REDIRECT_MULTIPLE_CHOICES_300 | REDIRECT_MOVED_PERMANENTLY_301 | REDIRECT_FOUND_302 | REDIRECT_SEE_OTHER_303 | REDIRECT_NOT_MODIFIED_304 | REDIRECT_USE_PROXY_305 | REDIRECT_TEMPORARY_REDIRECT_307 | REDIRECT_PERMANENT_REDIRECT_308
-
Defines the HTTP redirect codes as a type.
- RequestMessage Request | string | xml | json | byte | ReadableByteChannel | Entity[] | ()
-
The types of messages that are accepted by HTTP
client
when sending out the outbound request.
- ResiliencyError FailoverAllEndpointsFailedError | FailoverActionFailedError | UpstreamServiceUnavailableError | AllLoadBalanceEndpointsFailedError | AllRetryAttemptsFailed | IdleTimeoutError
-
Defines the resiliency error types that returned from client
- ResponseMessage Response | string | xml | json | byte | ReadableByteChannel | Entity[] | ()
-
The types of messages that are accepted by HTTP
listener
when sending out the outbound response.
- WebSocketError WsConnectionClosureError | WsInvalidHandshakeError | WsPayloadTooBigError | WsProtocolError | WsConnectionError | WsInvalidContinuationFrameError | WsGenericError
-
The union of all the WebSocket related errors