Record Class DesignerResourceMeta
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.designer.model.DesignerResourceMeta
- Record Components:
type- the resource type.title- short human-readable name for use in UI labels and lists.description- multi-sentence description of what this resource type is and how it is used, intended to be consumed by AI agents and tooling to understand the resource's role within a project.workspaceKey- key of the ResourceWorkspace that edits this type, ornullif the type has no dedicated workspace (e.g. singleton resources edited inline).singleton- true if at most one resource of this type may exist per project.
public record DesignerResourceMeta(@NonNull ResourceType type, @NonNull String title, @NonNull String description, @Nullable String workspaceKey, boolean singleton)
extends Record
Describes a project resource type contributed by a designer module.
-
Constructor Summary
ConstructorsConstructorDescriptionDesignerResourceMeta(@NonNull ResourceType type, @NonNull String title, @NonNull String description, @Nullable String workspaceKey, boolean singleton) Creates an instance of aDesignerResourceMetarecord class. -
Method Summary
Modifier and TypeMethodDescription@NonNull StringReturns the value of thedescriptionrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.booleanReturns the value of thesingletonrecord component.@NonNull Stringtitle()Returns the value of thetitlerecord component.final StringtoString()Returns a string representation of this record class.@NonNull ResourceTypetype()Returns the value of thetyperecord component.@Nullable StringReturns the value of theworkspaceKeyrecord component.
-
Constructor Details
-
DesignerResourceMeta
public DesignerResourceMeta(@NonNull ResourceType type, @NonNull String title, @NonNull String description, @Nullable String workspaceKey, boolean singleton) Creates an instance of aDesignerResourceMetarecord class.- Parameters:
type- the value for thetyperecord componenttitle- the value for thetitlerecord componentdescription- the value for thedescriptionrecord componentworkspaceKey- the value for theworkspaceKeyrecord componentsingleton- the value for thesingletonrecord 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. -
type
-
title
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
workspaceKey
Returns the value of theworkspaceKeyrecord component.- Returns:
- the value of the
workspaceKeyrecord component
-
singleton
-