Record Class ImportManifest
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.importexport.ImportManifest
- Record Components:
sourcePlatformVersion- the platform version recorded in the source gateway'sexportinfo.json.sourceGatewayName- name of the gateway that created the.gwex.sourceEdition- edition (e.g.standard,edge) of the source gateway.exportTimestamp- when the.gwexwas created.projects- projects present in the.gwex, with conflict markers against existing gateway projects.configResources- config resources grouped by resource type, with conflict markers against the current configuration collections.additionalContent- contributor entries present in the.gwex, marked unavailable if the receiving gateway has no contributor registered for that ID.
public record ImportManifest(String sourcePlatformVersion, String sourceGatewayName, String sourceEdition, Date exportTimestamp, List<ImportManifest.ProjectEntry> projects, List<ImportManifest.ConfigResourceGroup> configResources, List<ImportManifest.ContentEntry> additionalContent)
extends Record
Describes the contents of a parsed
.gwex file as it would apply to the receiving gateway.
Shape mirrors the export inventory so the same UI components can render both. Each leaf carries a
conflict marker — non-null means the item would require user resolution before apply.
Returned by the parse step of an interactive import flow. The receiving gateway parses an
uploaded .gwex, dispatches per-resource-type to ImportExportDelegate.parseImport(List, ResourceReader),
checks each parsed resource and project against current gateway state, and assembles this
manifest.
Every member the gateway always populates is marked Required so the generated schema
lists it, and the @Nullable members are left out of that list. Serialization omits a null
member rather than writing null, so absent-from-required is what a client should
read as "may not be there".
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordA group of config resources sharing aResourceType.static final recordA contributor entry present in the.gwex.static enumProject conflict reasons.static final recordA project present in the.gwex.static enumConfig resource conflict reasons.static final recordA single config resource entry from the archive. -
Constructor Summary
ConstructorsConstructorDescriptionImportManifest(String sourcePlatformVersion, String sourceGatewayName, String sourceEdition, Date exportTimestamp, List<ImportManifest.ProjectEntry> projects, List<ImportManifest.ConfigResourceGroup> configResources, List<ImportManifest.ContentEntry> additionalContent) Creates an instance of aImportManifestrecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of theadditionalContentrecord component.Returns the value of theconfigResourcesrecord component.final booleanIndicates whether some other object is "equal to" this one.Returns the value of theexportTimestamprecord component.final inthashCode()Returns a hash code value for this object.projects()Returns the value of theprojectsrecord component.Returns the value of thesourceEditionrecord component.Returns the value of thesourceGatewayNamerecord component.Returns the value of thesourcePlatformVersionrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
ImportManifest
public ImportManifest(String sourcePlatformVersion, String sourceGatewayName, String sourceEdition, Date exportTimestamp, List<ImportManifest.ProjectEntry> projects, List<ImportManifest.ConfigResourceGroup> configResources, List<ImportManifest.ContentEntry> additionalContent) Creates an instance of aImportManifestrecord class.- Parameters:
sourcePlatformVersion- the value for thesourcePlatformVersionrecord componentsourceGatewayName- the value for thesourceGatewayNamerecord componentsourceEdition- the value for thesourceEditionrecord componentexportTimestamp- the value for theexportTimestamprecord componentprojects- the value for theprojectsrecord componentconfigResources- the value for theconfigResourcesrecord componentadditionalContent- the value for theadditionalContentrecord 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). -
sourcePlatformVersion
Returns the value of thesourcePlatformVersionrecord component.- Returns:
- the value of the
sourcePlatformVersionrecord component
-
sourceGatewayName
Returns the value of thesourceGatewayNamerecord component.- Returns:
- the value of the
sourceGatewayNamerecord component
-
sourceEdition
Returns the value of thesourceEditionrecord component.- Returns:
- the value of the
sourceEditionrecord component
-
exportTimestamp
Returns the value of theexportTimestamprecord component.- Returns:
- the value of the
exportTimestamprecord component
-
projects
-
configResources
Returns the value of theconfigResourcesrecord component.- Returns:
- the value of the
configResourcesrecord component
-
additionalContent
Returns the value of theadditionalContentrecord component.- Returns:
- the value of the
additionalContentrecord component
-