Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class DataStreamMetadata

java.lang.Object

org.elasticsearch.cluster.metadata.DataStreamMetadata

All Implemented Interfaces:

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

public class DataStreamMetadata
extends Object
implements Metadata.ProjectCustom

Custom Metadata implementation for storing a map of DataStreams and their names.

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

Constructor Summary

Constructors

Constructor	Description
DataStreamMetadata(ImmutableOpenMap<String,DataStream> dataStreams, ImmutableOpenMap<String,DataStreamAlias> dataStreamAliases)
DataStreamMetadata(StreamInput in)

Method Summary

Modifier and Type	Method	Description
EnumSet<Metadata.XContentContext>	context()
Map<String,DataStream>	dataStreams()
Diff<Metadata.ProjectCustom>	diff(Metadata.ProjectCustom before)	Returns serializable object representing differences between this and previousState
boolean	equals(Object obj)
static DataStreamMetadata	fromXContent(XContentParser parser)
Map<String,DataStreamAlias>	getDataStreamAliases()
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()
boolean	isRestorable()
static NamedDiff<Metadata.ProjectCustom>	readDiffFrom(StreamInput in)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Create an iterator of ToXContent chunks for a REST response.
DataStreamMetadata	withAddedDatastream(DataStream datastream)
DataStreamMetadata	withAlias(String aliasName, String dataStream, Boolean isWriteDataStream, String filter)
DataStreamMetadata	withRemovedAlias(String aliasName, String dataStreamName, boolean mustExist)
DataStreamMetadata	withRemovedDataStream(String name)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

EMPTY

public static final DataStreamMetadata EMPTY

Constructor Details

DataStreamMetadata

public DataStreamMetadata(ImmutableOpenMap<String,DataStream> dataStreams,
 ImmutableOpenMap<String,DataStreamAlias> dataStreamAliases)

DataStreamMetadata

public DataStreamMetadata(StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

withAddedDatastream

public DataStreamMetadata withAddedDatastream(DataStream datastream)

withAlias

public DataStreamMetadata withAlias(String aliasName,
 String dataStream,
 Boolean isWriteDataStream,
 String filter)

withRemovedDataStream

public DataStreamMetadata withRemovedDataStream(String name)

withRemovedAlias

public DataStreamMetadata withRemovedAlias(String aliasName,
 String dataStreamName,
 boolean mustExist)

dataStreams

public Map<String,DataStream> dataStreams()

getDataStreamAliases

public Map<String,DataStreamAlias> getDataStreamAliases()

diff

public Diff<Metadata.ProjectCustom> diff(Metadata.ProjectCustom before)

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<Metadata.ProjectCustom>

readDiffFrom

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

Throws:

IOException

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.MetadataCustom<Metadata.ProjectCustom>

isRestorable

public boolean isRestorable()

Specified by:

isRestorable in interface Metadata.MetadataCustom<Metadata.ProjectCustom>

Returns:

true if this custom could be restored from snapshot

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

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

fromXContent

public static DataStreamMetadata 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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object