Represents the difference between one portable config item in a source snapshot and the same item in a destination snapshot. Either side may be null: a null source item means the item exists only in the destination (it was created), and a null destination item means it exists only in the source (it was deleted); when both are present the item existed in both snapshots and its properties may differ. Produced when diffing two AccountConfigSnapshot instances via AccountManager.diffConfigSnapshots, and consumed when reviewing, ignoring or applying a configuration deployment.
Group: Account Settings
Properties
| Property | Returns | Description |
|---|---|---|
| changedProps | List<ChangedProperty> | Computes the list of properties whose value differs between the source and destination item, comparing every property name present on either side. |
| changedPropsMap | Map<String,ChangedProperty> | The changed properties returned by getChangedProps, indexed by property name for lookup. |
| changeNotes | String | Free text notes explaining how this change was actioned, if any were recorded via withOwner. |
| changeOwner | String | Name of the user who has actioned this change, if it has been assigned an owner via withOwner. |
| created | boolean | Whether this delta represents a config item that did not exist in the source snapshot but has been added in the destination snapshot. |
| deleted | boolean | Whether this delta represents a config item that existed in the source snapshot but has been removed from the destination snapshot. |
| destItem | ConfigItem | The config item as it exists in the destination snapshot. |
| destProps | Map<String,? extends Serializable> | Properties of the config item as it exists in the destination snapshot. |
| portableId | String | Portable id of the config item this delta describes, taken from the destination item if present or otherwise the source item. |
| sourceItem | ConfigItem | The config item as it exists in the source snapshot. |
| sourceProps | Map<String,? extends Serializable> | Properties of the config item as it exists in the source snapshot. |
| updated | boolean | Whether this delta represents a config item that existed in both snapshots, so is neither newly created nor deleted. |
Methods
withOwner(String owner, String notes) · getPortableId() · getDestItem() · getSourceItem() · getChangeOwner() · getChangeNotes() · getSourceProps() · getDestProps() · getChangedProps() · isDeleted() · isCreated() · isUpdated() · getChangedPropsMap()
withOwner(String owner, String notes)
Returns: ConfigDelta
Returns a copy of this delta with the given owner name and notes attached, for recording who decided how to action this change during a deployment review and why. Does not modify this instance.
| Parameter | Description |
|---|---|
owner | name of the user actioning this change |
notes | free text notes explaining the decision |
getPortableId()
Returns: String
Portable id of the config item this delta describes, taken from the destination item if present or otherwise the source item.
getDestItem()
Returns: ConfigItem
The config item as it exists in the destination snapshot.
getSourceItem()
Returns: ConfigItem
The config item as it exists in the source snapshot.
getChangeOwner()
Returns: String
Name of the user who has actioned this change, if it has been assigned an owner via withOwner.
getChangeNotes()
Returns: String
Free text notes explaining how this change was actioned, if any were recorded via withOwner.
getSourceProps()
Returns: Map<String,? extends Serializable>
Properties of the config item as it exists in the source snapshot.
getDestProps()
Returns: Map<String,? extends Serializable>
Properties of the config item as it exists in the destination snapshot.
getChangedProps()
Returns: List<ChangedProperty>
Computes the list of properties whose value differs between the source and destination item, comparing every property name present on either side.
isDeleted()
Returns: boolean
Whether this delta represents a config item that existed in the source snapshot but has been removed from the destination snapshot.
isCreated()
Returns: boolean
Whether this delta represents a config item that did not exist in the source snapshot but has been added in the destination snapshot.
isUpdated()
Returns: boolean
Whether this delta represents a config item that existed in both snapshots, so is neither newly created nor deleted.
getChangedPropsMap()
Returns: Map<String,ChangedProperty>
The changed properties returned by getChangedProps, indexed by property name for lookup.