org.elasticsearch.cluster.metadata

Class RepositoriesMetaData

java.lang.Object

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

org.elasticsearch.cluster.metadata.RepositoriesMetaData

All Implemented Interfaces:

Diffable<MetaData.Custom>, MetaData.Custom, StreamableReader<MetaData.Custom>, Writeable<MetaData.Custom>, ToXContent

public class RepositoriesMetaData
extends AbstractDiffable<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

Field Summary

Fields

Modifier and Type	Field and Description
static RepositoriesMetaData	PROTO
static String	TYPE

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
RepositoriesMetaData(RepositoryMetaData... repositories) Constructs new repository metadata

Method Summary

Methods

Modifier and Type	Method and Description
EnumSet<MetaData.XContentContext>	context()
boolean	equals(Object o)
RepositoriesMetaData	fromXContent(XContentParser parser)
int	hashCode()
MetaData.Custom	readFrom(StreamInput in) Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
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)
String	type()
void	writeTo(StreamOutput out) Writes the current object into the output stream out

Methods inherited from class org.elasticsearch.cluster.AbstractDiffable

diff, get, readDiffFrom, readDiffFrom

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff, readDiffFrom

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

PROTO

public static final RepositoriesMetaData PROTO

Constructor Detail

RepositoriesMetaData

public RepositoriesMetaData(RepositoryMetaData... repositories)

Constructs new repository metadata

Parameters:

repositories - list of repositories

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

type

public String type()

Specified by:

type in interface MetaData.Custom

readFrom

public MetaData.Custom readFrom(StreamInput in)
                         throws IOException

Reads a copy of an object with the same type form the stream input The caller object remains unchanged.

Specified by:

readFrom in interface StreamableReader<MetaData.Custom>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Writes the current object into the output stream out

Specified by:

writeTo in interface Writeable<MetaData.Custom>

Throws:

IOException

fromXContent

public RepositoriesMetaData fromXContent(XContentParser parser)
                                  throws IOException

Specified by:

fromXContent in interface MetaData.Custom

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