Package jenkins.metrics.api

Class Metrics.HealthCheckData

java.lang.Object

jenkins.metrics.api.Metrics.HealthCheckData

Enclosing class:

Metrics

@ThreadSafe
public static class Metrics.HealthCheckData
extends Object

Health check data.

Constructor Summary

Constructors

Constructor	Description
HealthCheckData(SortedMap<String,com.codahale.metrics.health.HealthCheck.Result> results)	Constructor for when you do not know how long before the next collection.
HealthCheckData(SortedMap<String,com.codahale.metrics.health.HealthCheck.Result> results, long nextMillis)	Constructor for when you know how long before the next collection.

Method Summary

Modifier and Type	Method	Description
Long	getExpires()	The number of milliseconds since 1st January 1970 GMT when the results are expected to be superceded by a newer result.
long	getLastModified()	The number of milliseconds since 1st January 1970 GMT when the results were collected.
SortedMap<String,com.codahale.metrics.health.HealthCheck.Result>	getResults()	The results.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckData

public HealthCheckData(@NonNull
                       SortedMap<String,com.codahale.metrics.health.HealthCheck.Result> results,
                       long nextMillis)

Constructor for when you know how long before the next collection.

Parameters:

results - the current results.

nextMillis - how long until the next results will be available.

HealthCheckData

public HealthCheckData(@NonNull
                       SortedMap<String,com.codahale.metrics.health.HealthCheck.Result> results)

Constructor for when you do not know how long before the next collection.

Parameters:

results - the current results.

Method Detail

getLastModified

public long getLastModified()

The number of milliseconds since 1st January 1970 GMT when the results were collected.

Returns:

The number of milliseconds since 1st January 1970 GMT when the results were collected.

getExpires

@CheckForNull
public Long getExpires()

The number of milliseconds since 1st January 1970 GMT when the results are expected to be superceded by a newer result.

Returns:

The number of milliseconds since 1st January 1970 GMT when the results are expected to be superceded by a newer result or null

getResults

@NonNull
public SortedMap<String,com.codahale.metrics.health.HealthCheck.Result> getResults()

The results.

Returns:

the results.