WebClient.Builder (Spring Framework 5.1.10.RELEASE API)

Enclosing interface:

WebClient
```
public static interface WebClient.Builder
```
A mutable builder for creating a WebClient.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`WebClient.Builder`	`apply(Consumer<WebClient.Builder> builderConsumer)` Apply the given `Consumer` to this builder instance.
`WebClient.Builder`	`baseUrl(String baseUrl)` Configure a base URL for requests performed through the client.
`WebClient`	`build()` Builder the `WebClient` instance.
`WebClient.Builder`	`clientConnector(ClientHttpConnector connector)` Configure the `ClientHttpConnector` to use.
`WebClient.Builder`	`clone()` Clone this `WebClient.Builder`.
`WebClient.Builder`	`defaultCookie(String cookie, String... values)` Global option to specify a cookie to be added to every request, if the request does not already contain such a cookie.
`WebClient.Builder`	`defaultCookies(Consumer<MultiValueMap<String,String>> cookiesConsumer)` Provides access to every `defaultCookie(String, String...)` declared so far with the possibility to add, replace, or remove.
`WebClient.Builder`	`defaultHeader(String header, String... values)` Global option to specify a header to be added to every request, if the request does not already contain such a header.
`WebClient.Builder`	`defaultHeaders(Consumer<HttpHeaders> headersConsumer)` Provides access to every `defaultHeader(String, String...)` declared so far with the possibility to add, replace, or remove.
`WebClient.Builder`	`defaultRequest(Consumer<WebClient.RequestHeadersSpec<?>> defaultRequest)` Provide a consumer to modify every request being built just before the call to `exchange()`.
`WebClient.Builder`	`defaultUriVariables(Map<String,?> defaultUriVariables)` Configure default URI variable values that will be used when expanding URI templates using a `Map`.
`WebClient.Builder`	`exchangeFunction(ExchangeFunction exchangeFunction)` Provide an `ExchangeFunction` pre-configured with `ClientHttpConnector` and `ExchangeStrategies`.
`WebClient.Builder`	`exchangeStrategies(ExchangeStrategies strategies)` Configure the `ExchangeStrategies` to use.
`WebClient.Builder`	`filter(ExchangeFilterFunction filter)` Add the given filter to the filter chain.
`WebClient.Builder`	`filters(Consumer<List<ExchangeFilterFunction>> filtersConsumer)` Manipulate the filters with the given consumer.
`WebClient.Builder`	`uriBuilderFactory(UriBuilderFactory uriBuilderFactory)` Provide a pre-configured `UriBuilderFactory` instance.

- Method Detail
  - baseUrl
```
WebClient.Builder baseUrl(String baseUrl)
```
    Configure a base URL for requests performed through the client.
    For example given base URL "https://abc.go.com/v1":
```
 Mono<Account> result = client.get().uri("/accounts/{id}", 43)
         .retrieve()
         .bodyToMono(Account.class);

 // Result: https://abc.go.com/v1/accounts/43

 Flux<Account> result = client.get()
         .uri(builder -> builder.path("/accounts").queryParam("q", "12").build())
         .retrieve()
         .bodyToFlux(Account.class);

 // Result: https://abc.go.com/v1/accounts?q=12
 
```
    The base URL can be overridden with an absolute URI:
```
 Mono<Account> result = client.get().uri("https://xyz.com/path")
         .retrieve()
         .bodyToMono(Account.class);

 // Result: https://xyz.com/path
 
```
    Or partially overridden with a UriBuilder:
```
 Flux<Account> result = client.get()
         .uri(builder -> builder.replacePath("/v2/accounts").queryParam("q", "12").build())
         .retrieve()
         .bodyToFlux(Account.class);

 // Result: https://abc.go.com/v2/accounts?q=12
 
```
    See Also:
    
    defaultUriVariables(Map), uriBuilderFactory(UriBuilderFactory)
  - defaultUriVariables
```
WebClient.Builder defaultUriVariables(Map<String,?> defaultUriVariables)
```
    Configure default URI variable values that will be used when expanding URI templates using a Map.
    
    Parameters:
    
    defaultUriVariables - the default values to use
    
    See Also:
    
    baseUrl(String), uriBuilderFactory(UriBuilderFactory)
  - uriBuilderFactory
```
WebClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)
```
    Provide a pre-configured UriBuilderFactory instance. This is an alternative to and effectively overrides the following:
    - baseUrl(String)
    - defaultUriVariables(Map).
    Parameters:
    
    uriBuilderFactory - the URI builder factory to use
    
    See Also:
    
    baseUrl(String), defaultUriVariables(Map)
  - defaultHeader
```
WebClient.Builder defaultHeader(String header,
                                String... values)
```
    Global option to specify a header to be added to every request, if the request does not already contain such a header.
    
    Parameters:
    
    header - the header name
    
    values - the header values
  - defaultHeaders
```
WebClient.Builder defaultHeaders(Consumer<HttpHeaders> headersConsumer)
```
    Provides access to every defaultHeader(String, String...) declared so far with the possibility to add, replace, or remove.
    
    Parameters:
    
    headersConsumer - the consumer
  - defaultCookie
```
WebClient.Builder defaultCookie(String cookie,
                                String... values)
```
    Global option to specify a cookie to be added to every request, if the request does not already contain such a cookie.
    
    Parameters:
    
    cookie - the cookie name
    
    values - the cookie values
  - defaultCookies
```
WebClient.Builder defaultCookies(Consumer<MultiValueMap<String,String>> cookiesConsumer)
```
    Provides access to every defaultCookie(String, String...) declared so far with the possibility to add, replace, or remove.
    
    Parameters:
    
    cookiesConsumer - a function that consumes the cookies map
  - defaultRequest
```
WebClient.Builder defaultRequest(Consumer<WebClient.RequestHeadersSpec<?>> defaultRequest)
```
    Provide a consumer to modify every request being built just before the call to exchange().
    
    Parameters:
    
    defaultRequest - the consumer to use for modifying requests
    
    Since:
    
    5.1
  - filter
```
WebClient.Builder filter(ExchangeFilterFunction filter)
```
    Add the given filter to the filter chain.
    
    Parameters:
    
    filter - the filter to be added to the chain
  - filters
```
WebClient.Builder filters(Consumer<List<ExchangeFilterFunction>> filtersConsumer)
```
    Manipulate the filters with the given consumer. The list provided to the consumer is "live", so that the consumer can be used to remove filters, change ordering, etc.
    
    Parameters:
    
    filtersConsumer - a function that consumes the filter list
    
    Returns:
    
    this builder
  - clientConnector
```
WebClient.Builder clientConnector(ClientHttpConnector connector)
```
    Configure the ClientHttpConnector to use. This is useful for plugging in and/or customizing options of the underlying HTTP client library (e.g. SSL).
    By default this is set to ReactorClientHttpConnector.
    
    Parameters:
    
    connector - the connector to use
  - exchangeStrategies
```
WebClient.Builder exchangeStrategies(ExchangeStrategies strategies)
```
    Configure the ExchangeStrategies to use.
    By default this is obtained from ExchangeStrategies.withDefaults().
    
    Parameters:
    
    strategies - the strategies to use
  - exchangeFunction
```
WebClient.Builder exchangeFunction(ExchangeFunction exchangeFunction)
```
    Provide an ExchangeFunction pre-configured with ClientHttpConnector and ExchangeStrategies.
    This is an alternative to, and effectively overrides clientConnector(org.springframework.http.client.reactive.ClientHttpConnector), and exchangeStrategies(org.springframework.web.reactive.function.client.ExchangeStrategies).
    
    Parameters:
    
    exchangeFunction - the exchange function to use
  - apply
```
WebClient.Builder apply(Consumer<WebClient.Builder> builderConsumer)
```
    Apply the given Consumer to this builder instance.
    This can be useful for applying pre-packaged customizations.
    
    Parameters:
    
    builderConsumer - the consumer to apply
  - clone
```
WebClient.Builder clone()
```
    Clone this WebClient.Builder.
  - build
```
WebClient build()
```
    Builder the WebClient instance.

Interface WebClient.Builder

Method Summary

Method Detail

baseUrl

defaultUriVariables

uriBuilderFactory

defaultHeader

defaultHeaders

defaultCookie

defaultCookies

defaultRequest

filter

filters

clientConnector

exchangeStrategies

exchangeFunction

apply

clone

build