Record Class ImportManifest.ResourceItem
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.importexport.ImportManifest.ResourceItem
- Record Components:
name- escaped resource path token below its type (folder segments joined by/, special characters percent-escaped);nullfor singletons.displayName- human-friendly display name, falls back to the resource's own name when no resource type meta is available.collection- the collection the resource lived in inside the archive.collectionAvailable- true ifcollectionexists on the receiving gateway. When false, applying this resource as-is is rejected; it must be remapped to a collection that exists, because an import never creates one.conflict- non-null when the resource would require user resolution before apply.
- Enclosing class:
ImportManifest
public static record ImportManifest.ResourceItem(@Nullable String name, String displayName, String collection, boolean collectionAvailable, @Nullable ImportManifest.ResourceConflict conflict)
extends Record
A single config resource entry from the archive.
-
Constructor Summary
ConstructorsConstructorDescriptionResourceItem(@Nullable String name, String displayName, String collection, boolean collectionAvailable, @Nullable ImportManifest.ResourceConflict conflict) Creates an instance of aResourceItemrecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thecollectionrecord component.booleanReturns the value of thecollectionAvailablerecord component.@Nullable ImportManifest.ResourceConflictconflict()Returns the value of theconflictrecord component.Returns the value of thedisplayNamerecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.@Nullable Stringname()Returns the value of thenamerecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
ResourceItem
public ResourceItem(@Nullable String name, String displayName, String collection, boolean collectionAvailable, @Nullable ImportManifest.ResourceConflict conflict) Creates an instance of aResourceItemrecord class.- Parameters:
name- the value for thenamerecord componentdisplayName- the value for thedisplayNamerecord componentcollection- the value for thecollectionrecord componentcollectionAvailable- the value for thecollectionAvailablerecord componentconflict- the value for theconflictrecord 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
-
displayName
Returns the value of thedisplayNamerecord component.- Returns:
- the value of the
displayNamerecord component
-
collection
Returns the value of thecollectionrecord component.- Returns:
- the value of the
collectionrecord component
-
collectionAvailable
public boolean collectionAvailable()Returns the value of thecollectionAvailablerecord component.- Returns:
- the value of the
collectionAvailablerecord component
-
conflict
-