Class Health.Builder

Constructor Detail

• Builder

  public Builder()

  Create new Builder instance.

• Builder

  public Builder​(Status status)

  Create new Builder instance, setting status to given status.

  Parameters:

  status - the Status to use

• Builder

  public Builder​(Status status,
                 Map<String,​?> details)

  Create new Builder instance, setting status to given status and details to given details.

  Parameters:

  status - the Status to use

  details - the details Map to use

Method Detail

• withException

  public Health.Builder withException​(Throwable ex)

  Record detail for given Exception.

  Parameters:

  ex - the exception

  Returns:

  this Health.Builder instance

• withDetail

  public Health.Builder withDetail​(String key,
                                   Object value)

  Record detail using given key and value.

  Parameters:

  key - the detail key

  value - the detail value

  Returns:

  this Health.Builder instance

• withDetails

  public Health.Builder withDetails​(Map<String,​?> details)

  Record details from the given details map. Keys from the given map replace any existing keys if there are duplicates.

  Parameters:

  details - map of details

  Returns:

  this Health.Builder instance

  Since:

  2.1.0

• unknown

  public Health.Builder unknown()

  Set status to Status.UNKNOWN status.

  Returns:

  this Health.Builder instance

• up

  public Health.Builder up()

  Set status to Status.UP status.

  Returns:

  this Health.Builder instance

• down

  public Health.Builder down​(Throwable ex)

  Set status to Status.DOWN and add details for given Throwable.

  Parameters:

  ex - the exception

  Returns:

  this Health.Builder instance

• down

  public Health.Builder down()

  Set status to Status.DOWN.

  Returns:

  this Health.Builder instance

• outOfService

  public Health.Builder outOfService()

  Set status to Status.OUT_OF_SERVICE.

  Returns:

  this Health.Builder instance

• status

  public Health.Builder status​(String statusCode)

  Set status to given statusCode.

  Parameters:

  statusCode - the status code

  Returns:

  this Health.Builder instance

• status

  public Health.Builder status​(Status status)

  Set status to given Status instance.

  Parameters:

  status - the status

  Returns:

  this Health.Builder instance

• build

  public Health build()

  Create a new Health instance with the previously specified code and details.

  Returns:

  a new Health instance