public class Debug
extends java.lang.Object
The implementing class for operations on REST endpoints, under the "Debug" section of the Vault HTTP API docs (https://www.vaultproject.io/docs/http/index.html).
This class is not intended to be constructed directly. Rather, it is meant to used by way of
Vault
in a DSL-style builder pattern. See the Javadoc comments of each public
method for usage examples.
Constructor and Description |
---|
Debug(VaultConfig config) |
Modifier and Type | Method and Description |
---|---|
HealthResponse |
health()
Returns the health status of Vault.
|
HealthResponse |
health(java.lang.Boolean standbyOk,
java.lang.Integer activeCode,
java.lang.Integer standbyCode,
java.lang.Integer sealedCode)
An overloaded version of
health() that allows for passing one or more optional parameters. |
public Debug(VaultConfig config)
public HealthResponse health() throws VaultException
Returns the health status of Vault. This matches the semantics of a Consul HTTP health check and provides a simple way to monitor the health of a Vault instance.
VaultException
- If any errors occurs with the REST request (e.g. non-200 status code, invalid JSON payload, etc), and the maximum number of retries is exceeded.{@code final VaultConfig config = new VaultConfig(address, rootToken); final Vault vault = new Vault(config); final HealthResponse response = vault.sys().debug().health(); final Boolean sealed = response.getSealed(); // Warning: CAN be null! }
public HealthResponse health(java.lang.Boolean standbyOk, java.lang.Integer activeCode, java.lang.Integer standbyCode, java.lang.Integer sealedCode) throws VaultException
An overloaded version of health()
that allows for passing one or more optional parameters.
WARNING: In testing, we've found that changing the default HTTP status codes can result in the operation
succeeding, but returning an empty JSON payload in the response. For example, this seems to happen when you
set activeCode
to 204, but not for 212 (the regular default is 200). When this happens, the
HealthResponse
return object will have null
values in most of its fields, and you
will need to check HealthReponse.getRestResponse().getStatus()
to determine the result of
the operation.
standbyOk
- (optional) Indicates that being a standby should still return the active status code instead of the standby codeactiveCode
- (optional) Indicates the status code that should be returned for an active node instead of the default of 200standbyCode
- (optional) Indicates the status code that should be returned for a standby node instead of the default of 429sealedCode
- (optional) Indicates the status code that should be returned for a sealed node instead of the default of 500VaultException
- If an error occurs or unexpected response received from Vault