Package com.inductiveautomation.ignition.gateway.model.entity

Class EntityBuilder.DiagnosticComponentBuilder

java.lang.Object

com.inductiveautomation.ignition.gateway.model.entity.EntityBuilder.DiagnosticComponentBuilder

Enclosing class:

EntityBuilder

public static class EntityBuilder.DiagnosticComponentBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
DiagnosticComponentBuilder(com.codahale.metrics.MetricRegistry metricRegistry, com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry)

Method Summary

Modifier and Type	Method	Description
DiagnosticComponent	build()
EntityBuilder.DiagnosticComponentBuilder	healthcheck(String alias, String id)	Add a registered healthcheck to the diagnostic component.
EntityBuilder.DiagnosticComponentBuilder	healthcheck(String alias, Supplier<com.codahale.metrics.health.HealthCheck.Result> healthcheck)	Add a healthcheck to the diagnostic component.
EntityBuilder.DiagnosticComponentBuilder	metric(String alias, String id)	Add a registered metric to the diagnostic component.
EntityBuilder.DiagnosticComponentBuilder	metric(String alias, Supplier<com.codahale.metrics.Metric> metric)	Add a metric to the diagnostic component.

Methods inherited from class java.lang.Object

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

Constructor Details

DiagnosticComponentBuilder

public DiagnosticComponentBuilder(@Nullable
 com.codahale.metrics.MetricRegistry metricRegistry,
 @Nullable
 com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry)

Method Details

metric

public EntityBuilder.DiagnosticComponentBuilder metric(String alias,
 Supplier<com.codahale.metrics.Metric> metric)

Add a metric to the diagnostic component. The metric supplier will be invoked whenever needed. If this metric is registered with the gateway-wide registry, use metric(String, String) instead.

metric

public EntityBuilder.DiagnosticComponentBuilder metric(String alias,
 String id)

Add a registered metric to the diagnostic component. The metric will be looked up in the gateway-wide registry.

healthcheck

public EntityBuilder.DiagnosticComponentBuilder healthcheck(String alias,
 Supplier<com.codahale.metrics.health.HealthCheck.Result> healthcheck)

Add a healthcheck to the diagnostic component. The healthcheck supplier will be invoked whenever needed. If this healthcheck is registered with the gateway-wide registry, use healthcheck(String, String) instead.

healthcheck

public EntityBuilder.DiagnosticComponentBuilder healthcheck(String alias,
 String id)

Add a registered healthcheck to the diagnostic component. The healthcheck will be looked up in the gateway-wide registry.

build

public DiagnosticComponent build()