Record: ClientConfiguration
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
The following fields are inherited from the other configuration records in addition to the Client-specific
configs.
Fields
- Fields Included from *CommonClientConfiguration
- httpVersion string
- http1Settings ClientHttp1Settings
- http2Settings ClientHttp2Settings
- timeout decimal
- forwarded string
- followRedirects FollowRedirects | ()
- poolConfig PoolConfiguration | ()
- cache CacheConfig
- compression Compression
- auth CredentialsConfig | BearerTokenConfig | JwtIssuerConfig | OAuth2ClientCredentialsGrantConfig | OAuth2PasswordGrantConfig | OAuth2RefreshTokenGrantConfig | OAuth2JwtBearerGrantConfig | ()
- circuitBreaker CircuitBreakerConfig | ()
- retryConfig RetryConfig | ()
- cookieConfig CookieConfig | ()
- responseLimits ResponseLimitConfigs
- secureSocket ClientSecureSocket?(default ())
The HTTP version understood by the client
Configurations related to HTTP/1.x protocol
Configurations related to HTTP/2 protocol
The maximum time to wait (in seconds) for a response before closing the connection
The choice of setting forwarded/x-forwarded header
Configurations associated with Redirection
Configurations associated with request pooling
HTTP caching related configurations
Specifies the way of handling compression (accept-encoding) header
Configurations related to client authentication
Configurations associated with the behaviour of the Circuit Breaker
Configurations associated with retrying
Configurations associated with cookies
Configurations associated with inbound response size limits
SSL/TLS-related options