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 | CookieHandlingError
- 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
- InboundAuthHandlers InboundAuthHandler[] | InboundAuthHandler[][]
- Represents inbound auth handler patterns.
- 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 | InvalidCookieError
- 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.
- Scopes string[] | string[][]
- Represents scopes patterns.
- WebSocketError WsConnectionClosureError | WsInvalidHandshakeError | WsPayloadTooBigError | WsProtocolError | WsConnectionError | WsInvalidContinuationFrameError | WsGenericError
- The union of all the WebSocket related errors
- $anonType$0 ballerina/http
- $anonType$1 ResourceConfig
- $anonType$10 no-transform
- $anonType$100 {ballerina/http}WritingOutboundResponseHeadersFailed
- $anonType$101 {ballerina/http}WritingOutboundResponseBodyFailed
- $anonType$102 {ballerina/http}Initializing100ContinueResponseFailed
- $anonType$103 {ballerina/http}Writing100ContinueResponseFailed
- $anonType$104 {ballerina/http}InvalidCookieError
- $anonType$105 {ballerina/http}GenericClientError
- $anonType$106 {ballerina/http}GenericListenerError
- $anonType$107 {ballerina/http}UnsupportedAction
- $anonType$108 {ballerina/http}Http2ClientError
- $anonType$109 {ballerina/http}MaximumWaitTimeExceeded
- $anonType$11 max-age
- $anonType$110 {ballerina/http}SslError
- $anonType$111 {ballerina/http}CookieHandlingError
- $anonType$112 age
- $anonType$113 authorization
- $anonType$114 cache-control
- $anonType$115 content-length
- $anonType$116 content-type
- $anonType$117 date
- $anonType$118 etag
- $anonType$119 expect
- $anonType$12 max-stale
- $anonType$120 expires
- $anonType$121 if-match
- $anonType$122 if-modified-since
- $anonType$123 if-none-match
- $anonType$124 if-range
- $anonType$125 if-unmodified-since
- $anonType$126 last-modified
- $anonType$127 location
- $anonType$128 pragma
- $anonType$129 server
- $anonType$13 min-fresh
- $anonType$130 warning
- $anonType$131 transfer-encoding
- $anonType$132 connection
- $anonType$133 upgrade
- $anonType$134 passed
- $anonType$135 failed
- $anonType$136 null
- $anonType$137 OPEN
- $anonType$138 HALF_OPEN
- $anonType$139 CLOSED
- $anonType$14 only-if-cached
- $anonType$140 100
- $anonType$141 101
- $anonType$142 200
- $anonType$143 201
- $anonType$144 202
- $anonType$145 203
- $anonType$146 204
- $anonType$147 205
- $anonType$148 206
- $anonType$149 300
- $anonType$15 must-revalidate
- $anonType$150 301
- $anonType$151 302
- $anonType$152 303
- $anonType$153 304
- $anonType$154 305
- $anonType$155 307
- $anonType$156 308
- $anonType$157 400
- $anonType$158 401
- $anonType$159 402
- $anonType$16 public
- $anonType$160 403
- $anonType$161 404
- $anonType$162 405
- $anonType$163 406
- $anonType$164 407
- $anonType$165 408
- $anonType$166 409
- $anonType$167 410
- $anonType$168 411
- $anonType$169 412
- $anonType$17 private
- $anonType$170 413
- $anonType$171 414
- $anonType$172 415
- $anonType$173 416
- $anonType$174 417
- $anonType$175 426
- $anonType$176 500
- $anonType$177 501
- $anonType$178 502
- $anonType$179 503
- $anonType$18 proxy-revalidate
- $anonType$180 504
- $anonType$181 505
- $anonType$182 AUTO
- $anonType$183 ALWAYS
- $anonType$184 NEVER
- $anonType$185 SERVICE_NAME
- $anonType$186 RESOURCE_NAME
- $anonType$187 REQUEST_METHOD
- $anonType$188 {ballerina/http}WsConnectionClosureError
- $anonType$189 {ballerina/http}WsInvalidHandshakeError
- $anonType$19 s-maxage
- $anonType$190 {ballerina/http}WsPayloadTooBigError
- $anonType$191 {ballerina/http}WsProtocolError
- $anonType$192 {ballerina/http}WsConnectionError
- $anonType$193 {ballerina/http}WsInvalidContinuationFrameError
- $anonType$194 {ballerina/http}WsGenericError
- $anonType$2 ServiceConfig
- $anonType$20 9223372036854775807
- $anonType$21 W/
- $anonType$22 0
- $anonType$23 FORWARD
- $anonType$24 GET
- $anonType$25 POST
- $anonType$26 DELETE
- $anonType$27 OPTIONS
- $anonType$28 PUT
- $anonType$29 PATCH
- $anonType$3 Authorization
- $anonType$30 HEAD
- $anonType$31 CACHE_CONTROL_AND_VALIDATORS
- $anonType$32 RFC_7234
- $anonType$33 Domain
- $anonType$34 Path
- $anonType$35 Expires
- $anonType$36 Max-Age
- $anonType$37 HttpOnly
- $anonType$38 Secure
- $anonType$39 =
- $anonType$4 AUTH_HEADER_BEARER
- $anonType$40
- $anonType$41 ;
- $anonType$42 http
- $anonType$43 https
- $anonType$44 https://www.
- $anonType$45 http://www.
- $anonType$46 http://
- $anonType$47 https://
- $anonType$48 1.0
- $anonType$49 1.1
- $anonType$5 POST_BODY_BEARER
- $anonType$50 2.0
- $anonType$51 http://
- $anonType$52 https://
- $anonType$53 {ballerina/http}HTTPError
- $anonType$54 120000
- $anonType$55 0
- $anonType$56 10
- $anonType$57 multipart/
- $anonType$58 FORWARD
- $anonType$59 GET
- $anonType$6 NO_BEARER
- $anonType$60 POST
- $anonType$61 DELETE
- $anonType$62 OPTIONS
- $anonType$63 PUT
- $anonType$64 PATCH
- $anonType$65 HEAD
- $anonType$66 SUBMIT
- $anonType$67 NONE
- $anonType$68 AUTO
- $anonType$69 ALWAYS
- $anonType$7 STATUS_CODE
- $anonType$70 NEVER
- $anonType$71 AUTO
- $anonType$72 ALWAYS
- $anonType$73 NEVER
- $anonType$74 300
- $anonType$75 301
- $anonType$76 302
- $anonType$77 303
- $anonType$78 304
- $anonType$79 305
- $anonType$8 no-cache
- $anonType$80 307
- $anonType$81 308
- $anonType$82 {ballerina/http}FailoverAllEndpointsFailed
- $anonType$83 {ballerina/http}FailoverEndpointActionFailed
- $anonType$84 {ballerina/http}UpstreamServiceUnavailable
- $anonType$85 {ballerina/http}AllLoadBalanceEndpointsFailed
- $anonType$86 {ballerina/http}AllRetryAttemptsFailed
- $anonType$87 {ballerina/http}IdleTimeoutError
- $anonType$88 {ballerina/http}AuthenticationFailed
- $anonType$89 {ballerina/http}AuthorizationFailed
- $anonType$9 no-store
- $anonType$90 {ballerina/http}InitializingOutboundRequestFailed
- $anonType$91 {ballerina/http}WritingOutboundRequestHeadersFailed
- $anonType$92 {ballerina/http}WritingOutboundRequestBodyFailed
- $anonType$93 {ballerina/http}InitializingInboundResponseFailed
- $anonType$94 {ballerina/http}ReadingInboundResponseHeadersFailed
- $anonType$95 {ballerina/http}ReadingInboundResponseBodyFailed
- $anonType$96 {ballerina/http}InitializingInboundRequestFailed
- $anonType$97 {ballerina/http}ReadingInboundRequestHeadersFailed
- $anonType$98 {ballerina/http}ReadingInboundRequestBodyFailed
- $anonType$99 {ballerina/http}InitializingOutboundResponseFailed