Version 2.2.1

listeners

clients

Caller CircuitBreakerClient Client ClientOAuth2Handler CookieClient FailoverClient HttpCachingClient HttpClient HttpSecureClient ListenerLdapUserStoreBasicAuthHandler ListenerOAuth2Handler LoadBalanceClient RedirectClient RetryClient

functions

authenticateResource createHttpCachingClient createHttpSecureClient invokeEndpoint parseHeader

classes

ClientBasicAuthHandler ClientBearerTokenAuthHandler ClientSelfSignedJwtAuthHandler Cookie CookieStore CsvPersistentCookieHandler Headers HttpCache HttpFuture ListenerFileUserStoreBasicAuthHandler ListenerJwtAuthHandler LoadBalancerRoundRobinRule PushPromise Request RequestCacheControl RequestContext Response ResponseCacheControl StatusAccepted StatusBadGateway StatusBadRequest StatusConflict StatusContinue StatusCreated StatusExpectationFailed StatusForbidden StatusFound StatusGatewayTimeout StatusGone StatusHttpVersionNotSupported StatusInternalServerError StatusLengthRequired StatusMethodNotAllowed StatusMovedPermanently StatusMultipleChoices StatusNoContent StatusNonAuthoritativeInformation StatusNotAcceptable StatusNotFound StatusNotImplemented StatusNotModified StatusOK StatusPartialContent StatusPayloadTooLarge StatusPaymentRequired StatusPermanentRedirect StatusPreconditionFailed StatusProxyAuthenticationRequired StatusRangeNotSatisfiable StatusRequestHeaderFieldsTooLarge StatusRequestTimeout StatusResetContent StatusSeeOther StatusServiceUnavailable StatusSwitchingProtocols StatusTemporaryRedirect StatusTooManyRequests StatusUnauthorized StatusUnsupportedMediaType StatusUpgradeRequired StatusUriTooLong StatusUseProxy

objectTypes

ClientObject LoadBalancerRule PersistentCookieHandler RequestErrorInterceptor RequestInterceptor Service Status

records

Accepted AccessLogConfiguration BadGateway BadRequest BearerTokenConfig Bucket CacheConfig CertKey CircuitBreakerConfig CircuitBreakerInferredConfig CircuitHealth ClientConfiguration ClientHttp1Settings ClientHttp2Settings ClientSecureSocket CommonClientConfiguration CommonResponse CompressionConfig Conflict Continue CookieConfig CookieOptions CorsConfig Created CredentialsConfig Detail ExpectationFailed FailoverClientConfiguration FileUserStoreConfig FileUserStoreConfigWithScopes FollowRedirects Forbidden Found GatewayTimeout Gone HeaderValue HttpCacheConfig HttpCallerInfo HttpHeader HttpPayload HttpResourceConfig HttpServiceConfig HttpVersionNotSupported InferredListenerConfiguration InternalServerError JwtIssuerConfig JwtValidatorConfig JwtValidatorConfigWithScopes LdapUserStoreConfig LdapUserStoreConfigWithScopes LengthRequired Link Links ListenerConfiguration ListenerHttp1Settings ListenerSecureSocket LoadBalanceActionErrorData LoadBalanceClientConfiguration Local MethodNotAllowed MovedPermanently MultipleChoices MutualSslHandshake NoContent NonAuthoritativeInformation NotAcceptable NotFound NotImplemented NotModified OAuth2ClientCredentialsGrantConfig OAuth2IntrospectionConfig OAuth2IntrospectionConfigWithScopes OAuth2JwtBearerGrantConfig OAuth2PasswordGrantConfig OAuth2RefreshTokenGrantConfig Ok PartialContent PayloadTooLarge PaymentRequired PermanentRedirect PoolConfiguration PreconditionFailed ProxyAuthenticationRequired ProxyConfig RangeNotSatisfiable Remote RequestHeaderFieldsTooLarge RequestLimitConfigs RequestTimeout ResetContent ResponseLimitConfigs RetryConfig RollingWindow Scopes SeeOther ServiceUnavailable SwitchingProtocols TargetService TemporaryRedirect TooManyRequests TraceLogAdvancedConfiguration Unauthorized UnsupportedMediaType UpgradeRequired UriTooLong UseProxy

enums

CertValidationType Method Protocol VerifyClient

constants

AGE AUTH_HEADER AUTH_SCHEME_BASIC AUTH_SCHEME_BEARER AUTHORIZATION CACHE_CONTROL CACHE_CONTROL_AND_VALIDATORS CB_CLOSED_STATE CB_HALF_OPEN_STATE CB_OPEN_STATE CHUNKING_ALWAYS CHUNKING_AUTO CHUNKING_NEVER COMPRESSION_ALWAYS COMPRESSION_AUTO COMPRESSION_NEVER CONNECTION CONTENT_LENGTH CONTENT_TYPE DATE ETAG EXPECT EXPIRES FAILED HTTP_DELETE HTTP_FORWARD HTTP_GET HTTP_HEAD HTTP_NONE HTTP_OPTIONS HTTP_PATCH HTTP_POST HTTP_PUT HTTP_SUBMIT IF_MATCH IF_MODIFIED_SINCE IF_NONE_MATCH IF_RANGE IF_UNMODIFIED_SINCE KEEPALIVE_ALWAYS KEEPALIVE_AUTO KEEPALIVE_NEVER LAST_MODIFIED LEADING LOCATION MAX_AGE MAX_STALE MAX_STALE_ANY_AGE MIN_FRESH MULTIPART_AS_PRIMARY_TYPE MUST_REVALIDATE NO_CACHE NO_STORE NO_TRANSFORM NONE ONLY_IF_CACHED PASSED PRAGMA PRIVATE PROXY_AUTHORIZATION PROXY_REVALIDATE PUBLIC REDIRECT_FOUND_302 REDIRECT_MOVED_PERMANENTLY_301 REDIRECT_MULTIPLE_CHOICES_300 REDIRECT_NOT_MODIFIED_304 REDIRECT_PERMANENT_REDIRECT_308 REDIRECT_SEE_OTHER_303 REDIRECT_TEMPORARY_REDIRECT_307 REDIRECT_USE_PROXY_305 REQUEST_METHOD RESOURCE_NAME RFC_7234 S_MAX_AGE SERVER SERVICE_NAME STATUS_ACCEPTED STATUS_BAD_GATEWAY STATUS_BAD_REQUEST STATUS_CONFLICT STATUS_CONTINUE STATUS_CREATED STATUS_EXPECTATION_FAILED STATUS_FORBIDDEN STATUS_FOUND STATUS_GATEWAY_TIMEOUT STATUS_GONE STATUS_HTTP_VERSION_NOT_SUPPORTED STATUS_INTERNAL_SERVER_ERROR STATUS_LENGTH_REQUIRED STATUS_METHOD_NOT_ALLOWED STATUS_MOVED_PERMANENTLY STATUS_MULTIPLE_CHOICES STATUS_NO_CONTENT STATUS_NON_AUTHORITATIVE_INFORMATION STATUS_NOT_ACCEPTABLE STATUS_NOT_FOUND STATUS_NOT_IMPLEMENTED STATUS_NOT_MODIFIED STATUS_OK STATUS_PARTIAL_CONTENT STATUS_PAYLOAD_TOO_LARGE STATUS_PAYMENT_REQUIRED STATUS_PERMANENT_REDIRECT STATUS_PRECONDITION_FAILED STATUS_PROXY_AUTHENTICATION_REQUIRED STATUS_RANGE_NOT_SATISFIABLE STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE STATUS_REQUEST_TIMEOUT STATUS_RESET_CONTENT STATUS_SEE_OTHER STATUS_SERVICE_UNAVAILABLE STATUS_SWITCHING_PROTOCOLS STATUS_TEMPORARY_REDIRECT STATUS_TOO_MANY_REQUESTS STATUS_UNAUTHORIZED STATUS_UNSUPPORTED_MEDIA_TYPE STATUS_UPGRADE_REQUIRED STATUS_URI_TOO_LONG STATUS_USE_PROXY TRAILING TRANSFER_ENCODING UPGRADE WARNING

annotations

Cache CallerInfo Header Payload ResourceConfig ServiceConfig

types

CachingPolicy Chunking CircuitState ClientAuthConfig Compression HeaderPosition HttpOperation HttpVersion KeepAlive ListenerAuthConfig LoadBalanceActionError MutualSslStatus NextService OAuth2GrantConfig PayloadType RedirectCode RequestMessage ResponseMessage StatusCodeResponse TargetType

errors

AllLoadBalanceEndpointsFailedError AllRetryAttemptsFailed ApplicationResponseError CircuitBreakerConfigError ClientAuthError ClientError ClientRequestError CookieHandlingError Error FailoverActionFailedError FailoverAllEndpointsFailedError GenericClientError GenericListenerError HeaderNotFoundError Http2ClientError IdleTimeoutError InboundRequestError InboundResponseError InitializingInboundRequestError InitializingInboundResponseError InitializingOutboundRequestError InitializingOutboundResponseError Initiating100ContinueResponseError InvalidCookieError ListenerAuthError ListenerError MaximumWaitTimeExceededError NoContentError OutboundRequestError OutboundResponseError PayloadBindingError ReadingInboundRequestBodyError ReadingInboundRequestHeadersError ReadingInboundResponseBodyError ReadingInboundResponseHeadersError RemoteServerError ResiliencyError SslError UnsupportedActionError UpstreamServiceUnavailableError Writing100ContinueResponseError WritingOutboundRequestBodyError WritingOutboundRequestHeadersError WritingOutboundResponseBodyError WritingOutboundResponseHeadersError

Ballerina Learn Central

Standard libraryhttprecords

ClientHttp2Settings

Record: ClientHttp2Settings

Provides settings related to HTTP/2 protocol.

Closed record

Fields

http2PriorKnowledge boolean(default false)

Configuration to enable HTTP/2 prior knowledge