Package com.inductiveautomation.ignition.gateway.dataroutes

Record Class PushResponse

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.dataroutes.PushResponse

public record PushResponse(boolean success, List<PushResponse.ChangedResource> changes, @Nullable Throwable problem)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PushResponse.ChangedResource

Constructor Summary

Constructors

Constructor	Description
PushResponse(boolean success, List<PushResponse.ChangedResource> changes, Throwable problem)	Creates an instance of a PushResponse record class.

Method Summary

Modifier and Type	Method	Description
List<PushResponse.ChangedResource>	changes()	Returns the value of the changes record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static PushResponse	failure(Throwable problem)
static com.inductiveautomation.ignition.common.gson.JsonObject	getJsonSchema()
final int	hashCode()	Returns a hash code value for this object.
Throwable	problem()	Returns the value of the problem record component.
boolean	success()	Returns the value of the success record component.
static PushResponse	success(List<ChangeOperation> changes)
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

PushResponse

public PushResponse(boolean success,
 List<PushResponse.ChangedResource> changes,
 @Nullable
 Throwable problem)

Creates an instance of a PushResponse record class.

Parameters:

success - the value for the success record component

changes - the value for the changes record component

problem - the value for the problem record component

Method Details

success

public static PushResponse success(List<ChangeOperation> changes)

failure

public static PushResponse failure(Throwable problem)

getJsonSchema

public static com.inductiveautomation.ignition.common.gson.JsonObject getJsonSchema()

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

success

public boolean success()

Returns the value of the success record component.

Returns:

the value of the success record component

changes

public List<PushResponse.ChangedResource> changes()

Returns the value of the changes record component.

Returns:

the value of the changes record component

problem

@Nullable
public Throwable problem()

Returns the value of the problem record component.

Returns:

the value of the problem record component