WebClient.Builder (Spring Framework 5.0.15.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 cookieName, String... cookieValues)` Add the given header to all requests that haven't added it.
`WebClient.Builder`	`defaultCookies(Consumer<MultiValueMap<String,String>> cookiesConsumer)` Manipulate the default cookies with the given consumer.
`WebClient.Builder`	`defaultHeader(String headerName, String... headerValues)` Add the given header to all requests that have not added it.
`WebClient.Builder`	`defaultHeaders(Consumer<HttpHeaders> headersConsumer)` Manipulate the default headers with the given consumer.
`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)
         .exchange()
         .then(response -> response.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())
         .exchange()
         .then(response -> response.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")
         .exchange()
         .then(response -> response.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())
         .exchange()
         .then(response -> response.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 headerName,
                                String... headerValues)
```
    Add the given header to all requests that have not added it.
    
    Parameters:
    
    headerName - the header name
    
    headerValues - the header values
  - defaultHeaders
```
WebClient.Builder defaultHeaders(Consumer<HttpHeaders> headersConsumer)
```
    Manipulate the default headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.
    
    Parameters:
    
    headersConsumer - a function that consumes the HttpHeaders
    
    Returns:
    
    this builder
  - defaultCookie
```
WebClient.Builder defaultCookie(String cookieName,
                                String... cookieValues)
```
    Add the given header to all requests that haven't added it.
    
    Parameters:
    
    cookieName - the cookie name
    
    cookieValues - the cookie values
  - defaultCookies
```
WebClient.Builder defaultCookies(Consumer<MultiValueMap<String,String>> cookiesConsumer)
```
    Manipulate the default cookies with the given consumer. The map provided to the consumer is "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other MultiValueMap methods.
    
    Parameters:
    
    cookiesConsumer - a function that consumes the cookies map
    
    Returns:
    
    this builder
  - 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

filter

filters

clientConnector

exchangeStrategies

exchangeFunction

apply

clone

build