Record Class ConfigResourceBrief
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.config.ai.ConfigResourceBrief
- Record Components:
name- the resource name, unique within its type.description- the resource's user-authored documentation, ornullwhen it has none.enabled- whether the resource is enabled; a disabled resource is still fully configured but is not running.extensionPointType- the subtype identifier for resources of an extension point type, matching anExtensionSubtype.typeId().nullfor types that are not extension points, and also when the subtype could not be determined from the stored configuration.
-
Constructor Summary
ConstructorsConstructorDescriptionConfigResourceBrief(String name, @Nullable String description, boolean enabled, @Nullable String extensionPointType) Creates an instance of aConfigResourceBriefrecord class. -
Method Summary
Modifier and TypeMethodDescription@Nullable StringReturns the value of thedescriptionrecord component.booleanenabled()Returns the value of theenabledrecord component.final booleanIndicates whether some other object is "equal to" this one.@Nullable StringReturns the value of theextensionPointTyperecord component.final inthashCode()Returns a hash code value for this object.name()Returns the value of thenamerecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
ConfigResourceBrief
public ConfigResourceBrief(String name, @Nullable String description, boolean enabled, @Nullable String extensionPointType) Creates an instance of aConfigResourceBriefrecord class.- Parameters:
name- the value for thenamerecord componentdescription- the value for thedescriptionrecord componentenabled- the value for theenabledrecord componentextensionPointType- the value for theextensionPointTyperecord 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. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
name
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
enabled
-
extensionPointType
Returns the value of theextensionPointTyperecord component.- Returns:
- the value of the
extensionPointTyperecord component
-