インターフェース RestClient.Builder

メソッドの詳細

• baseUrl

  RestClient.Builder baseUrl(StringSE baseUrl)

  リクエストのベース URL を設定します。効果的には次のショートカットです。

   String baseUrl = "https://abc.go.com/v1";
   DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl);
   RestClient client = RestClient.builder().uriBuilderFactory(factory).build();
   

  DefaultUriBuilderFactory は、指定された URL の URL リクエストが絶対である場合を除き、指定されたベース URL を持つすべてのリクエストの URL を準備するために使用されます。その場合、ベース URL は無視されます。

  注意 : このメソッドは uriBuilderFactory(UriBuilderFactory) と相互に排他的です。両方を使用した場合、ここで指定した baseUrl 値は無視されます。

  戻り値:

  このビルダー

  関連事項:

  • DefaultUriBuilderFactory(String)
  • uriBuilderFactory(UriBuilderFactory)

• baseUrl

  RestClient.Builder baseUrl(URISE baseUrl)

  リクエスト用のベース URI を構成します。実質的には次のショートカットになります:

   URI baseUrl = URI.create("https://abc.go.com/v1");
   DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl.toString());
   RestClient client = RestClient.builder().uriBuilderFactory(factory).build();
   

  DefaultUriBuilderFactory は、指定された URL の URL リクエストが絶対である場合を除き、指定されたベース URL を持つすべてのリクエストの URL を準備するために使用されます。その場合、ベース URL は無視されます。

  注意 : このメソッドは uriBuilderFactory(UriBuilderFactory) と相互に排他的です。両方を使用した場合、ここで指定した baseUrl 値は無視されます。

  戻り値:

  このビルダー

  導入:

  6.2

  関連事項:

  • DefaultUriBuilderFactory(String)
  • uriBuilderFactory(UriBuilderFactory)

• defaultUriVariables

  RestClient.Builder defaultUriVariables(MapSE<StringSE,?> defaultUriVariables)

  MapSE で URI テンプレートを展開するときに使用するデフォルトの URL 変数値を設定します。効果的には次のショートカットです。

   Map<String, ?> defaultVars = ...;
   DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory();
   factory.setDefaultVariables(defaultVars);
   RestClient client = RestClient.builder().uriBuilderFactory(factory).build();
   

  注意 : このメソッドは uriBuilderFactory(UriBuilderFactory) と相互に排他的です。両方を使用した場合、ここで指定した defaultUriVariables 値は無視されます。

  戻り値:

  このビルダー

  関連事項:

  • DefaultUriBuilderFactory.setDefaultUriVariables(Map)
  • uriBuilderFactory(UriBuilderFactory)

• uriBuilderFactory

  RestClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)

  事前構成済みの UriBuilderFactory インスタンスを提供します。これは、次のショートカットプロパティの代替であり、効果的にオーバーライドされます。

  • baseUrl(String)
  • defaultUriVariables(Map)。

  パラメーター:

  uriBuilderFactory - 使用する URI ビルダーファクトリ

  戻り値:

  このビルダー

  関連事項:

  • baseUrl(String)
  • defaultUriVariables(Map)

• defaultHeader

  RestClient.Builder defaultHeader(StringSE header, StringSE... values)

  リクエストにまだヘッダーが含まれていない場合、すべてのリクエストに追加するヘッダーを指定するグローバルオプション。

  パラメーター:

  header - ヘッダー名

  values - ヘッダー値

  戻り値:

  このビルダー

• defaultHeaders

  RestClient.Builder defaultHeaders(ConsumerSE<HttpHeaders> headersConsumer)

  これまでに宣言されたすべてのデフォルトヘッダーにアクセスし、追加、置換、削除できるようにコンシューマーを提供します。

  パラメーター:

  headersConsumer - コンシューマー

  戻り値:

  このビルダー

• defaultCookie

  RestClient.Builder defaultCookie(StringSE cookie, StringSE... values)

  リクエストにまだそのような Cookie が含まれていない場合、すべてのリクエストに追加する Cookie を指定するグローバルオプション。

  パラメーター:

  cookie - クッキー名

  values - クッキーの値

  導入:

  6.2

• defaultCookies

  RestClient.Builder defaultCookies(ConsumerSE<MultiValueMap<StringSE,StringSE>> cookiesConsumer)

  これまでに宣言されたすべての defaultCookie(String, String...) へのアクセスを提供し、追加、置換、削除する機能があります。

  パラメーター:

  cookiesConsumer - Cookie マップを使用する関数

  導入:

  6.2

• defaultApiVersion

  RestClient.Builder defaultApiVersion(ObjectSE version)

  明示的に設定されていない場合に、すべてのリクエストに追加する API バージョンを指定するグローバルオプション。

  パラメーター:

  version - 使用するバージョン

  戻り値:

  このビルダー

  導入:

  7.0

• apiVersionInserter

  RestClient.Builder apiVersionInserter(ApiVersionInserter apiVersionInserter)

  RestClient.RequestHeadersSpec.apiVersion(Object) で指定された API バージョンがリクエストに挿入される方法を抽象化するために ApiVersionInserter を構成します。

  パラメーター:

  apiVersionInserter - 使用するインサーター

  導入:

  7.0

• defaultRequest

  RestClient.Builder defaultRequest(ConsumerSE<RestClient.RequestHeadersSpec<?>> defaultRequest)

  構築されるすべてのリクエストをカスタマイズするためのコンシューマーを提供します。

  パラメーター:

  defaultRequest - リクエストを変更するために使用するコンシューマー

  戻り値:

  このビルダー

• defaultStatusHandler

  RestClient.Builder defaultStatusHandler(PredicateSE<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler)

  すべてのレスポンスに適用するデフォルトのステータスハンドラーを登録します。このようなデフォルトのハンドラーは、登録された順序で適用され、特定のレスポンス用に登録された他のハンドラーの後に適用されます。

  パラメーター:

  statusPredicate - レスポンスを一致させる

  errorHandler - 必ずではありませんが、通常は例外をスローするハンドラー

  戻り値:

  このビルダー

• defaultStatusHandler

  RestClient.Builder defaultStatusHandler(ResponseErrorHandler errorHandler)

  すべてのレスポンスに適用するデフォルトのステータスハンドラーを登録します。このようなデフォルトのハンドラーは、登録された順序で適用され、特定のレスポンス用に登録された他のハンドラーの後に適用されます。

  レスポンスにエラーがあると主張する最初のステータスハンドラーが呼び出されます。他のデフォルトを無効にする場合は、すべてのステータスコードに一致する述語を持つ defaultStatusHandler(Predicate, ResponseSpec.ErrorHandler) の使用を検討してください。

  パラメーター:

  errorHandler - 必ずではありませんが、通常は例外をスローするハンドラー

  戻り値:

  このビルダー

• requestInterceptor

  RestClient.Builder requestInterceptor(ClientHttpRequestInterceptor interceptor)

  指定されたリクエストインターセプターをインターセプターチェーンの最後に追加します。

  パラメーター:

  interceptor - チェーンに追加されるインターセプター

  戻り値:

  このビルダー

• requestInterceptors

  RestClient.Builder requestInterceptors(ConsumerSE<ListSE<ClientHttpRequestInterceptor>> interceptorsConsumer)

  指定されたコンシューマーを使用してインターセプタを操作します。コンシューマーに提供されるリストは「ライブ」であるため、コンシューマーはインターセプタの削除、順序の変更などに使用できます。

  パラメーター:

  interceptorsConsumer - インターセプターのリストを使用する関数

  戻り値:

  このビルダー

• bufferContent

  RestClient.Builder bufferContent(BiPredicateSE<URISE, HttpMethod> predicate)

  リクエストとレスポンスのバッファリングを有効にし、送信前にすべてのコンテンツを集約し、レスポンス本文を繰り返し読み取ることができるようにします。

  パラメーター:

  predicate - 指定されたリクエストをバッファリングするかどうかを決定する

  戻り値:

  このビルダー

  導入:

  7.0

• requestInitializer

  RestClient.Builder requestInitializer(ClientHttpRequestInitializer initializer)

  指定されたリクエスト初期化子を初期化子 チェーンの最後に追加します。

  パラメーター:

  initializer - チェーンに追加されるイニシャライザー

  戻り値:

  このビルダー

• requestInitializers

  RestClient.Builder requestInitializers(ConsumerSE<ListSE<ClientHttpRequestInitializer>> initializersConsumer)

  指定されたコンシューマーを使用してイニシャライザーを操作します。コンシューマーに提供されるリストは「ライブ」であるため、コンシューマーはイニシャライザーの削除、順序の変更などに使用できます。

  パラメーター:

  initializersConsumer - 初期化子リストを使用する関数

  戻り値:

  このビルダー

• requestFactory

  RestClient.Builder requestFactory(ClientHttpRequestFactory requestFactory)

  使用する ClientHttpRequestFactory を構成します。これは、基盤となる HTTP クライアントライブラリ (SSL など) のオプションをプラグインしたりカスタマイズしたりする場合に役立ちます。

  リクエストファクトリが指定されていない場合、RestClient は Apache Http クライアント、クラスパスで使用可能な場合は Jetty HTTP クライアントを使用し、java.net.http モジュールがロードされている場合はデフォルトの JDK HttpClient を、それ以外の場合は単純なデフォルトを使用します。

  パラメーター:

  requestFactory - 使用するリクエストファクトリ

  戻り値:

  このビルダー

• messageConverters

  @DeprecatedSE(since="7.0", forRemoval=true) RestClient.Builder messageConverters(ConsumerSE<ListSE<HttpMessageConverter<?>>> configurer)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  7.0 以降、configureMessageConverters(Consumer) を推奨

  RestClient が使用するメッセージコンバーターを構成します。

  パラメーター:

  configurer - デフォルトの HttpMessageConverter のリストに適用するコンフィギュレータは、事前に初期化されています

  戻り値:

  このビルダー

  関連事項:

  • messageConverters(Iterable)

• messageConverters

  RestClient.Builder messageConverters(IterableSE<HttpMessageConverter<?>> messageConverters)

  RestClient が使用するメッセージコンバーターを設定します。

  パラメーター:

  messageConverters - 使用する HttpMessageConverter のリスト

  戻り値:

  このビルダー

  導入:

  6.2

  関連事項:

  • configureMessageConverters(Consumer)

• configureMessageConverters

  RestClient.Builder configureMessageConverters(ConsumerSE<HttpMessageConverters.ClientBuilder> configurer)

  RestClient が使用するメッセージコンバーターを構成します。

  パラメーター:

  configurer - 空の HttpMessageConverters.ClientBuilder に適用するコンフィギュレーター。

  戻り値:

  このビルダー

  導入:

  7.0

• observationRegistry

  RestClient.Builder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

  HTTP クライアント監視の記録に使用するように ObservationRegistry を構成します。

  パラメーター:

  observationRegistry - 使用する観測レジストリ

  戻り値:

  このビルダー

• observationConvention

  RestClient.Builder observationConvention(ClientRequestObservationConvention observationConvention)

  リクエスト監視のメタデータの収集に使用するように ObservationConvention を構成します。何も指定されていない場合は、DefaultClientRequestObservationConvention を使用します。

  パラメーター:

  observationConvention - 使用する観測規則

  戻り値:

  このビルダー

• apply

  RestClient.Builder apply(ConsumerSE<RestClient.Builder> builderConsumer)

  指定された Consumer をこのビルダーインスタンスに適用します。

  これは、事前にパッケージ化されたカスタマイズを適用できます。

  パラメーター:

  builderConsumer - 適用するコンシューマー

  戻り値:

  このビルダー

• clone

  RestClient.Builder clone()

  この RestClient.Builder を複製します。

• build

  RestClient build()

  RestClient インスタンスをビルドします。