Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class ViewMetadata

java.lang.Object

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

org.elasticsearch.cluster.metadata.ViewMetadata

All Implemented Interfaces:

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

public final class ViewMetadata
extends AbstractNamedDiffable<Metadata.ProjectCustom>
implements Metadata.ProjectCustom

Encapsulates view definitions as custom metadata inside ProjectMetadata within cluster state.

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 ViewMetadata	EMPTY
static final List<NamedWriteableRegistry.Entry>	ENTRIES
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
ViewMetadata(Map<String,View> views)

Method Summary

Modifier and Type	Method	Description
EnumSet<Metadata.XContentContext>	context()
boolean	equals(Object o)
static ViewMetadata	fromXContent(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
View	getView(String name)
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static ViewMetadata	readFromStream(StreamInput in)
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Create an iterator of ToXContent chunks for a REST response.
Map<String,View>	views()
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

ENTRIES

public static final List<NamedWriteableRegistry.Entry> ENTRIES

EMPTY

public static final ViewMetadata EMPTY

Constructor Details

ViewMetadata

public ViewMetadata(Map<String,View> views)

Method Details

fromXContent

public static ViewMetadata fromXContent(XContentParser parser)
                                 throws IOException

Throws:

IOException

readFromStream

public static ViewMetadata readFromStream(StreamInput in)
                                   throws IOException

Throws:

IOException

views

public Map<String,View> views()

getView

@Nullable
public View getView(String name)

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.MetadataCustom<Metadata.ProjectCustom>

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

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

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object