Module org.elasticsearch.server

Package org.elasticsearch.persistent

Class PersistentTasksCustomMetadata

java.lang.Object

org.elasticsearch.cluster.AbstractNamedDiffable<Metadata.Custom>

org.elasticsearch.persistent.PersistentTasksCustomMetadata

All Implemented Interfaces:

Diffable<Metadata.Custom>, Metadata.Custom, NamedDiffable<Metadata.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public final class PersistentTasksCustomMetadata
extends AbstractNamedDiffable<Metadata.Custom>
implements Metadata.Custom

A cluster state record that contains a list of all running persistent tasks

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PersistentTasksCustomMetadata.Assignment
static class	PersistentTasksCustomMetadata.Builder
static class	PersistentTasksCustomMetadata.PersistentTask<P extends PersistentTaskParams>	A record that represents a single running persistent task

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ConstructingObjectParser<PersistentTasksCustomMetadata.Assignment,Void>	ASSIGNMENT_PARSER
static final PersistentTasksCustomMetadata.Assignment	INITIAL_ASSIGNMENT
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
PersistentTasksCustomMetadata(long lastAllocationId, Map<String,PersistentTasksCustomMetadata.PersistentTask<?>> tasks)
PersistentTasksCustomMetadata(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static PersistentTasksCustomMetadata.Builder	builder()
static PersistentTasksCustomMetadata.Builder	builder(PersistentTasksCustomMetadata tasks)
EnumSet<Metadata.XContentContext>	context()
static ClusterState	disassociateDeadNodes(ClusterState clusterState)	Unassign any persistent tasks executing on nodes that are no longer in the cluster.
boolean	equals(Object o)
Collection<PersistentTasksCustomMetadata.PersistentTask<?>>	findTasks(String taskName, Predicate<PersistentTasksCustomMetadata.PersistentTask<?>> predicate)
static PersistentTasksCustomMetadata	fromXContent(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
long	getNumberOfTasksOnNode(String nodeId, String taskName)
static PersistentTasksCustomMetadata	getPersistentTasksCustomMetadata(ClusterState clusterState)
PersistentTasksCustomMetadata.PersistentTask<?>	getTask(String id)
static <Params extends PersistentTaskParams> PersistentTasksCustomMetadata.PersistentTask<Params>	getTaskWithId(ClusterState clusterState, String taskId)
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static NamedDiff<Metadata.Custom>	readDiffFrom(StreamInput in)
Map<String,PersistentTasksCustomMetadata.PersistentTask<?>>	taskMap()
Collection<PersistentTasksCustomMetadata.PersistentTask<?>>	tasks()
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractNamedDiffable

diff, get, readDiffFrom

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

isFragment, toXContentChunkedV7

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Methods inherited from interface org.elasticsearch.cluster.metadata.Metadata.Custom

isRestorable

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

ASSIGNMENT_PARSER

public static final ConstructingObjectParser<PersistentTasksCustomMetadata.Assignment,Void> ASSIGNMENT_PARSER

INITIAL_ASSIGNMENT

public static final PersistentTasksCustomMetadata.Assignment INITIAL_ASSIGNMENT

Constructor Details

PersistentTasksCustomMetadata

public PersistentTasksCustomMetadata(long lastAllocationId,
 Map<String,PersistentTasksCustomMetadata.PersistentTask<?>> tasks)

PersistentTasksCustomMetadata

public PersistentTasksCustomMetadata(StreamInput in)
                              throws IOException

Throws:

IOException

Method Details

getPersistentTasksCustomMetadata

public static PersistentTasksCustomMetadata getPersistentTasksCustomMetadata(ClusterState clusterState)

tasks

public Collection<PersistentTasksCustomMetadata.PersistentTask<?>> tasks()

taskMap

public Map<String,PersistentTasksCustomMetadata.PersistentTask<?>> taskMap()

getTask

public PersistentTasksCustomMetadata.PersistentTask<?> getTask(String id)

findTasks

public Collection<PersistentTasksCustomMetadata.PersistentTask<?>> findTasks(String taskName,
 Predicate<PersistentTasksCustomMetadata.PersistentTask<?>> predicate)

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

getNumberOfTasksOnNode

public long getNumberOfTasksOnNode(String nodeId,
 String taskName)

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.Custom

fromXContent

public static PersistentTasksCustomMetadata fromXContent(XContentParser parser)

getTaskWithId

public static <Params extends PersistentTaskParams>
PersistentTasksCustomMetadata.PersistentTask<Params> getTaskWithId(ClusterState clusterState,
 String taskId)

disassociateDeadNodes

public static ClusterState disassociateDeadNodes(ClusterState clusterState)

Unassign any persistent tasks executing on nodes that are no longer in the cluster. If the task's assigment has a non-null executor node and that node is no longer in the cluster then the assignment is set to LOST_NODE_ASSIGNMENT

Parameters:

clusterState - The clusterstate

Returns:

If no changes the argument clusterState is returned else a copy with the modified tasks

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

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

readDiffFrom

public static NamedDiff<Metadata.Custom> readDiffFrom(StreamInput in)
                                               throws IOException

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

builder

public static PersistentTasksCustomMetadata.Builder builder()

builder

public static PersistentTasksCustomMetadata.Builder builder(PersistentTasksCustomMetadata tasks)