Package org.opensearch.persistent

Class PersistentTasksCustomMetadata.PersistentTask<P extends PersistentTaskParams>

java.lang.Object

org.opensearch.persistent.PersistentTasksCustomMetadata.PersistentTask<P>

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

Enclosing class:

PersistentTasksCustomMetadata

public static class PersistentTasksCustomMetadata.PersistentTask<P extends PersistentTaskParams>
extends Object
implements Writeable, org.opensearch.common.xcontent.ToXContentObject

A record that represents a single running persistent task

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

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

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

Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PersistentTask(String id, String name, P params, long allocationId, PersistentTasksCustomMetadata.Assignment assignment)
PersistentTask(StreamInput in)
PersistentTask(PersistentTasksCustomMetadata.PersistentTask<P> task, long allocationId, PersistentTasksCustomMetadata.Assignment assignment)
PersistentTask(PersistentTasksCustomMetadata.PersistentTask<P> task, PersistentTaskState state)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
long	getAllocationId()
PersistentTasksCustomMetadata.Assignment	getAssignment()
String	getExecutorNode()
String	getId()
P	getParams()
PersistentTaskState	getState()
String	getTaskName()
int	hashCode()
boolean	isAssigned()
boolean	isFragment()
String	toString()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params xParams)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentTask

public PersistentTask(String id,
 String name,
 P params,
 long allocationId,
 PersistentTasksCustomMetadata.Assignment assignment)

PersistentTask

public PersistentTask(PersistentTasksCustomMetadata.PersistentTask<P> task,
 long allocationId,
 PersistentTasksCustomMetadata.Assignment assignment)

PersistentTask

public PersistentTask(PersistentTasksCustomMetadata.PersistentTask<P> task,
 PersistentTaskState state)

PersistentTask

public PersistentTask(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

getAllocationId

public long getAllocationId()

getTaskName

public String getTaskName()

getParams

@Nullable
public P getParams()

getExecutorNode

@Nullable
public String getExecutorNode()

getAssignment

public PersistentTasksCustomMetadata.Assignment getAssignment()

isAssigned

public boolean isAssigned()

getState

@Nullable
public PersistentTaskState getState()

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params xParams)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

IOException

isFragment

public boolean isFragment()

Specified by:

isFragment in interface org.opensearch.common.xcontent.ToXContent

Specified by:

isFragment in interface org.opensearch.common.xcontent.ToXContentObject