Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class DesiredNodesMetadata

java.lang.Object

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

org.elasticsearch.cluster.metadata.DesiredNodesMetadata

All Implemented Interfaces:

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

public class DesiredNodesMetadata
extends AbstractNamedDiffable<Metadata.ClusterCustom>
implements Metadata.ClusterCustom

Nested Class Summary

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 DesiredNodesMetadata	EMPTY
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
DesiredNodesMetadata(DesiredNodes latestDesiredNodes)
DesiredNodesMetadata(StreamInput in)

Method Summary

Modifier and Type	Method	Description
EnumSet<Metadata.XContentContext>	context()
boolean	equals(Object o)
static DesiredNodesMetadata	fromClusterState(ClusterState clusterState)
static DesiredNodesMetadata	fromXContent(XContentParser parser)
DesiredNodes	getLatestDesiredNodes()
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static NamedDiff<Metadata.ClusterCustom>	readDiffFrom(StreamInput in)
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, toString, 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.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

EMPTY

public static final DesiredNodesMetadata EMPTY

Constructor Details

DesiredNodesMetadata

public DesiredNodesMetadata(DesiredNodes latestDesiredNodes)

DesiredNodesMetadata

public DesiredNodesMetadata(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

readDiffFrom

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

Throws:

IOException

fromXContent

public static DesiredNodesMetadata fromXContent(XContentParser parser)
                                         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

fromClusterState

public static DesiredNodesMetadata fromClusterState(ClusterState clusterState)

getLatestDesiredNodes

@Nullable
public DesiredNodes getLatestDesiredNodes()

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

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object