Package org.opensearch.core.tasks

Class TaskId

java.lang.Object

org.opensearch.core.tasks.TaskId

All Implemented Interfaces:

Writeable

@PublicApi(since="1.0.0")
public final class TaskId
extends Object
implements Writeable

Task id that consists of node id and id of the task on the node

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.WriteableRegistry, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final TaskId	EMPTY_TASK_ID

Constructor Summary

Constructors

Constructor	Description
TaskId(String taskId)
TaskId(String nodeId, long id)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
long	getId()
String	getNodeId()
int	hashCode()
boolean	isSet()
static ContextParser<Void,TaskId>	parser()
static TaskId	readFromStream(StreamInput in)	Read a TaskId from a stream.
String	toString()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_TASK_ID

public static final TaskId EMPTY_TASK_ID

Constructor Details

TaskId

public TaskId(String nodeId,
 long id)

TaskId

public TaskId(String taskId)

Method Details

readFromStream

public static TaskId readFromStream(StreamInput in)
                             throws IOException

Read a TaskId from a stream. TaskId has this rather than the usual constructor that takes a StreamInput so we can return the EMPTY_TASK_ID without allocating.

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

parser

public static ContextParser<Void,TaskId> parser()

getNodeId

public String getNodeId()

getId

public long getId()

isSet

public boolean isSet()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object