RestTemplateBuilder (Spring Boot Docs 2.2.1.RELEASE API)

java.lang.ObjectSE
- org.springframework.boot.web.client.RestTemplateBuilder

```
public class RestTemplateBuilder
extends ObjectSE
```
RestTemplate の構成および作成に使用できるビルダー。converters、error handlers、UriTemplateHandlers を登録するための便利なメソッドを提供します。
デフォルトでは、構築された RestTemplate は最適な ClientHttpRequestFactory を使用しようとします。デフォルトのままにする場合は、detectRequestFactory(false) を呼び出します。典型的な自動構成の Spring Boot アプリケーションでは、このビルダーは Bean として使用可能であり、RestTemplate が必要なときにいつでも注入できます。
導入:
1.4.0
作成者:
Stephane Nicoll, Phillip Webb, Andy Wilkinson, Brian Clozel, Dmytro Nosan, Kevin Strijbos, Ilya Lukyanovich

コンストラクター概要
コンストラクター
コンストラクターと説明
RestTemplateBuilder(RestTemplateCustomizer... customizers)
新しい RestTemplateBuilder インスタンスを作成します。

コンストラクター
コンストラクターと説明
`RestTemplateBuilder(RestTemplateCustomizer... customizers)` 新しい `RestTemplateBuilder` インスタンスを作成します。

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`RestTemplateBuilder`	`additionalCustomizers(CollectionSE<? extends RestTemplateCustomizer> customizers)` `RestTemplate` に適用する必要がある `RestTemplateCustomizers` を追加します。
`RestTemplateBuilder`	`additionalCustomizers(RestTemplateCustomizer... customizers)` `RestTemplate` に適用する必要がある `RestTemplateCustomizers` を追加します。
`RestTemplateBuilder`	`additionalInterceptors(org.springframework.http.client.ClientHttpRequestInterceptor... interceptors)` `RestTemplate` で使用する必要がある追加の `ClientHttpRequestInterceptors` を追加します。
`RestTemplateBuilder`	`additionalInterceptors(CollectionSE<? extends org.springframework.http.client.ClientHttpRequestInterceptor> interceptors)` `RestTemplate` で使用する必要がある追加の `ClientHttpRequestInterceptors` を追加します。
`RestTemplateBuilder`	`additionalMessageConverters(CollectionSE<? extends org.springframework.http.converter.HttpMessageConverter<?>> messageConverters)` `RestTemplate` で使用する必要がある追加の `HttpMessageConverters` を追加します。
`RestTemplateBuilder`	`additionalMessageConverters(org.springframework.http.converter.HttpMessageConverter<?>... messageConverters)` `RestTemplate` で使用する必要がある追加の `HttpMessageConverters` を追加します。
`RestTemplateBuilder`	`additionalRequestCustomizers(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)` `ClientHttpRequest` に適用する `RestTemplateRequestCustomizers` を追加します。
`RestTemplateBuilder`	`additionalRequestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)` `ClientHttpRequest` に適用する `RestTemplateRequestCustomizers` を追加します。
`RestTemplateBuilder`	`basicAuthentication(StringSE username, StringSE password)` 事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。
`RestTemplateBuilder`	`basicAuthentication(StringSE username, StringSE password, CharsetSE charset)` 事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。
`org.springframework.web.client.RestTemplate`	`build()` 新しい `RestTemplate` インスタンスをビルドし、このビルダーを使用して構成します。
`<T extends org.springframework.web.client.RestTemplate> T`	`build(ClassSE<T> restTemplateClass)` 指定された型の新しい `RestTemplate` インスタンスをビルドし、このビルダーを使用して構成します。
`org.springframework.http.client.ClientHttpRequestFactory`	`buildRequestFactory()` このビルダーの設定を使用して、新しい `ClientHttpRequestFactory` インスタンスをビルドします。
`<T extends org.springframework.web.client.RestTemplate> T`	`configure(T restTemplate)` このビルダーを使用して、提供された `RestTemplate` インスタンスを構成します。
`RestTemplateBuilder`	`customizers(CollectionSE<? extends RestTemplateCustomizer> customizers)` `RestTemplate` に適用する `RestTemplateCustomizers` を設定します。
`RestTemplateBuilder`	`customizers(RestTemplateCustomizer... customizers)` `RestTemplate` に適用する `RestTemplateCustomizers` を設定します。
`RestTemplateBuilder`	`defaultHeader(StringSE name, StringSE... values)` 発信 `HttpClientRequest` にまだ存在しない場合に設定されるデフォルトヘッダーを追加します。
`RestTemplateBuilder`	`defaultMessageConverters()` `RestTemplate` で使用する `HttpMessageConverters` をデフォルトセットに設定します。
`RestTemplateBuilder`	`detectRequestFactory(boolean detectRequestFactory)` `ClientHttpRequestFactory` をクラスパスに基づいて検出する必要がある場合に設定します。
`RestTemplateBuilder`	`errorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)` `RestTemplate` で使用する `ResponseErrorHandler` を設定します。
`RestTemplateBuilder`	`interceptors(org.springframework.http.client.ClientHttpRequestInterceptor... interceptors)` `RestTemplate` で使用する `ClientHttpRequestInterceptors` を設定します。
`RestTemplateBuilder`	`interceptors(CollectionSE<org.springframework.http.client.ClientHttpRequestInterceptor> interceptors)` `RestTemplate` で使用する `ClientHttpRequestInterceptors` を設定します。
`RestTemplateBuilder`	`messageConverters(CollectionSE<? extends org.springframework.http.converter.HttpMessageConverter<?>> messageConverters)` `RestTemplate` で使用する `HttpMessageConverters` を設定します。
`RestTemplateBuilder`	`messageConverters(org.springframework.http.converter.HttpMessageConverter<?>... messageConverters)` `RestTemplate` で使用する `HttpMessageConverters` を設定します。
`RestTemplateBuilder`	`requestCustomizers(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)` `ClientHttpRequest` に適用する `RestTemplateRequestCustomizers` を設定します。
`RestTemplateBuilder`	`requestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)` `ClientHttpRequest` に適用する `RestTemplateRequestCustomizers` を設定します。
`RestTemplateBuilder`	`requestFactory(ClassSE<? extends org.springframework.http.client.ClientHttpRequestFactory> requestFactory)` `RestTemplate` で使用する `ClientHttpRequestFactory` クラスを設定します。
`RestTemplateBuilder`	`requestFactory(SupplierSE<org.springframework.http.client.ClientHttpRequestFactory> requestFactory)` 新しい `RestTemplate` インスタンスを `build()` するたびに呼び出される `ClientHttpRequestFactory` の `Supplier` を設定します。
`RestTemplateBuilder`	`rootUri(StringSE rootUri)` `'/'` で始まる各リクエストに適用されるルート URL を設定します。
`RestTemplateBuilder`	`setBufferRequestBody(boolean bufferRequestBody)` 下にある `ClientHttpRequestFactory` がリクエスト本文を内部的にバッファリングするかどうかを設定します。
`RestTemplateBuilder`	`setConnectTimeout(DurationSE connectTimeout)` 基になる `ClientHttpRequestFactory` の接続タイムアウトを設定します。
`RestTemplateBuilder`	`setReadTimeout(DurationSE readTimeout)` 基になる `ClientHttpRequestFactory` の読み取りタイムアウトを設定します。
`RestTemplateBuilder`	`uriTemplateHandler(org.springframework.web.util.UriTemplateHandler uriTemplateHandler)` `RestTemplate` で使用する `UriTemplateHandler` を設定します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - RestTemplateBuilder
```
public RestTemplateBuilder(RestTemplateCustomizer... customizers)
```
    新しい RestTemplateBuilder インスタンスを作成します。
    パラメーター:
    customizers - RestTemplate が構築されるときに適用される RestTemplateCustomizers
- メソッドの詳細
  - detectRequestFactory
```
public RestTemplateBuilder detectRequestFactory(boolean detectRequestFactory)
```
    ClientHttpRequestFactory をクラスパスに基づいて検出する必要がある場合に設定します。true の場合のデフォルト。
    パラメーター:
    detectRequestFactory - ClientHttpRequestFactory を検出する必要がある場合
    戻り値:
    新しいビルダーインスタンス
  - rootUri
```
public RestTemplateBuilder rootUri(StringSE rootUri)
```
    '/' で始まる各リクエストに適用するルート URL を設定します。これは UriTemplateHandler を RestTemplate に追加することで機能するため、ルート URL は、RestTemplate メソッドの String バリアントがリクエスト URL の指定に使用される場合にのみ適用されます。詳細については、RootUriTemplateHandler を参照してください。
    パラメーター:
    rootUri - ルート URI または null
    戻り値:
    新しいビルダーインスタンス
  - messageConverters
```
public RestTemplateBuilder messageConverters(org.springframework.http.converter.HttpMessageConverter<?>... messageConverters)
```
    RestTemplate で使用する HttpMessageConverters を設定します。この値を設定すると、以前に構成されたコンバーターが置き換えられ、ビルダーで構成されたコンバーターは RestTemplate のデフォルトのコンバーターを置き換えます。
    パラメーター:
    messageConverters - 設定するコンバーター
    戻り値:
    新しいビルダーインスタンス
    関連事項:
    additionalMessageConverters(HttpMessageConverter...)
  - messageConverters
```
public RestTemplateBuilder messageConverters(CollectionSE<? extends org.springframework.http.converter.HttpMessageConverter<?>> messageConverters)
```
    RestTemplate で使用する HttpMessageConverters を設定します。この値を設定すると、以前に構成されたコンバーターが置き換えられ、ビルダーで構成されたコンバーターは RestTemplate のデフォルトのコンバーターを置き換えます。
    パラメーター:
    messageConverters - 設定するコンバーター
    戻り値:
    新しいビルダーインスタンス
    関連事項:
    additionalMessageConverters(HttpMessageConverter...)
  - additionalMessageConverters
```
public RestTemplateBuilder additionalMessageConverters(org.springframework.http.converter.HttpMessageConverter<?>... messageConverters)
```
    RestTemplate で使用する追加の HttpMessageConverters を追加します。ビルダーで構成されたコンバーターは、RestTemplate のデフォルトのコンバーターを置き換えます。
    パラメーター:
    messageConverters - 追加するコンバーター
    戻り値:
    新しいビルダーインスタンス
    関連事項:
    messageConverters(HttpMessageConverter...)
  - additionalMessageConverters
```
public RestTemplateBuilder additionalMessageConverters(CollectionSE<? extends org.springframework.http.converter.HttpMessageConverter<?>> messageConverters)
```
    RestTemplate で使用する追加の HttpMessageConverters を追加します。ビルダーで構成されたコンバーターは、RestTemplate のデフォルトのコンバーターを置き換えます。
    パラメーター:
    messageConverters - 追加するコンバーター
    戻り値:
    新しいビルダーインスタンス
    関連事項:
    messageConverters(HttpMessageConverter...)
  - defaultMessageConverters
```
public RestTemplateBuilder defaultMessageConverters()
```
    RestTemplate で使用する HttpMessageConverters をデフォルトセットに設定します。このメソッドを呼び出すと、以前に定義されたコンバーターが置き換えられます。
    戻り値:
    新しいビルダーインスタンス
    関連事項:
    messageConverters(HttpMessageConverter...)
  - interceptors
```
public RestTemplateBuilder interceptors(org.springframework.http.client.ClientHttpRequestInterceptor... interceptors)
```
    RestTemplate で使用する ClientHttpRequestInterceptors を設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。
    パラメーター:
    interceptors - 設定するインターセプター
    戻り値:
    新しいビルダーインスタンス
    導入:
    1.4.1
    関連事項:
    additionalInterceptors(ClientHttpRequestInterceptor...)
  - interceptors
```
public RestTemplateBuilder interceptors(CollectionSE<org.springframework.http.client.ClientHttpRequestInterceptor> interceptors)
```
    RestTemplate で使用する ClientHttpRequestInterceptors を設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。
    パラメーター:
    interceptors - 設定するインターセプター
    戻り値:
    新しいビルダーインスタンス
    導入:
    1.4.1
    関連事項:
    additionalInterceptors(ClientHttpRequestInterceptor...)
  - additionalInterceptors
```
public RestTemplateBuilder additionalInterceptors(org.springframework.http.client.ClientHttpRequestInterceptor... interceptors)
```
    RestTemplate で使用する必要がある追加の ClientHttpRequestInterceptors を追加します。
    パラメーター:
    interceptors - 追加するインターセプター
    戻り値:
    新しいビルダーインスタンス
    導入:
    1.4.1
    関連事項:
    interceptors(ClientHttpRequestInterceptor...)
  - additionalInterceptors
```
public RestTemplateBuilder additionalInterceptors(CollectionSE<? extends org.springframework.http.client.ClientHttpRequestInterceptor> interceptors)
```
    RestTemplate で使用する必要がある追加の ClientHttpRequestInterceptors を追加します。
    パラメーター:
    interceptors - 追加するインターセプター
    戻り値:
    新しいビルダーインスタンス
    導入:
    1.4.1
    関連事項:
    interceptors(ClientHttpRequestInterceptor...)
  - requestFactory
```
public RestTemplateBuilder requestFactory(ClassSE<? extends org.springframework.http.client.ClientHttpRequestFactory> requestFactory)
```
    RestTemplate で使用する ClientHttpRequestFactory クラスを設定します。
    パラメーター:
    requestFactory - 使用するリクエストファクトリ
    戻り値:
    新しいビルダーインスタンス
  - requestFactory
```
public RestTemplateBuilder requestFactory(SupplierSE<org.springframework.http.client.ClientHttpRequestFactory> requestFactory)
```
    新しい RestTemplate インスタンスを build() するたびに呼び出される ClientHttpRequestFactory の Supplier を設定します。
    パラメーター:
    requestFactory - リクエストファクトリのサプライヤー
    戻り値:
    新しいビルダーインスタンス
    導入:
    2.0.0
  - uriTemplateHandler
```
public RestTemplateBuilder uriTemplateHandler(org.springframework.web.util.UriTemplateHandler uriTemplateHandler)
```
    RestTemplate で使用する UriTemplateHandler を設定します。
    パラメーター:
    uriTemplateHandler - 使用する URI テンプレートハンドラー
    戻り値:
    新しいビルダーインスタンス
  - errorHandler
```
public RestTemplateBuilder errorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)
```
    RestTemplate で使用する ResponseErrorHandler を設定します。
    パラメーター:
    errorHandler - 使用するエラーハンドラー
    戻り値:
    新しいビルダーインスタンス
  - basicAuthentication
```
public RestTemplateBuilder basicAuthentication(StringSE username,
                                               StringSE password)
```
    事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。
    パラメーター:
    username - ユーザー名
    password - パスワード
    戻り値:
    新しいビルダーインスタンス
    導入:
    2.1.0
    関連事項:
    basicAuthentication(String, String, Charset)
  - basicAuthentication
```
public RestTemplateBuilder basicAuthentication(StringSE username,
                                               StringSE password,
                                               CharsetSE charset)
```
    事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。
    パラメーター:
    username - ユーザー名
    password - パスワード
    charset - 使用する文字セット
    戻り値:
    新しいビルダーインスタンス
    導入:
    2.2.0
  - defaultHeader
```
public RestTemplateBuilder defaultHeader(StringSE name,
                                         StringSE... values)
```
    発信 HttpClientRequest にまだ存在しない場合に設定されるデフォルトヘッダーを追加します。
    パラメーター:
    name - ヘッダーの名前
    values - ヘッダー値
    戻り値:
    新しいビルダーインスタンス
    導入:
    2.2.0
  - setConnectTimeout
```
public RestTemplateBuilder setConnectTimeout(DurationSE connectTimeout)
```
    基になる ClientHttpRequestFactory の接続タイムアウトを設定します。
    パラメーター:
    connectTimeout - 接続タイムアウト
    戻り値:
    新しいビルダーインスタンス。
    導入:
    2.1.0
  - setReadTimeout
```
public RestTemplateBuilder setReadTimeout(DurationSE readTimeout)
```
    基になる ClientHttpRequestFactory の読み取りタイムアウトを設定します。
    パラメーター:
    readTimeout - 読み取りタイムアウト
    戻り値:
    新しいビルダーインスタンス。
    導入:
    2.1.0
  - setBufferRequestBody
```
public RestTemplateBuilder setBufferRequestBody(boolean bufferRequestBody)
```
    下にある ClientHttpRequestFactory がリクエスト本文を内部的にバッファリングするかどうかを設定します。
    パラメーター:
    bufferRequestBody - bufferRequestBody パラメーターの値
    戻り値:
    新しいビルダーインスタンス。
    導入:
    2.2.0
    関連事項:
    SimpleClientHttpRequestFactory.setBufferRequestBody(boolean), HttpComponentsClientHttpRequestFactory.setBufferRequestBody(boolean)
  - customizers
```
public RestTemplateBuilder customizers(RestTemplateCustomizer... customizers)
```
    RestTemplate に適用する RestTemplateCustomizers を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。
    パラメーター:
    customizers - 設定するカスタマイザー
    戻り値:
    新しいビルダーインスタンス
    関連事項:
    additionalCustomizers(RestTemplateCustomizer...)
  - customizers
```
public RestTemplateBuilder customizers(CollectionSE<? extends RestTemplateCustomizer> customizers)
```
    RestTemplate に適用する RestTemplateCustomizers を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。
    パラメーター:
    customizers - 設定するカスタマイザー
    戻り値:
    新しいビルダーインスタンス
    関連事項:
    additionalCustomizers(RestTemplateCustomizer...)
  - additionalCustomizers
```
public RestTemplateBuilder additionalCustomizers(RestTemplateCustomizer... customizers)
```
    RestTemplate に適用する必要がある RestTemplateCustomizers を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。
    パラメーター:
    customizers - 追加するカスタマイザー
    戻り値:
    新しいビルダーインスタンス
    関連事項:
    customizers(RestTemplateCustomizer...)
  - additionalCustomizers
```
public RestTemplateBuilder additionalCustomizers(CollectionSE<? extends RestTemplateCustomizer> customizers)
```
    RestTemplate に適用する必要がある RestTemplateCustomizers を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。
    パラメーター:
    customizers - 追加するカスタマイザー
    戻り値:
    新しいビルダーインスタンス
    関連事項:
    customizers(RestTemplateCustomizer...)
  - requestCustomizers
```
public RestTemplateBuilder requestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)
```
    ClientHttpRequest に適用する RestTemplateRequestCustomizers を設定します。カスタマイザは、追加された順に適用されます。この値を設定すると、以前に構成されたリクエストカスタマイザが置き換えられます。
    パラメーター:
    requestCustomizers - 設定するリクエストカスタマイザ
    戻り値:
    新しいビルダーインスタンス
    導入:
    2.2.0
    関連事項:
    additionalRequestCustomizers(RestTemplateRequestCustomizer...)
  - requestCustomizers
```
public RestTemplateBuilder requestCustomizers(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)
```
    ClientHttpRequest に適用する RestTemplateRequestCustomizers を設定します。カスタマイザは、追加された順に適用されます。この値を設定すると、以前に構成されたリクエストカスタマイザが置き換えられます。
    パラメーター:
    requestCustomizers - 設定するリクエストカスタマイザ
    戻り値:
    新しいビルダーインスタンス
    導入:
    2.2.0
    関連事項:
    additionalRequestCustomizers(RestTemplateRequestCustomizer...)
  - additionalRequestCustomizers
```
public RestTemplateBuilder additionalRequestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)
```
    ClientHttpRequest に適用する RestTemplateRequestCustomizers を追加します。カスタマイザは、追加された順に適用されます。
    パラメーター:
    requestCustomizers - 追加するリクエストカスタマイザ
    戻り値:
    新しいビルダーインスタンス
    導入:
    2.2.0
    関連事項:
    requestCustomizers(RestTemplateRequestCustomizer...)
  - additionalRequestCustomizers
```
public RestTemplateBuilder additionalRequestCustomizers(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)
```
    ClientHttpRequest に適用する RestTemplateRequestCustomizers を追加します。カスタマイザは、追加された順に適用されます。
    パラメーター:
    requestCustomizers - 追加するリクエストカスタマイザ
    戻り値:
    新しいビルダーインスタンス
    導入:
    2.2.0
    関連事項:
    requestCustomizers(Collection)
  - build
```
public org.springframework.web.client.RestTemplate build()
```
    新しい RestTemplate インスタンスをビルドし、このビルダーを使用して構成します。
    戻り値:
    構成された RestTemplate インスタンス。
    関連事項:
    build(Class), configure(RestTemplate)
  - build
```
public <T extends org.springframework.web.client.RestTemplate> T build(ClassSE<T> restTemplateClass)
```
    指定された型の新しい RestTemplate インスタンスをビルドし、このビルダーを使用して構成します。
    型パラメーター:
    T - rest テンプレートの型
    パラメーター:
    restTemplateClass - 作成するテンプレート型
    戻り値:
    構成された RestTemplate インスタンス。
    関連事項:
    build(), configure(RestTemplate)
  - configure
```
public <T extends org.springframework.web.client.RestTemplate> T configure(T restTemplate)
```
    このビルダーを使用して、提供された RestTemplate インスタンスを構成します。
    型パラメーター:
    T - rest テンプレートの型
    パラメーター:
    restTemplate - 設定する RestTemplate
    戻り値:
    Rest テンプレートインスタンス
    関連事項:
    build(), build(Class)
  - buildRequestFactory
```
public org.springframework.http.client.ClientHttpRequestFactory buildRequestFactory()
```
    このビルダーの設定を使用して、新しい ClientHttpRequestFactory インスタンスをビルドします。
    戻り値:
    ClientHttpRequestFactory または null
    導入:
    2.2.0

クラス RestTemplateBuilder

コンストラクター概要

方法の概要

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

RestTemplateBuilder

メソッドの詳細

detectRequestFactory

rootUri

messageConverters

messageConverters

additionalMessageConverters

additionalMessageConverters

defaultMessageConverters

interceptors

interceptors

additionalInterceptors

additionalInterceptors

requestFactory

requestFactory

uriTemplateHandler

errorHandler

basicAuthentication

basicAuthentication

defaultHeader

setConnectTimeout

setReadTimeout

setBufferRequestBody

customizers

customizers

additionalCustomizers

additionalCustomizers

requestCustomizers

requestCustomizers

additionalRequestCustomizers

additionalRequestCustomizers

build

build

configure

buildRequestFactory