Module org.elasticsearch.server

Package org.elasticsearch.persistent

Class ClusterPersistentTasksCustomMetadata

java.lang.Object

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

org.elasticsearch.persistent.ClusterPersistentTasksCustomMetadata

All Implemented Interfaces:

Diffable<Metadata.ClusterCustom>, Metadata.ClusterCustom, Metadata.MetadataCustom<Metadata.ClusterCustom>, NamedDiffable<Metadata.ClusterCustom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent, PersistentTasks

public final class ClusterPersistentTasksCustomMetadata
extends AbstractNamedDiffable<Metadata.ClusterCustom>
implements Metadata.ClusterCustom, PersistentTasks

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusterPersistentTasksCustomMetadata.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.persistent.PersistentTasks

PersistentTasks.Parsers, PersistentTasks.TaskBuilder<Params extends PersistentTaskParams>, PersistentTasks.TaskDescriptionBuilder<Params extends PersistentTaskParams>

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 String	TYPE

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

EMPTY

Fields inherited from interface org.elasticsearch.persistent.PersistentTasks

API_CONTEXT, INITIAL_ASSIGNMENT, LOST_NODE_ASSIGNMENT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ClusterPersistentTasksCustomMetadata.Builder	builder()
static ClusterPersistentTasksCustomMetadata.Builder	builder(ClusterPersistentTasksCustomMetadata tasks)
EnumSet<Metadata.XContentContext>	context()
boolean	equals(Object o)
static ClusterPersistentTasksCustomMetadata	fromXContent(XContentParser parser)
static ClusterPersistentTasksCustomMetadata	get(Metadata metadata)
long	getLastAllocationId()
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
static ClusterPersistentTasksCustomMetadata	getPersistentTasksCustomMetadata(ClusterState clusterState)	Deprecated, for removal: This API element is subject to removal in a future version.
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.ClusterCustom>	readDiffFrom(StreamInput in)
Map<String,PersistentTasksCustomMetadata.PersistentTask<?>>	taskMap()
ClusterPersistentTasksCustomMetadata.Builder	toBuilder()	Convert the PersistentTasks object into the corresponding builder
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, toXContentChunked, toXContentChunkedV8

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

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

isRestorable

Methods inherited from interface org.elasticsearch.persistent.PersistentTasks

doToXContentChunked, doWriteTo, findTasks, getNumberOfTasksOnNode, getTask, tasks

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

ClusterPersistentTasksCustomMetadata

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

ClusterPersistentTasksCustomMetadata

public ClusterPersistentTasksCustomMetadata(StreamInput in)
                                     throws IOException

Throws:

IOException

Method Details

getPersistentTasksCustomMetadata

@Deprecated(forRemoval=true)
public static ClusterPersistentTasksCustomMetadata getPersistentTasksCustomMetadata(ClusterState clusterState)

Deprecated, for removal: This API element is subject to removal in a future version.

get

public static ClusterPersistentTasksCustomMetadata get(Metadata metadata)

fromXContent

public static ClusterPersistentTasksCustomMetadata fromXContent(XContentParser parser)

getTaskWithId

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

getLastAllocationId

public long getLastAllocationId()

Specified by:

getLastAllocationId in interface PersistentTasks

Returns:

The last allocation id for the tasks.

taskMap

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

Specified by:

taskMap in interface PersistentTasks

Returns:

The map of actual tasks keyed by task ID.

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

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to. See VersionedNamedWriteable.supportsVersion(TransportVersion) for the default serialization check.

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.MetadataCustom<Metadata.ClusterCustom>

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.ClusterCustom> 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. The last chunk in the iterator must always yield at least one byte of output. 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

toBuilder

public ClusterPersistentTasksCustomMetadata.Builder toBuilder()

Description copied from interface: PersistentTasks

Convert the PersistentTasks object into the corresponding builder

Specified by:

toBuilder in interface PersistentTasks

builder

public static ClusterPersistentTasksCustomMetadata.Builder builder()

builder

public static ClusterPersistentTasksCustomMetadata.Builder builder(ClusterPersistentTasksCustomMetadata tasks)