Record Class InvocationOptions

java.lang.Object

java.lang.Record

org.j7m.middleware.api.InvocationOptions

Record Components:

invocationId - caller-supplied or generated invocation identifier

deadline - invocation deadline duration

metadata - public invocation metadata

All Implemented Interfaces:

Serializable

public record InvocationOptions(String invocationId, Duration deadline, Map<String,String> metadata)
extends Record
implements Serializable

Immutable options for one method invocation.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InvocationOptions(String invocationId, Duration deadline, Map<String,String> metadata)	Creates immutable invocation options.

Method Summary

Modifier and Type	Method	Description
Duration	deadline()	Returns the value of the deadline record component.
static InvocationOptions	defaults()	Returns default invocation options.
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.
String	invocationId()	Returns the value of the invocationId record component.
Map<String,String>	metadata()	Returns the value of the metadata record component.
InvocationReliabilityOptions	reliabilityOptions()	Decodes typed reliability options from this invocation's metadata.
final String	toString()	Returns a string representation of this record class.
InvocationOptions	withReliabilityOptions(InvocationReliabilityOptions reliabilityOptions)	Returns a copy with reliability metadata merged into the public metadata map.

Methods inherited from class Object

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

Constructor Details

InvocationOptions

public InvocationOptions(String invocationId,
 Duration deadline,
 Map<String,String> metadata)

Creates immutable invocation options.

Method Details

defaults

public static InvocationOptions defaults()

Returns default invocation options.

Returns:

default options

reliabilityOptions

public InvocationReliabilityOptions reliabilityOptions()

Decodes typed reliability options from this invocation's metadata.

Returns:

reliability options

withReliabilityOptions

public InvocationOptions withReliabilityOptions(InvocationReliabilityOptions reliabilityOptions)

Returns a copy with reliability metadata merged into the public metadata map.

Parameters:

reliabilityOptions - reliability options to encode

Returns:

invocation options with reliability metadata

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.

invocationId

public String invocationId()

Returns the value of the invocationId record component.

Returns:

the value of the invocationId record component

deadline

public Duration deadline()

Returns the value of the deadline record component.

Returns:

the value of the deadline record component

metadata

public Map<String,String> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component