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 StringTYPE-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description RepositoriesMetaData(List<RepositoryMetaData> repositories)Constructs new repository metadataRepositoriesMetaData(StreamInput in)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description EnumSet<MetaData.XContentContext>context()booleanequals(Object o)static RepositoriesMetaDatafromXContent(XContentParser parser)VersiongetMinimalSupportedVersion()The minimal version of the recipient this object can be sent toStringgetWriteableName()Returns the name of the writeable objectinthashCode()static NamedDiff<MetaData.Custom>readDiffFrom(StreamInput in)List<RepositoryMetaData>repositories()Returns list of currently registered repositoriesRepositoryMetaDatarepository(String name)Returns a repository with a given name or null if such repository doesn't existstatic voidtoXContent(RepositoryMetaData repository, XContentBuilder builder, ToXContent.Params params)Serializes information about a single repositoryXContentBuildertoXContent(XContentBuilder builder, ToXContent.Params params)voidwriteTo(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.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
-
getWriteableName
public String getWriteableName()
Returns the name of the writeable object- Specified by:
getWriteableNamein interfaceNamedWriteable- Specified by:
getWriteableNamein interfaceVersionedNamedWriteable
-
getMinimalSupportedVersion
public Version getMinimalSupportedVersion()
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to- Specified by:
getMinimalSupportedVersionin interfaceVersionedNamedWriteable
-
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:
writeToin interfaceWriteable- 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:
toXContentin interfaceToXContent- Throws:
IOException
-
context
public EnumSet<MetaData.XContentContext> context()
- Specified by:
contextin interfaceMetaData.Custom
-
toXContent
public static void toXContent(RepositoryMetaData repository, XContentBuilder builder, ToXContent.Params params) throws IOException
Serializes information about a single repository- Parameters:
repository- repository metadatabuilder- XContent builderparams- serialization parameters- Throws:
IOException
-
-