ServiceInstanceListSupplierBuilder (Spring Cloud Load Balancer 3.0.0 API)

java.lang.Object
- org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplierBuilder

```
public final class ServiceInstanceListSupplierBuilder
extends Object
```
A Builder for creating a ServiceInstanceListSupplier hierarchy to be used in ReactorLoadBalancer configuration.

Author:

Spencer Gibb, Olga Maciaszek-Sharma

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ServiceInstanceListSupplierBuilder.Creator` Allows creating a `ServiceInstanceListSupplier` instance based on provided `ConfigurableApplicationContext`.
`static interface`	`ServiceInstanceListSupplierBuilder.DelegateCreator` Allows creating a `ServiceInstanceListSupplier` instance based on provided `ConfigurableApplicationContext` and another `ServiceInstanceListSupplier` instance that will be used as a delegate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceInstanceListSupplier`	`build(org.springframework.context.ConfigurableApplicationContext context)` Builds the `ServiceInstanceListSupplier` hierarchy.
`ServiceInstanceListSupplierBuilder`	`withBase(ServiceInstanceListSupplier supplier)` Sets a user-provided `ServiceInstanceListSupplier` as a base `ServiceInstanceListSupplier` in the hierarchy.
`ServiceInstanceListSupplierBuilder`	`withBlockingDiscoveryClient()` Sets a blocking `DiscoveryClient`-based `DiscoveryClientServiceInstanceListSupplier` as a base `ServiceInstanceListSupplier` in the hierarchy.
`ServiceInstanceListSupplierBuilder`	`withBlockingHealthChecks()` Adds a `HealthCheckServiceInstanceListSupplier` that uses user-provided `RestTemplate` instance to the `ServiceInstanceListSupplier` hierarchy.
`ServiceInstanceListSupplierBuilder`	`withBlockingHealthChecks(org.springframework.web.client.RestTemplate restTemplate)` Adds a `HealthCheckServiceInstanceListSupplier` that uses user-provided `RestTemplate` instance to the `ServiceInstanceListSupplier` hierarchy.
`ServiceInstanceListSupplierBuilder`	`withCaching()` If `LoadBalancerCacheManager` is available in the context, wraps created `ServiceInstanceListSupplier` hierarchy with a `CachingServiceInstanceListSupplier` instance to provide a caching mechanism for service instances.
`ServiceInstanceListSupplierBuilder`	`withDiscoveryClient()` Sets a `ReactiveDiscoveryClient`-based `DiscoveryClientServiceInstanceListSupplier` as a base `ServiceInstanceListSupplier` in the hierarchy.
`ServiceInstanceListSupplierBuilder`	`withHealthChecks()` Adds a `HealthCheckServiceInstanceListSupplier` to the `ServiceInstanceListSupplier` hierarchy.
`ServiceInstanceListSupplierBuilder`	`withHealthChecks(org.springframework.web.reactive.function.client.WebClient webClient)` Adds a `HealthCheckServiceInstanceListSupplier` that uses user-provided `WebClient` instance to the `ServiceInstanceListSupplier` hierarchy.
`ServiceInstanceListSupplierBuilder`	`withRequestBasedStickySession()` Adds a `RequestBasedStickySessionServiceInstanceListSupplier` to the `ServiceInstanceListSupplier` hierarchy.
`ServiceInstanceListSupplierBuilder`	`withRetryAwareness()`
`ServiceInstanceListSupplierBuilder`	`withSameInstancePreference()` Adds a `SameInstancePreferenceServiceInstanceListSupplier` to the `ServiceInstanceListSupplier` hierarchy.
`ServiceInstanceListSupplierBuilder`	`withZonePreference()` Adds a `ZonePreferenceServiceInstanceListSupplier` to the `ServiceInstanceListSupplier` hierarchy.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - withBlockingDiscoveryClient
```
public ServiceInstanceListSupplierBuilder withBlockingDiscoveryClient()
```
    Sets a blocking DiscoveryClient-based DiscoveryClientServiceInstanceListSupplier as a base ServiceInstanceListSupplier in the hierarchy.
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withDiscoveryClient
```
public ServiceInstanceListSupplierBuilder withDiscoveryClient()
```
    Sets a ReactiveDiscoveryClient-based DiscoveryClientServiceInstanceListSupplier as a base ServiceInstanceListSupplier in the hierarchy.
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withBase
```
public ServiceInstanceListSupplierBuilder withBase(ServiceInstanceListSupplier supplier)
```
    Sets a user-provided ServiceInstanceListSupplier as a base ServiceInstanceListSupplier in the hierarchy.
    
    Parameters:
    
    supplier - a user-provided ServiceInstanceListSupplier instance
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withHealthChecks
```
public ServiceInstanceListSupplierBuilder withHealthChecks()
```
    Adds a HealthCheckServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withHealthChecks
```
public ServiceInstanceListSupplierBuilder withHealthChecks(org.springframework.web.reactive.function.client.WebClient webClient)
```
    Adds a HealthCheckServiceInstanceListSupplier that uses user-provided WebClient instance to the ServiceInstanceListSupplier hierarchy.
    
    Parameters:
    
    webClient - a user-provided WebClient instance
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withSameInstancePreference
```
public ServiceInstanceListSupplierBuilder withSameInstancePreference()
```
    Adds a SameInstancePreferenceServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withBlockingHealthChecks
```
public ServiceInstanceListSupplierBuilder withBlockingHealthChecks()
```
    Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestTemplate instance to the ServiceInstanceListSupplier hierarchy.
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withBlockingHealthChecks
```
public ServiceInstanceListSupplierBuilder withBlockingHealthChecks(org.springframework.web.client.RestTemplate restTemplate)
```
    Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestTemplate instance to the ServiceInstanceListSupplier hierarchy.
    
    Parameters:
    
    restTemplate - a user-provided RestTemplate instance
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withZonePreference
```
public ServiceInstanceListSupplierBuilder withZonePreference()
```
    Adds a ZonePreferenceServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withRequestBasedStickySession
```
public ServiceInstanceListSupplierBuilder withRequestBasedStickySession()
```
    Adds a RequestBasedStickySessionServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withCaching
```
public ServiceInstanceListSupplierBuilder withCaching()
```
    If LoadBalancerCacheManager is available in the context, wraps created ServiceInstanceListSupplier hierarchy with a CachingServiceInstanceListSupplier instance to provide a caching mechanism for service instances. Uses ObjectProvider to lazily resolve LoadBalancerCacheManager.
    
    Returns:
    
    the ServiceInstanceListSupplierBuilder object
  - withRetryAwareness
```
public ServiceInstanceListSupplierBuilder withRetryAwareness()
```
  - build
```
public ServiceInstanceListSupplier build(org.springframework.context.ConfigurableApplicationContext context)
```
    Builds the ServiceInstanceListSupplier hierarchy.
    
    Parameters:
    
    context - application context
    
    Returns:
    
    a ServiceInstanceListSupplier instance on top of the delegate hierarchy

Class ServiceInstanceListSupplierBuilder

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

withBlockingDiscoveryClient

withDiscoveryClient

withBase

withHealthChecks

withHealthChecks

withSameInstancePreference

withBlockingHealthChecks

withBlockingHealthChecks

withZonePreference

withRequestBasedStickySession

withCaching

withRetryAwareness

build