Package org.opends.server.tools.tasks

Record Class TaskScheduleInformation

java.lang.Object

java.lang.Record

org.opends.server.tools.tasks.TaskScheduleInformation

Record Components:

taskImplementation - the task implementation

taskScheduleUserData - the task schedule user data

public record TaskScheduleInformation(TaskScheduleInformation.TaskImplementation taskImplementation, TaskScheduleInformation.TaskScheduleUserData taskScheduleUserData)
extends Record

Interface for tools that are capable of scheduling a task remotely through the task backend.

See Also:

• TaskClient

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	TaskScheduleInformation.TaskImplementation	A task is sent to the server to execute a utility immediately or at a later time.
static final record	TaskScheduleInformation.TaskScheduleUserData	A generic data structure that contains the data that the user provided to schedule a task.

Constructor Summary

Constructors

Constructor	Description
TaskScheduleInformation(TaskScheduleInformation.TaskImplementation taskImplementation, TaskScheduleInformation.TaskScheduleUserData taskScheduleUserData)	Creates an instance of a TaskScheduleInformation record class.

Method Summary

Modifier and Type	Method	Description
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.
TaskScheduleInformation.TaskImplementation	taskImplementation()	Returns the value of the taskImplementation record component.
TaskScheduleInformation.TaskScheduleUserData	taskScheduleUserData()	Returns the value of the taskScheduleUserData 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

TaskScheduleInformation

public TaskScheduleInformation(TaskScheduleInformation.TaskImplementation taskImplementation,
 TaskScheduleInformation.TaskScheduleUserData taskScheduleUserData)

Creates an instance of a TaskScheduleInformation record class.

Parameters:

taskImplementation - the value for the taskImplementation record component

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

taskImplementation

public TaskScheduleInformation.TaskImplementation taskImplementation()

Returns the value of the taskImplementation record component.

Returns:

the value of the taskImplementation record component

taskScheduleUserData

public TaskScheduleInformation.TaskScheduleUserData taskScheduleUserData()

Returns the value of the taskScheduleUserData record component.

Returns:

the value of the taskScheduleUserData record component