Record Class MessageTriggerConfig
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.designer.scripteditor.workspace.ai.config.MessageTriggerConfig
- Record Components:
thread- whether the handler runs on theMessageTriggerConfig.HandlerThread.SHAREDpool or its ownMessageTriggerConfig.HandlerThread.DEDICATEDthread.permissions- theZoneRoleRequirements that gate callers, ornullto leave access control unchanged — never an empty list, which would deny everyone (seeMessageHandlerKey.hasPermissions(Collection, Collection)).
@NullMarked
public record MessageTriggerConfig(MessageTriggerConfig.HandlerThread thread, @Nullable List<ZoneRoleRequirement> permissions)
extends Record
The trigger configuration of a Gateway message-handler event script: the thread the handler runs
on, and optionally the zone/role permissions that gate who may invoke it.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumWhich thread the handler runs on. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ConfigSchema<MessageTriggerConfig> The authoritative schema and deserialization for message-handler trigger configs. -
Constructor Summary
ConstructorsConstructorDescriptionMessageTriggerConfig(MessageTriggerConfig.HandlerThread thread, @Nullable List<ZoneRoleRequirement> permissions) Creates an instance of aMessageTriggerConfigrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.@Nullable List<ZoneRoleRequirement> Returns the value of thepermissionsrecord component.thread()Returns the value of thethreadrecord component.final StringtoString()Returns a string representation of this record class.
-
Field Details
-
SCHEMA
The authoritative schema and deserialization for message-handler trigger configs.
-
-
Constructor Details
-
MessageTriggerConfig
public MessageTriggerConfig(MessageTriggerConfig.HandlerThread thread, @Nullable List<ZoneRoleRequirement> permissions) Creates an instance of aMessageTriggerConfigrecord class.- Parameters:
thread- the value for thethreadrecord componentpermissions- the value for thepermissionsrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
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. All components in this record class are compared withObjects::equals(Object,Object). -
thread
-
permissions
Returns the value of thepermissionsrecord component.- Returns:
- the value of the
permissionsrecord component
-