Record Class ScatterGatherRequest

java.lang.Object

java.lang.Record

org.j7m.middleware.workload.api.ScatterGatherRequest

Record Components:

candidates - candidate targets after discovery

maxCandidates - maximum targets to query

deadline - total deadline

allowPartialResults - whether partial results may be returned

metadata - safe request metadata

public record ScatterGatherRequest(List<ObjectRef> candidates, int maxCandidates, Duration deadline, boolean allowPartialResults, Map<String,String> metadata)
extends Record

Scatter-gather request over multiple candidate references.

Constructor Summary

Constructors

Constructor	Description
ScatterGatherRequest(List<ObjectRef> candidates, int maxCandidates, Duration deadline, boolean allowPartialResults, Map<String,String> metadata)	Creates immutable request metadata.

Method Summary

Modifier and Type	Method	Description
boolean	allowPartialResults()	Returns the value of the allowPartialResults record component.
List<ObjectRef>	candidates()	Returns the value of the candidates record component.
Duration	deadline()	Returns the value of the deadline record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	maxCandidates()	Returns the value of the maxCandidates record component.
Map<String,String>	metadata()	Returns the value of the metadata 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

ScatterGatherRequest

public ScatterGatherRequest(List<ObjectRef> candidates,
 int maxCandidates,
 Duration deadline,
 boolean allowPartialResults,
 Map<String,String> metadata)

Creates immutable request metadata.

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.

candidates

public List<ObjectRef> candidates()

Returns the value of the candidates record component.

Returns:

the value of the candidates record component

maxCandidates

public int maxCandidates()

Returns the value of the maxCandidates record component.

Returns:

the value of the maxCandidates record component

deadline

public Duration deadline()

Returns the value of the deadline record component.

Returns:

the value of the deadline record component

allowPartialResults

public boolean allowPartialResults()

Returns the value of the allowPartialResults record component.

Returns:

the value of the allowPartialResults record component

metadata

public Map<String,String> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component