インターフェース VaultClient.RequestHeadersSpec<S extends VaultClient.RequestHeadersSpec<S>>
- 型パラメーター:
S- 仕様型への自己参照
- 既知のすべてのサブインターフェース:
VaultClient.RequestBodySpec、VaultClient.RequestHeadersBodyPathSpec、VaultClient.RequestHeadersPathSpec<S>
- 含まれているインターフェース:
- VaultClient
public static interface VaultClient.RequestHeadersSpec<S extends VaultClient.RequestHeadersSpec<S>>
交換に至るまでのリクエストヘッダーを指定するための契約。
方法の概要
修飾子と型メソッド説明指定された名前に、指定された単一のヘッダー値を追加します。headers(ConsumerSE<HttpHeaders> headersConsumer) これまでに宣言されたすべてのヘッダーへのアクセスを提供し、値を追加、置換、削除できます。headers(HttpHeaders httpHeaders) 指定されたヘッダーを追加または置き換えます。default Sこのリクエストの名前空間を設定します。retrieve()取得ワークフローを入力し、返されたVaultClient.ResponseSpecを使用して、いくつかの組み込みオプションから選択し、レスポンスを抽出します。default Stoken(VaultToken token) このリクエストの認証トークンを設定します。
メソッドの詳細
namespace
このリクエストの名前空間を設定します。- パラメーター:
namespace- 名前空間の値。- 戻り値:
- このビルダー。
token
このリクエストの認証トークンを設定します。- パラメーター:
token- Vault トークン。- 戻り値:
- このビルダー。
header
指定された名前に、指定された単一のヘッダー値を追加します。- パラメーター:
headerName- ヘッダー名。headerValues- ヘッダー値。- 戻り値:
- このビルダー
headers
指定されたヘッダーを追加または置き換えます。- パラメーター:
httpHeaders- 適用するヘッダー。- 戻り値:
- このビルダー。
headers
これまでに宣言されたすべてのヘッダーへのアクセスを提供し、値を追加、置換、削除できます。- パラメーター:
headersConsumer- コンシューマーにアクセスを提供します。- 戻り値:
- このビルダー。
retrieve
取得ワークフローを入力し、返されたVaultClient.ResponseSpecを使用して、いくつかの組み込みオプションから選択し、レスポンスを抽出します。例:ResponseEntity<Person> entity = client.get() .path("/persons/1") .retrieve() .toEntity(Person.class);または体だけに興味がある場合:
Person person = client.get() .path("/persons/1") .retrieve() .body(Person.class);このメソッドは、返されたVaultClient.ResponseSpecのいずれかを呼び出すまで、実際にはリクエストを実行しないことに注意してください。デフォルトでは、4xx および 5xx のレスポンスコードは、それぞれ
HttpClientErrorException原因とHttpServerErrorException原因を持つVaultClientResponseExceptionを返します。エラー処理をカスタマイズするには、onStatusハンドラーを使用してください。- 戻り値:
ResponseSpecは、本文の復号方法を指定するためのものです。