Package org.elasticsearch.cluster.metadata

Class ItemUsage

java.lang.Object

org.elasticsearch.cluster.metadata.ItemUsage

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class ItemUsage
extends Object
implements Writeable, ToXContentObject

A class encapsulating the usage of a particular "thing" by something else

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ItemUsage(Collection<String> indices, Collection<String> dataStreams, Collection<String> composableTemplates)	Create a new usage, a null value indicates that the item *cannot* be used by the thing, otherwise use an empty collection to indicate no usage.
ItemUsage(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Set<String>	getComposableTemplates()
Set<String>	getDataStreams()
Set<String>	getIndices()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.xcontent.ToXContentObject

isFragment

Constructor Details

ItemUsage

public ItemUsage(@Nullable
 Collection<String> indices,
 @Nullable
 Collection<String> dataStreams,
 @Nullable
 Collection<String> composableTemplates)

Create a new usage, a null value indicates that the item *cannot* be used by the thing, otherwise use an empty collection to indicate no usage.

ItemUsage

public ItemUsage(StreamInput in)
          throws IOException

Throws:

IOException

Method Details

getIndices

public Set<String> getIndices()

getDataStreams

public Set<String> getDataStreams()

getComposableTemplates

public Set<String> getComposableTemplates()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

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

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