Package org.elasticsearch.cluster.metadata

Class RepositoriesMetaData

java.lang.Object

org.elasticsearch.cluster.AbstractNamedDiffable<MetaData.Custom>

org.elasticsearch.cluster.metadata.RepositoriesMetaData

All Implemented Interfaces:

ClusterState.FeatureAware, Diffable<MetaData.Custom>, MetaData.Custom, NamedDiffable<MetaData.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentFragment

public class RepositoriesMetaData
extends AbstractNamedDiffable<MetaData.Custom>
implements MetaData.Custom

Contains metadata about registered snapshot repositories

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.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

Modifier and Type	Field	Description
static String	TYPE

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RepositoriesMetaData(List<RepositoryMetaData> repositories)	Constructs new repository metadata
RepositoriesMetaData(StreamInput in)

Method Summary

Modifier and Type	Method	Description
EnumSet<MetaData.XContentContext>	context()
boolean	equals(Object o)
static RepositoriesMetaData	fromXContent(XContentParser parser)
Version	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.Custom>	readDiffFrom(StreamInput in)
List<RepositoryMetaData>	repositories()	Returns list of currently registered repositories
RepositoryMetaData	repository(String name)	Returns a repository with a given name or null if such repository doesn't exist
static void	toXContent(RepositoryMetaData repository, XContentBuilder builder, ToXContent.Params params)	Serializes information about a single repository
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.cluster.ClusterState.FeatureAware

getRequiredFeature

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

RepositoriesMetaData

public RepositoriesMetaData(List<RepositoryMetaData> repositories)

Constructs new repository metadata

Parameters:

repositories - list of repositories

RepositoriesMetaData

public RepositoriesMetaData(StreamInput in)
                     throws IOException

Throws:

IOException

Method Detail

repositories

public List<RepositoryMetaData> repositories()

Returns list of currently registered repositories

Returns:

list of repositories

repository

public RepositoryMetaData repository(String name)

Returns a repository with a given name or null if such repository doesn't exist

Parameters:

name - name of repository

Returns:

repository metadata

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getWriteableName

public String getWriteableName()

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

readDiffFrom

public static NamedDiff<MetaData.Custom> readDiffFrom(StreamInput in)
                                               throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

fromXContent

public static RepositoriesMetaData fromXContent(XContentParser parser)
                                         throws IOException

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

context

public EnumSet<MetaData.XContentContext> context()

Specified by:

context in interface MetaData.Custom

toXContent

public static void toXContent(RepositoryMetaData repository,
                              XContentBuilder builder,
                              ToXContent.Params params)
                       throws IOException

Serializes information about a single repository

Parameters:

repository - repository metadata

builder - XContent builder

params - serialization parameters

Throws:

IOException