Package akka.javasdk.agent.task

Record Class TaskSnapshot<R>

Object

Record

akka.javasdk.agent.task.TaskSnapshot<R>

Type Parameters:

R - The result type of the task.

public record TaskSnapshot<R>(String name, String description, String instructions, TaskStatus status, Optional<R> result, Optional<String> failureReason)
extends Record

A point-in-time snapshot of a task's state, with a typed result.

Constructor Summary

Constructors

Constructor	Description
TaskSnapshot(String name, String description, String instructions, TaskStatus status, Optional<R> result, Optional<String> failureReason)	Creates an instance of a TaskSnapshot record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<String>	failureReason()	Returns the value of the failureReason record component.
final int	hashCode()	Returns a hash code value for this object.
String	instructions()	Returns the value of the instructions record component.
String	name()	Returns the value of the name record component.
Optional<R>	result()	Returns the value of the result record component.
TaskStatus	status()	Returns the value of the status 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

TaskSnapshot

public TaskSnapshot(String name,
 String description,
 String instructions,
 TaskStatus status,
 Optional<R> result,
 Optional<String> failureReason)

Creates an instance of a TaskSnapshot record class.

Parameters:

name - the value for the name record component

description - the value for the description record component

instructions - the value for the instructions record component

status - the value for the status record component

result - the value for the result record component

failureReason - the value for the failureReason 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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

instructions

public String instructions()

Returns the value of the instructions record component.

Returns:

the value of the instructions record component

status

public TaskStatus status()

Returns the value of the status record component.

Returns:

the value of the status record component

result

public Optional<R> result()

Returns the value of the result record component.

Returns:

the value of the result record component

failureReason

public Optional<String> failureReason()

Returns the value of the failureReason record component.

Returns:

the value of the failureReason record component