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
- LoadBalanceActionError T114
-
Represents an error occurred in an remote function of the Load Balance connector.
- 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:1.0.0
- $anonType$1 ResourceConfig
- $anonType$10 no-transform
- $anonType$100 last-modified
- $anonType$101 location
- $anonType$102 pragma
- $anonType$103 server
- $anonType$104 warning
- $anonType$105 transfer-encoding
- $anonType$106 connection
- $anonType$107 upgrade
- $anonType$108 passed
- $anonType$109 failed
- $anonType$11 max-age
- $anonType$110 null
- $anonType$111 OPEN
- $anonType$112 HALF_OPEN
- $anonType$113 CLOSED
- $anonType$115 100
- $anonType$116 101
- $anonType$117 200
- $anonType$118 201
- $anonType$119 202
- $anonType$12 max-stale
- $anonType$120 203
- $anonType$121 204
- $anonType$122 205
- $anonType$123 206
- $anonType$124 300
- $anonType$125 301
- $anonType$126 302
- $anonType$127 303
- $anonType$128 304
- $anonType$129 305
- $anonType$13 min-fresh
- $anonType$130 307
- $anonType$131 308
- $anonType$132 400
- $anonType$133 401
- $anonType$134 402
- $anonType$135 403
- $anonType$136 404
- $anonType$137 405
- $anonType$138 406
- $anonType$139 407
- $anonType$14 only-if-cached
- $anonType$140 408
- $anonType$141 409
- $anonType$142 410
- $anonType$143 411
- $anonType$144 412
- $anonType$145 413
- $anonType$146 414
- $anonType$147 415
- $anonType$148 416
- $anonType$149 417
- $anonType$15 must-revalidate
- $anonType$150 426
- $anonType$151 500
- $anonType$152 501
- $anonType$153 502
- $anonType$154 503
- $anonType$155 504
- $anonType$156 505
- $anonType$157 AUTO
- $anonType$158 ALWAYS
- $anonType$159 NEVER
- $anonType$16 public
- $anonType$160 SERVICE_NAME
- $anonType$161 RESOURCE_NAME
- $anonType$162 REQUEST_METHOD
- $anonType$17 private
- $anonType$18 proxy-revalidate
- $anonType$19 s-maxage
- $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 120000
- $anonType$54 0
- $anonType$55 10
- $anonType$56 multipart/
- $anonType$57 FORWARD
- $anonType$58 GET
- $anonType$59 POST
- $anonType$6 NO_BEARER
- $anonType$60 DELETE
- $anonType$61 OPTIONS
- $anonType$62 PUT
- $anonType$63 PATCH
- $anonType$64 HEAD
- $anonType$65 SUBMIT
- $anonType$66 NONE
- $anonType$67 AUTO
- $anonType$68 ALWAYS
- $anonType$69 NEVER
- $anonType$7 STATUS_CODE
- $anonType$70 AUTO
- $anonType$71 ALWAYS
- $anonType$72 NEVER
- $anonType$73 http.url
- $anonType$74 http.method
- $anonType$75 http.status_code_group
- $anonType$76 http.base_url
- $anonType$77 xx
- $anonType$78 300
- $anonType$79 301
- $anonType$8 no-cache
- $anonType$80 302
- $anonType$81 303
- $anonType$82 304
- $anonType$83 305
- $anonType$84 307
- $anonType$85 308
- $anonType$86 age
- $anonType$87 authorization
- $anonType$88 cache-control
- $anonType$89 content-length
- $anonType$9 no-store
- $anonType$90 content-type
- $anonType$91 date
- $anonType$92 etag
- $anonType$93 expect
- $anonType$94 expires
- $anonType$95 if-match
- $anonType$96 if-modified-since
- $anonType$97 if-none-match
- $anonType$98 if-range
- $anonType$99 if-unmodified-since