Package com.inductiveautomation.ignition.gateway.config

Class DefaultResourceStatusDelegate.Builder

java.lang.Object

com.inductiveautomation.ignition.gateway.config.DefaultResourceStatusDelegate.Builder

Enclosing class:

DefaultResourceStatusDelegate

public static class DefaultResourceStatusDelegate.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DefaultResourceStatusDelegate	build()
DefaultResourceStatusDelegate.Builder	categoryHealthCheck(String alias, String categoryHealthCheck)	Adds a category health check name.
DefaultResourceStatusDelegate.Builder	categoryMetric(String alias, String categoryMetricName)	Adds a category metric name.
DefaultResourceStatusDelegate.Builder	instanceHealthCheck(String alias, String instanceHealthCheck)	Adds a health check for a resource instance.
DefaultResourceStatusDelegate.Builder	instanceMetric(String alias, String instanceMetric)	Adds a metric for a resource instance.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

categoryMetric

public DefaultResourceStatusDelegate.Builder categoryMetric(String alias,
 String categoryMetricName)

Adds a category metric name. This a metric registered with the shared metric registry that represents a metric for the entire category of resources represented by this type.

May be invoked multiple times to add multiple category metrics.

Parameters:

alias - A short alias to use for the metric

categoryMetricName - The full name of the metric, as registered in the shared metric registry

See Also:

• GatewayContext.getMetricRegistry()

categoryHealthCheck

public DefaultResourceStatusDelegate.Builder categoryHealthCheck(String alias,
 String categoryHealthCheck)

Adds a category health check name. This is a health check registered with the shared health check registry that represents a health check for the entire category of resources represented by this type.

May be invoked multiple times to add multiple category health checks.

Parameters:

alias - A short alias to use for the health check

categoryHealthCheck - The full name of the health check, as registered in the shared health check registry

See Also:

• GatewayContext.getHealthCheckRegistry()

instanceHealthCheck

public DefaultResourceStatusDelegate.Builder instanceHealthCheck(String alias,
 String instanceHealthCheck)

Adds a health check for a resource instance. These are health checks registered with the shared health check registry for each instance of this resource type

May be invoked multiple times to add multiple health checks.

Example:

         builder.instanceHealthCheck(
           "connected",
           "mysubsystem.things.%s.connected"
         );
     

Parameters:

alias - A short alias to use for the health check

instanceHealthCheck - A string pattern to derive the full name of the healthcheck, where %s will be replaced with the resource name. For example, mysubsystem.things.%s

See Also:

• GatewayContext.getHealthCheckRegistry()

instanceMetric

public DefaultResourceStatusDelegate.Builder instanceMetric(String alias,
 String instanceMetric)

Adds a metric for a resource instance. These are metrics registered with the shared metric registry for each instance of this resource type.

May be invoked multiple times to add multiple metrics.

Example:

         builder.instanceMetric(
         "messageThroughput",
         "mysubsystem.things.%s.messageThroughput"
         );
         

Parameters:

alias - A short alias to use for the metric

instanceMetric - A string pattern to derive the full name of the metric, where %s will be replaced with the resource name. For example, mysubsystem.things.%s

See Also:

• GatewayContext.getMetricRegistry()

build

public DefaultResourceStatusDelegate build()