Record Class ScatterGatherResult

java.lang.Object

java.lang.Record

org.j7m.middleware.workload.api.ScatterGatherResult

Record Components:

successes - successful per-candidate values

failures - per-candidate safe failures

timeouts - timed-out candidate ids or endpoints

skippedCandidates - skipped candidate ids or endpoints

partial - whether partial data was returned

metadata - safe selection metadata

public record ScatterGatherResult(List<Object> successes, List<TaskFailure> failures, List<String> timeouts, List<String> skippedCandidates, boolean partial, Map<String,String> metadata)
extends Record

Result of a scatter-gather operation.

Constructor Summary

Constructors

Constructor	Description
ScatterGatherResult(List<Object> successes, List<TaskFailure> failures, List<String> timeouts, List<String> skippedCandidates, boolean partial, Map<String,String> metadata)	Creates immutable result collections.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<TaskFailure>	failures()	Returns the value of the failures record component.
final int	hashCode()	Returns a hash code value for this object.
Map<String,String>	metadata()	Returns the value of the metadata record component.
boolean	partial()	Returns the value of the partial record component.
List<String>	skippedCandidates()	Returns the value of the skippedCandidates record component.
List<Object>	successes()	Returns the value of the successes record component.
List<String>	timeouts()	Returns the value of the timeouts record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ScatterGatherResult

public ScatterGatherResult(List<Object> successes,
 List<TaskFailure> failures,
 List<String> timeouts,
 List<String> skippedCandidates,
 boolean partial,
 Map<String,String> metadata)

Creates immutable result collections.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

successes

public List<Object> successes()

Returns the value of the successes record component.

Returns:

the value of the successes record component

failures

public List<TaskFailure> failures()

Returns the value of the failures record component.

Returns:

the value of the failures record component

timeouts

public List<String> timeouts()

Returns the value of the timeouts record component.

Returns:

the value of the timeouts record component

skippedCandidates

public List<String> skippedCandidates()

Returns the value of the skippedCandidates record component.

Returns:

the value of the skippedCandidates record component

partial

public boolean partial()

Returns the value of the partial record component.

Returns:

the value of the partial record component

metadata

public Map<String,String> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component