インターフェース ClientRequest.Builder

含まれているインターフェース:
ClientRequest
public static interface ClientRequest.Builder
リクエストのビルダーを定義します。
導入:
5.0
作成者:
Brian Clozel, Arjen Poutsma

  • メソッドの詳細

    • method

      ClientRequest.Builder method(HttpMethod method)
      リクエストのメソッドを設定します。
      パラメーター:
      method - 新しい方法
      戻り値:
      このビルダー
      導入:
      5.0.1

    • url

      ClientRequest.Builder url(URISE url)
      リクエストの URL を設定します。
      パラメーター:
      url - 新しい URL
      戻り値:
      このビルダー
      導入:
      5.0.1

    • header

      ClientRequest.Builder header(StringSE headerName, StringSE... headerValues)
      指定された名前に指定されたヘッダー値を追加します。
      パラメーター:
      headerName - ヘッダー名
      headerValues - ヘッダー値
      戻り値:
      このビルダー
      関連事項:

    • headers

      ClientRequest.Builder headers(ConsumerSE<HttpHeaders> headersConsumer)
      指定されたコンシューマーでこのリクエストのヘッダーを操作します。コンシューマーに提供されるヘッダーは「ライブ」であるため、コンシューマーを使用して、既存のヘッダー値を上書きしたり、値を削除したり、他の HttpHeaders メソッドを使用したりできます。
      パラメーター:
      headersConsumer - HttpHeaders を消費する関数
      戻り値:
      このビルダー

    • cookie

      ClientRequest.Builder cookie(StringSE name, StringSE... values)
      指定された名前と値で Cookie を追加します。
      パラメーター:
      name - クッキー名
      values - クッキーの値
      戻り値:
      このビルダー

    • cookies

      ClientRequest.Builder cookies(ConsumerSE<MultiValueMap<StringSE,StringSE>> cookiesConsumer)
      指定されたコンシューマーでこのリクエストの Cookie を操作します。コンシューマーに提供されるマップは「ライブ」であるため、コンシューマーを使用して、既存の Cookie 値を上書きしたり、Cookie を削除しSEたり、その他の MultiValueMap メソッドを使用したりできます。
      パラメーター:
      cookiesConsumer - Cookie マップを使用する関数
      戻り値:
      このビルダー

    • body

      ClientRequest.Builder body(BodyInserter<?, ? super ClientHttpRequest> inserter)
      リクエストの本文を指定された BodyInserter に設定します。
      パラメーター:
      inserter - リクエストに書き込む BodyInserter 
      戻り値:
      このビルダー

    • body

      <S, P extends Publisher<S>> ClientRequest.Builder body(P publisher, ClassSE<S> elementClass)
      リクエストの本文を指定の Publisher に設定して返します。
      型パラメーター:
      S - パブリッシャーに含まれる要素の型
      P - Publisher の型
      パラメーター:
      publisher - リクエストに書き込む Publisher 
      elementClass - パブリッシャーに含まれる要素のクラス
      戻り値:
      構築されたリクエスト

    • body

      <S, P extends Publisher<S>> ClientRequest.Builder body(P publisher, ParameterizedTypeReference<S> typeReference)
      リクエストの本文を指定の Publisher に設定して返します。
      型パラメーター:
      S - パブリッシャーに含まれる要素の型
      P - Publisher の型
      パラメーター:
      publisher - リクエストに書き込む Publisher 
      typeReference - パブリッシャーに含まれる要素を説明する型参照
      戻り値:
      構築されたリクエスト

    • attribute

      ClientRequest.Builder attribute(StringSE name, ObjectSE value)
      指定された名前の属性に指定された値を設定します。
      パラメーター:
      name - 追加する属性の名前
      value - 追加する属性の値
      戻り値:
      このビルダー

    • attributes

      ClientRequest.Builder attributes(ConsumerSE<MapSE<StringSE,ObjectSE>> attributesConsumer)
      指定されたコンシューマーでリクエスト属性を操作します。コンシューマーに提供される属性は「ライブ」であるため、コンシューマーを使用して、属性をインスペクションしたり、属性を削除したり、マップが提供する他のメソッドを使用したりできます。
      パラメーター:
      attributesConsumer - 属性を使用する関数
      戻り値:
      このビルダー

    • httpRequest

      ClientRequest.Builder httpRequest(ConsumerSE<ClientHttpRequest> requestConsumer)
      ClientHttpRequest へのアクセスのコールバック。これにより、基盤となる HTTP ライブラリのネイティブリクエストへのアクセスが提供されます。これは、基盤となるライブラリによって公開される高度なリクエストごとのオプションを設定する場合に役立ちます。
      パラメーター:
      requestConsumer - ClientHttpRequest にアクセスするコンシューマー
      戻り値:
      このビルダー
      導入:
      5.3

    • build

      ClientRequest build()
      リクエストを作成します。