com.cerner.beadledom.health.dto

Class HealthDto

java.lang.Object

com.cerner.beadledom.health.dto.HealthDto

public abstract class HealthDto
extends Object

Represents the health of a service.

This can be used to construct health responses for the Basic Availability Check, Primary Health Check, and Diagnostic Health Check.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HealthDto.Builder

Constructor Summary

Constructors

Constructor and Description
HealthDto()

Method Summary

Modifier and Type	Method and Description
static HealthDto.Builder	builder() Creates a new builder for HealthDto.
static HealthDto.Builder	builder(HealthDto healthDto) Creates a new builder for HealthDto with values copied from the existing HealthDto.
static HealthDto.Builder	builder(ServiceMetadata serviceMetadata) Creates a builder for HealthDto initialized with the properties of the given metadata.
abstract Optional<BuildDto>	getBuild()
abstract Optional<List<HealthDependencyDto>>	getDependencies()
abstract Optional<String>	getMessage() Returns a description of the status of the service (e.g.
abstract Optional<ServerDto>	getServer()
abstract Integer	getStatus() Returns the status code representing the health of the service.
abstract HealthDto.Builder	toBuilder() Returns a builder with same property values as this; allowing modification of some values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HealthDto

public HealthDto()

Method Detail

builder

public static HealthDto.Builder builder()

Creates a new builder for HealthDto.

builder

public static HealthDto.Builder builder(HealthDto healthDto)

Creates a new builder for HealthDto with values copied from the existing HealthDto.

builder

public static HealthDto.Builder builder(ServiceMetadata serviceMetadata)

Creates a builder for HealthDto initialized with the properties of the given metadata.

getMessage

public abstract Optional<String> getMessage()

Returns a description of the status of the service (e.g. "example-service is unavailable").

This field may also include further potentially useful details, such as debugging information.

getStatus

@Nullable
public abstract Integer getStatus()

Returns the status code representing the health of the service.

This is not included in the json model since it is used as the HTTP response code.

getDependencies

public abstract Optional<List<HealthDependencyDto>> getDependencies()

getBuild

public abstract Optional<BuildDto> getBuild()

getServer

public abstract Optional<ServerDto> getServer()

toBuilder

public abstract HealthDto.Builder toBuilder()

Returns a builder with same property values as this; allowing modification of some values.