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, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.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.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.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 final RepositoriesMetadata	EMPTY
static final String	HIDE_GENERATIONS_PARAM	Serialization parameter used to hide the RepositoryMetadata.generation() and RepositoryMetadata.pendingGeneration() in GetRepositoriesResponse.
static final String	TYPE

Fields inherited from interface org.elasticsearch.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)
boolean	equalsIgnoreGenerations(RepositoriesMetadata other)	Checks if this instance and the given instance share the same repositories by checking that this instances' repositories and the repositories in other are equal or only differ in their values of RepositoryMetadata.generation() and RepositoryMetadata.pendingGeneration().
static RepositoriesMetadata	fromXContent(org.elasticsearch.xcontent.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
String	toString()
static void	toXContent(RepositoryMetadata repository, org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)	Serializes information about a single repository
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
RepositoriesMetadata	withUpdatedGeneration(String repoName, long safeGeneration, long pendingGeneration)	Creates a new instance that has the given repository moved to the given safeGeneration and pendingGeneration.
RepositoriesMetadata	withUuid(String repoName, String uuid)	Creates a new instance that records the UUID of the given repository.
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, 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.xcontent.ToXContentFragment

isFragment

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

EMPTY

public static final RepositoriesMetadata EMPTY

HIDE_GENERATIONS_PARAM

public static final String HIDE_GENERATIONS_PARAM

Serialization parameter used to hide the RepositoryMetadata.generation() and RepositoryMetadata.pendingGeneration() in GetRepositoriesResponse.

See Also:

• Constant Field Values

Constructor Details

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 Details

withUpdatedGeneration

public RepositoriesMetadata withUpdatedGeneration(String repoName,
 long safeGeneration,
 long pendingGeneration)

Creates a new instance that has the given repository moved to the given safeGeneration and pendingGeneration.

Parameters:

repoName - repository name

safeGeneration - new safe generation

pendingGeneration - new pending generation

Returns:

new instance with updated generations

withUuid

public RepositoriesMetadata withUuid(String repoName,
 String uuid)

Creates a new instance that records the UUID of the given repository.

Parameters:

repoName - repository name

uuid - repository uuid

Returns:

new instance with updated uuid

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

equalsIgnoreGenerations

public boolean equalsIgnoreGenerations(@Nullable
 RepositoriesMetadata other)

Checks if this instance and the given instance share the same repositories by checking that this instances' repositories and the repositories in other are equal or only differ in their values of RepositoryMetadata.generation() and RepositoryMetadata.pendingGeneration().

Parameters:

other - other repositories metadata

Returns:

true iff both instances contain the same repositories apart from differences in generations

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(org.elasticsearch.xcontent.XContentParser parser)
                                         throws IOException

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.Custom

toXContent

public static void toXContent(RepositoryMetadata repository,
 org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                       throws IOException

Serializes information about a single repository

Parameters:

repository - repository metadata

builder - XContent builder

params - serialization parameters

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object