Package com.inductiveautomation.eventstream.config

Record Class HandlerConfig

java.lang.Object

java.lang.Record

com.inductiveautomation.eventstream.config.HandlerConfig

Record Components:

enabled - True, Handler will process events. False, Handler will be ignored when processing events

type - Type of registered Handler

config - Configuration specific to Handler type. If null, typed Handler will create appropriate defaults.

failureStrategy - Failure strategy configuration

public record HandlerConfig(boolean enabled, String type, @Nullable com.inductiveautomation.ignition.common.gson.JsonObject config, HandlerConfig.FailureConfig failureStrategy)
extends Record

Handler configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	HandlerConfig.FailureConfig	Defines how to handle Handler failures
static final record	HandlerConfig.RetryPolicy	Determines how retries are attempted

Constructor Summary

Constructors

Constructor	Description
HandlerConfig(boolean enabled, String type, com.inductiveautomation.ignition.common.gson.JsonObject config, HandlerConfig.FailureConfig failureStrategy)	Creates an instance of a HandlerConfig record class.

Method Summary

Modifier and Type	Method	Description
com.inductiveautomation.ignition.common.gson.JsonObject	config()	Returns the value of the config record component.
boolean	enabled()	Returns the value of the enabled record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
HandlerConfig.FailureConfig	failureStrategy()	Returns the value of the failureStrategy record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

HandlerConfig

public HandlerConfig(boolean enabled,
 String type,
 @Nullable
 com.inductiveautomation.ignition.common.gson.JsonObject config,
 HandlerConfig.FailureConfig failureStrategy)

Creates an instance of a HandlerConfig record class.

Parameters:

enabled - the value for the enabled record component

type - the value for the type record component

config - the value for the config record component

failureStrategy - the value for the failureStrategy record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

enabled

public boolean enabled()

Returns the value of the enabled record component.

Returns:

the value of the enabled record component

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

config

@Nullable
public com.inductiveautomation.ignition.common.gson.JsonObject config()

Returns the value of the config record component.

Returns:

the value of the config record component

failureStrategy

public HandlerConfig.FailureConfig failureStrategy()

Returns the value of the failureStrategy record component.

Returns:

the value of the failureStrategy record component