Package com.inductiveautomation.ignition.gateway.resourcecollection

Record Class PartialPushResult

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.resourcecollection.PartialPushResult

Record Components:

successfulChanges - The changes that were successfully applied.

failedChanges - The changes that failed to apply, along with the error message.

notificationFuture - A future that will be completed when the notification has been sent to all listeners.

public record PartialPushResult(List<ChangeOperation> successfulChanges, List<PartialPushResult.FailedChangeOperation> failedChanges, CompletableFuture<Void> notificationFuture)
extends Record

Result of a call to ResourceCollectionManager.pushPartial(PushOperation). Contains the changes that were successfully applied, the changes that failed to apply, and a future that will be completed when the notification has been sent to all listeners.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PartialPushResult.FailedChangeOperation

Constructor Summary

Constructors

Constructor	Description
PartialPushResult(List<ChangeOperation> successfulChanges, List<PartialPushResult.FailedChangeOperation> failedChanges, CompletableFuture<Void> notificationFuture)	Creates an instance of a PartialPushResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<PartialPushResult.FailedChangeOperation>	failedChanges()	Returns the value of the failedChanges record component.
final int	hashCode()	Returns a hash code value for this object.
CompletableFuture<Void>	notificationFuture()	Returns the value of the notificationFuture record component.
List<ChangeOperation>	successfulChanges()	Returns the value of the successfulChanges record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PartialPushResult

public PartialPushResult(List<ChangeOperation> successfulChanges,
 List<PartialPushResult.FailedChangeOperation> failedChanges,
 CompletableFuture<Void> notificationFuture)

Creates an instance of a PartialPushResult record class.

Parameters:

successfulChanges - the value for the successfulChanges record component

failedChanges - the value for the failedChanges record component

notificationFuture - the value for the notificationFuture record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

successfulChanges

public List<ChangeOperation> successfulChanges()

Returns the value of the successfulChanges record component.

Returns:

the value of the successfulChanges record component

failedChanges

public List<PartialPushResult.FailedChangeOperation> failedChanges()

Returns the value of the failedChanges record component.

Returns:

the value of the failedChanges record component

notificationFuture

public CompletableFuture<Void> notificationFuture()

Returns the value of the notificationFuture record component.

Returns:

the value of the notificationFuture record component