Package com.inductiveautomation.ignition.gateway.config.migration

Class ExtensionPointRecordMigrationStrategy.Builder

java.lang.Object

com.inductiveautomation.ignition.gateway.config.migration.ExtensionPointRecordMigrationStrategy.Builder

Enclosing class:

ExtensionPointRecordMigrationStrategy

public static class ExtensionPointRecordMigrationStrategy.Builder
extends Object

Builder for ExtensionPointRecordMigrationStrategy

Method Summary

Modifier and Type	Method	Description
ExtensionPointRecordMigrationStrategy	build()
ExtensionPointRecordMigrationStrategy.Builder	descriptionField(SFieldString descriptionField)	Sets the field of the profile record that represents the description of the profile.
ExtensionPointRecordMigrationStrategy.Builder	enabledField(SFieldBoolean enabledField)	Sets the field of the profile record that represents the enabled state of the profile.
ExtensionPointRecordMigrationStrategy.Builder	migratedField(SFieldBoolean migratedField)	Sets the field of the profile record that represents whether the record has been migrated or not.
ExtensionPointRecordMigrationStrategy.Builder	nameField(SFieldString nameField)	The field of the profile record that represents the name of the profile.
ExtensionPointRecordMigrationStrategy.Builder	profileEncoder(Consumer<DefaultRecordEncodingDelegate.Builder> encoderCustomizer)	Allows for customization of the profile record encoder.
ExtensionPointRecordMigrationStrategy.Builder	profileMeta(RecordMeta<?> profileMeta)	Sets the record meta for the profile record.
ExtensionPointRecordMigrationStrategy.Builder	profilePredicate(Predicate<PersistentRecord> predicate)	Sets a predicate that will be used to determine whether a profile record should be migrated or not.
ExtensionPointRecordMigrationStrategy.Builder	resourceMigrationAugmenter(ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter augmenter)
ExtensionPointRecordMigrationStrategy.Builder	resourceType(ResourceType resourceType)	Set the resource type for the extension point.
ExtensionPointRecordMigrationStrategy.Builder	settingsEncoder(Consumer<DefaultRecordEncodingDelegate.Builder> encoderCustomizer)	Allows for customization of the settings record encoder.
ExtensionPointRecordMigrationStrategy.Builder	settingsMeta(RecordMeta<?> settingsMeta)	Sets the record meta for the settings record.
ExtensionPointRecordMigrationStrategy.Builder	settingsRecordForeignKey(SFieldReference<?> settingsRecordForeignKey)	Sets the foreign key field on the settings record that points to the profile record.
ExtensionPointRecordMigrationStrategy.Builder	typeField(SFieldString typeField)	Sets the field of the profile record that represents the type-id of the extension point.
ExtensionPointRecordMigrationStrategy.Builder	withProfileEncoder(RecordEncodingDelegate profileEncoder)	Specifies a custom encoder for the profile record.
ExtensionPointRecordMigrationStrategy.Builder	withSettingsEncoder(RecordEncodingDelegate settingsEncoder)	Specifies a custom encoder for the settings record.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

resourceType

public ExtensionPointRecordMigrationStrategy.Builder resourceType(ResourceType resourceType)

Set the resource type for the extension point. This resource type defines the extension point that this type is an instance of.

This is required.

nameField

public ExtensionPointRecordMigrationStrategy.Builder nameField(SFieldString nameField)

The field of the profile record that represents the name of the profile. This is only required if the name field is not automatically discoverable.

See Also:

• RecordUtils.findNameField(SRecordMeta)

descriptionField

public ExtensionPointRecordMigrationStrategy.Builder descriptionField(SFieldString descriptionField)

Sets the field of the profile record that represents the description of the profile. This is optional. If not set, an attempt will be made to discover the description field automatically.

See Also:

• RecordUtils.findDescriptionField(SRecordMeta)

enabledField

public ExtensionPointRecordMigrationStrategy.Builder enabledField(SFieldBoolean enabledField)

Sets the field of the profile record that represents the enabled state of the profile. This is optional. If not set, an attempt will be made to discover the enabled field automatically.

See Also:

• RecordUtils.findEnabledField(SRecordMeta)

typeField

public ExtensionPointRecordMigrationStrategy.Builder typeField(SFieldString typeField)

Sets the field of the profile record that represents the type-id of the extension point. This is required, but does not need to be set explicitly. If not set explicitly, the builder will attempt to find this field by looking for an SFieldString named "type" on the profile record.

migratedField

public ExtensionPointRecordMigrationStrategy.Builder migratedField(SFieldBoolean migratedField)

Sets the field of the profile record that represents whether the record has been migrated or not. This is required, but does not need to be set explicitly. If not set explicitly, the builder will attempt to find this field by looking for an SFieldBoolean named "migrated" on the profile record.

profileMeta

public ExtensionPointRecordMigrationStrategy.Builder profileMeta(RecordMeta<?> profileMeta)

Sets the record meta for the profile record. This is required.

withProfileEncoder

public ExtensionPointRecordMigrationStrategy.Builder withProfileEncoder(RecordEncodingDelegate profileEncoder)

Specifies a custom encoder for the profile record. This is optional. If not set, a DefaultRecordEncodingDelegate will be created automatically, which can be customized by calling profileEncoder(Consumer). Don't call both methods.

profileEncoder

public ExtensionPointRecordMigrationStrategy.Builder profileEncoder(Consumer<DefaultRecordEncodingDelegate.Builder> encoderCustomizer)

Allows for customization of the profile record encoder. This is optional. If not set, a DefaultRecordEncodingDelegate will be created automatically. Do not call both this method and withProfileEncoder(RecordEncodingDelegate).

settingsRecordForeignKey

public ExtensionPointRecordMigrationStrategy.Builder settingsRecordForeignKey(SFieldReference<?> settingsRecordForeignKey)

Sets the foreign key field on the settings record that points to the profile record. This is optional. If not set, the builder will attempt to find this field by looking for an SFieldReference on the settings record named 'profile' that references the profile record.

settingsMeta

public ExtensionPointRecordMigrationStrategy.Builder settingsMeta(RecordMeta<?> settingsMeta)

Sets the record meta for the settings record. This is optional (some extension point types may not have settings).

withSettingsEncoder

public ExtensionPointRecordMigrationStrategy.Builder withSettingsEncoder(RecordEncodingDelegate settingsEncoder)

Specifies a custom encoder for the settings record. This is optional. If not set, a DefaultRecordEncodingDelegate will be created automatically, which can be customized by calling settingsEncoder(Consumer). Don't call both methods.

settingsEncoder

public ExtensionPointRecordMigrationStrategy.Builder settingsEncoder(Consumer<DefaultRecordEncodingDelegate.Builder> encoderCustomizer)

Allows for customization of the settings record encoder. This is optional. If not set, a DefaultRecordEncodingDelegate will be created automatically. Do not call both this method and withSettingsEncoder(RecordEncodingDelegate).

profilePredicate

public ExtensionPointRecordMigrationStrategy.Builder profilePredicate(Predicate<PersistentRecord> predicate)

Sets a predicate that will be used to determine whether a profile record should be migrated or not. This is optional. If not set, all records of the specified type will be migrated.

resourceMigrationAugmenter

public ExtensionPointRecordMigrationStrategy.Builder resourceMigrationAugmenter(ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter augmenter)

build

public ExtensionPointRecordMigrationStrategy build()