Class LoadBalancerProperties
- java.lang.Object
-
- org.springframework.cloud.client.loadbalancer.LoadBalancerProperties
-
- Direct Known Subclasses:
LoadBalancerClientsProperties
public class LoadBalancerProperties extends Object
The base configuration bean for Spring Cloud LoadBalancer. SeeLoadBalancerClientsProperties
for theConfigurationProperties
annotation.- Since:
- 2.2.1
- Author:
- Olga Maciaszek-Sharma, Gandhimathi Velusamy
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LoadBalancerProperties.HealthCheck
static class
LoadBalancerProperties.Retry
static class
LoadBalancerProperties.StickySession
static class
LoadBalancerProperties.XForwarded
-
Constructor Summary
Constructors Constructor Description LoadBalancerProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LoadBalancerProperties.HealthCheck
getHealthCheck()
Map<String,String>
getHint()
String
getHintHeaderName()
LoadBalancerProperties.Retry
getRetry()
LoadBalancerProperties.StickySession
getStickySession()
LoadBalancerProperties.XForwarded
getXForwarded()
boolean
isCallGetWithRequestOnDelegates()
If this flag is set totrue
,ServiceInstanceListSupplier#get(Request request)
method will be implemented to calldelegate.get(request)
in classes assignable fromDelegatingServiceInstanceListSupplier
that don't already implement that method, with the exclusion ofCachingServiceInstanceListSupplier
andHealthCheckServiceInstanceListSupplier
, which should be placed in the instance supplier hierarchy directly after the supplier performing instance retrieval over the network, before any request-based filtering is done.boolean
isUseRawStatusCodeInResponseData()
void
setCallGetWithRequestOnDelegates(boolean callGetWithRequestOnDelegates)
If this flag is set totrue
,ServiceInstanceListSupplier#get(Request request)
method will be implemented to calldelegate.get(request)
in classes assignable fromDelegatingServiceInstanceListSupplier
that don't already implement that method, with the exclusion ofCachingServiceInstanceListSupplier
andHealthCheckServiceInstanceListSupplier
, which should be placed in the instance supplier hierarchy directly after the supplier performing instance retrieval over the network, before any request-based filtering is done.void
setHealthCheck(LoadBalancerProperties.HealthCheck healthCheck)
void
setHint(Map<String,String> hint)
void
setHintHeaderName(String hintHeaderName)
void
setRetry(LoadBalancerProperties.Retry retry)
void
setStickySession(LoadBalancerProperties.StickySession stickySession)
void
setUseRawStatusCodeInResponseData(boolean useRawStatusCodeInResponseData)
void
setxForwarded(LoadBalancerProperties.XForwarded xForwarded)
-
-
-
Method Detail
-
getHealthCheck
public LoadBalancerProperties.HealthCheck getHealthCheck()
-
setHealthCheck
public void setHealthCheck(LoadBalancerProperties.HealthCheck healthCheck)
-
getRetry
public LoadBalancerProperties.Retry getRetry()
-
setRetry
public void setRetry(LoadBalancerProperties.Retry retry)
-
getStickySession
public LoadBalancerProperties.StickySession getStickySession()
-
setStickySession
public void setStickySession(LoadBalancerProperties.StickySession stickySession)
-
getHintHeaderName
public String getHintHeaderName()
-
setHintHeaderName
public void setHintHeaderName(String hintHeaderName)
-
setxForwarded
public void setxForwarded(LoadBalancerProperties.XForwarded xForwarded)
-
getXForwarded
public LoadBalancerProperties.XForwarded getXForwarded()
-
isUseRawStatusCodeInResponseData
public boolean isUseRawStatusCodeInResponseData()
-
setUseRawStatusCodeInResponseData
public void setUseRawStatusCodeInResponseData(boolean useRawStatusCodeInResponseData)
-
isCallGetWithRequestOnDelegates
public boolean isCallGetWithRequestOnDelegates()
If this flag is set totrue
,ServiceInstanceListSupplier#get(Request request)
method will be implemented to calldelegate.get(request)
in classes assignable fromDelegatingServiceInstanceListSupplier
that don't already implement that method, with the exclusion ofCachingServiceInstanceListSupplier
andHealthCheckServiceInstanceListSupplier
, which should be placed in the instance supplier hierarchy directly after the supplier performing instance retrieval over the network, before any request-based filtering is done. Note: in 4.1, this behaviour will become the default
-
setCallGetWithRequestOnDelegates
public void setCallGetWithRequestOnDelegates(boolean callGetWithRequestOnDelegates)
If this flag is set totrue
,ServiceInstanceListSupplier#get(Request request)
method will be implemented to calldelegate.get(request)
in classes assignable fromDelegatingServiceInstanceListSupplier
that don't already implement that method, with the exclusion ofCachingServiceInstanceListSupplier
andHealthCheckServiceInstanceListSupplier
, which should be placed in the instance supplier hierarchy directly after the supplier performing instance retrieval over the network, before any request-based filtering is done. Note: in 4.1, this behaviour will become the default
-
-