クラス Health
java.lang.ObjectSE
org.springframework.boot.actuate.health.HealthComponent
org.springframework.boot.actuate.health.Health
- 実装されたすべてのインターフェース:
OperationResponseBody
コンポーネントまたはサブシステムの状態に関する情報を伝達します。
HealthComponent
を拡張して、システムに関する追加のコンテキスト詳細を Status
とともに返すことができるようにします。Health
インスタンスは、Health.Builder
の Fluent API を使用して作成できます。HealthIndicator
の一般的な使用箇所は次のとおりです。
try { // do some test to determine state of component return Health.up().withDetail("version", "1.1.2").build(); } catch (Exception ex) { return Health.down(ex).build(); }
- 導入:
- 1.1.0
- 作成者:
- Christian Dupuis, Phillip Webb, Michael Pratt
ネストされたクラスのサマリー
ネストされたクラスメソッドのサマリー
修飾子と型メソッド説明static Health.Builder
down()
Status.DOWN
ステータスで新しいHealth.Builder
インスタンスを作成します。static Health.Builder
down
(ExceptionSE ex) Status.DOWN
ステータスと指定された例外詳細で新しいHealth.Builder
インスタンスを作成します。boolean
ヘルスの詳細を返します。ヘルスのステータスを返します。int
hashCode()
static Health.Builder
Status.OUT_OF_SERVICE
ステータスで新しいHealth.Builder
インスタンスを作成します。static Health.Builder
特定のステータスコードで新しいHealth.Builder
インスタンスを作成します。static Health.Builder
特定のStatus
で新しいHealth.Builder
インスタンスを作成します。toString()
static Health.Builder
unknown()
Status.UNKNOWN
ステータスで新しいHealth.Builder
インスタンスを作成します。static Health.Builder
up()
Status.UP
ステータスで新しいHealth.Builder
インスタンスを作成します。
メソッドの詳細
getStatus
ヘルスのステータスを返します。- 次で指定:
- クラス
HealthComponent
のgetStatus
- 戻り値:
- ステータス (非
null
)
getDetails
ヘルスの詳細を返します。- 戻り値:
- 詳細 (または空のマップ)
equals
hashCode
public int hashCode()toString
unknown
Status.UNKNOWN
ステータスで新しいHealth.Builder
インスタンスを作成します。- 戻り値:
- 新しい
Health.Builder
インスタンス
up
Status.UP
ステータスで新しいHealth.Builder
インスタンスを作成します。- 戻り値:
- 新しい
Health.Builder
インスタンス
down
Status.DOWN
ステータスと指定された例外詳細で新しいHealth.Builder
インスタンスを作成します。- パラメーター:
ex
- 例外- 戻り値:
- 新しい
Health.Builder
インスタンス
down
Status.DOWN
ステータスで新しいHealth.Builder
インスタンスを作成します。- 戻り値:
- 新しい
Health.Builder
インスタンス
outOfService
Status.OUT_OF_SERVICE
ステータスで新しいHealth.Builder
インスタンスを作成します。- 戻り値:
- 新しい
Health.Builder
インスタンス
status
特定のステータスコードで新しいHealth.Builder
インスタンスを作成します。- パラメーター:
statusCode
- ステータスコード- 戻り値:
- 新しい
Health.Builder
インスタンス
status
特定のStatus
で新しいHealth.Builder
インスタンスを作成します。- パラメーター:
status
- ステータス- 戻り値:
- 新しい
Health.Builder
インスタンス