Index (gCube Health API 1.1.0-SNAPSHOT API)

B

build() - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder.BuildPart
builder(String) - Static method in class org.gcube.common.health.api.response.HealthCheckResponse

data - Variable in class org.gcube.common.health.api.response.HealthCheckResponse: Structured data of the check (values are strings, numbers, booleans or lists of them), absent when there is none.
degraded() - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder: The check is ready but degraded, e.g. a cache not reachable while the service still works: error says why.
DEGRADED - Enum constant in enum class org.gcube.common.health.api.Status: Ready, with reduced performance or a missing part (e.g. a cache not reachable).
description - Variable in class org.gcube.common.health.api.response.HealthCheckResponse: What the check verifies, from HealthCheck.getDescription().
down() - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder
DOWN - Enum constant in enum class org.gcube.common.health.api.Status: Not ready.

error(String) - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder.ErrorPart: Says why the check is degraded or down.
errorMessage - Variable in class org.gcube.common.health.api.response.HealthCheckResponse

fromValue(String) - Static method in enum class org.gcube.common.health.api.Status: Returns the status of a JSON value; the names of the constants (UP) are accepted too.

getData() - Method in class org.gcube.common.health.api.response.HealthCheckResponse: Returns the structured data of the check, e.g. the Contexts a service runs in.
getDescription() - Method in interface org.gcube.common.health.api.HealthCheck: Returns what the check verifies, in one sentence for a reader of the health, e.g.
getDescription() - Method in class org.gcube.common.health.api.response.HealthCheckResponse: Returns what the check verifies.
getErrorMessage() - Method in class org.gcube.common.health.api.response.HealthCheckResponse
getInfo() - Method in class org.gcube.common.health.api.response.HealthCheckResponse
getName() - Method in interface org.gcube.common.health.api.HealthCheck
getName() - Method in class org.gcube.common.health.api.response.HealthCheckResponse
getStatus() - Method in class org.gcube.common.health.api.response.HealthCheckResponse

HealthCheck - Interface in org.gcube.common.health.api
HealthCheckResponse - Class in org.gcube.common.health.api.response
HealthCheckResponse() - Constructor for class org.gcube.common.health.api.response.HealthCheckResponse
HealthCheckResponseBuilder - Class in org.gcube.common.health.api.response
HealthCheckResponseBuilder(String) - Constructor for class org.gcube.common.health.api.response.HealthCheckResponseBuilder
HealthCheckResponseBuilder.BuildPart - Class in org.gcube.common.health.api.response
HealthCheckResponseBuilder.ErrorPart - Class in org.gcube.common.health.api.response
HealthCheckResponseBuilder.SuccessPart - Class in org.gcube.common.health.api.response

info - Variable in class org.gcube.common.health.api.response.HealthCheckResponse
info(String) - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder.SuccessPart
isReady() - Method in enum class org.gcube.common.health.api.Status: Returns whether the status is ready: up or degraded.

name - Variable in class org.gcube.common.health.api.response.HealthCheckResponse
NOT_CALCULATED - Enum constant in enum class org.gcube.common.health.api.Status: Not computed yet.

org.gcube.common.health.api - package org.gcube.common.health.api
org.gcube.common.health.api.response - package org.gcube.common.health.api.response

perContext() - Element in annotation interface org.gcube.common.health.api.ReadinessChecker: Whether the check is run once for each Context the application works in, with the token of that Context, instead of once for the whole application: e.g. whether the configuration the application needs in a Context is there.

ReadinessChecker - Annotation Interface in org.gcube.common.health.api: Marks a HealthCheck of an application: SmartGears finds it, runs it at the start and then every minute, and reports it in the health of the application.

setDescription(String) - Method in class org.gcube.common.health.api.response.HealthCheckResponse: Sets what the check verifies: the runner of the checks copies it from the check.
status - Variable in class org.gcube.common.health.api.response.HealthCheckResponse
Status - Enum Class in org.gcube.common.health.api

up() - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder
UP - Enum constant in enum class org.gcube.common.health.api.Status: Ready.

value() - Method in enum class org.gcube.common.health.api.Status: Returns the value of the status in JSON, in lowerCamelCase as every enumerated value of the Information System.
valueOf(String) - Static method in enum class org.gcube.common.health.api.Status: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.gcube.common.health.api.Status: Returns an array containing the constants of this enum class, in the order they are declared.

withData(String, Object) - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder.BuildPart: Adds an entry to the structured data of the check.