WebClient.Builder (Spring Framework 5.0.5.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(java.util.function.Consumer<WebClient.Builder> builderConsumer)` Shortcut for pre-packaged customizations to WebTest builder.
`WebClient.Builder`	`baseUrl(java.lang.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(java.lang.String cookieName, java.lang.String... cookieValues)` Add the given header to all requests that haven't added it.
`WebClient.Builder`	`defaultCookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer)` Manipulate the default cookies with the given consumer.
`WebClient.Builder`	`defaultHeader(java.lang.String headerName, java.lang.String... headerValues)` Add the given header to all requests that have not added it.
`WebClient.Builder`	`defaultHeaders(java.util.function.Consumer<HttpHeaders> headersConsumer)` Manipulate the default headers with the given consumer.
`WebClient.Builder`	`defaultUriVariables(java.util.Map<java.lang.String,?> defaultUriVariables)` Configure default URI variable values that will be used when expanding URI templates using a `Map`.
`WebClient.Builder`	`exchangeFunction(ExchangeFunction exchangeFunction)` Provide a pre-configured `ExchangeFunction` instance.
`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(java.util.function.Consumer<java.util.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(java.lang.String baseUrl)
```
    Configure a base URL for requests performed through the client.
    For example given base URL "http://abc.com/v1":
```
 Mono<Account> result = client.get()
         .uri("/accounts/{id}", 43)
         .exchange()
         .then(response -> response.bodyToMono(Account.class));

 // Result: http://abc.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: http://abc.com/v1/accounts?q=12
 
```
    The base URL can be overridden with an absolute URI:
```
 Mono<Account> result = client.get()
         .uri("http://xyz.com/path")
         .exchange()
         .then(response -> response.bodyToMono(Account.class));

 // Result: http://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: http://abc.com/v2/accounts?q=12
 
```
    See Also:
    
    defaultUriVariables(Map), uriBuilderFactory(UriBuilderFactory)
  - defaultUriVariables
```
WebClient.Builder defaultUriVariables(java.util.Map<java.lang.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(java.lang.String headerName,
                                java.lang.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(java.util.function.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(java.lang.String cookieName,
                                java.lang.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(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.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
  - clientConnector
```
WebClient.Builder clientConnector(ClientHttpConnector connector)
```
    Configure the ClientHttpConnector to use.
    By default an instance of ReactorClientHttpConnector is created if this is not set. However a shared instance may be passed instead, e.g. for use with multiple WebClient's targeting different base URIs.
    
    Parameters:
    
    connector - the connector to use
    
    See Also:
    
    exchangeStrategies(ExchangeStrategies), exchangeFunction(ExchangeFunction)
  - 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(java.util.function.Consumer<java.util.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
  - exchangeStrategies
```
WebClient.Builder exchangeStrategies(ExchangeStrategies strategies)
```
    Configure the ExchangeStrategies to use.
    By default ExchangeStrategies.withDefaults() is used.
    
    Parameters:
    
    strategies - the strategies to use
    
    See Also:
    
    clientConnector(ClientHttpConnector), exchangeFunction(ExchangeFunction)
  - exchangeFunction
```
WebClient.Builder exchangeFunction(ExchangeFunction exchangeFunction)
```
    Provide a pre-configured ExchangeFunction instance. This is an alternative to and effectively overrides the following:
    - clientConnector(ClientHttpConnector)
    - exchangeStrategies(ExchangeStrategies).
    Parameters:
    
    exchangeFunction - the exchange function to use
    
    See Also:
    
    clientConnector(ClientHttpConnector), exchangeStrategies(ExchangeStrategies)
  - clone
```
WebClient.Builder clone()
```
    Clone this WebClient.Builder
  - apply
```
WebClient.Builder apply(java.util.function.Consumer<WebClient.Builder> builderConsumer)
```
    Shortcut for pre-packaged customizations to WebTest builder.
    
    Parameters:
    
    builderConsumer - the consumer to apply
  - build
```
WebClient build()
```
    Builder the WebClient instance.

Interface WebClient.Builder

Method Summary

Method Detail

baseUrl

defaultUriVariables

uriBuilderFactory

defaultHeader

defaultHeaders

defaultCookie

defaultCookies

clientConnector

filter

filters

exchangeStrategies

exchangeFunction

clone

apply

build