Package org.elasticsearch.cluster.metadata

Class RepositoryMetaData

java.lang.Object

org.elasticsearch.cluster.metadata.RepositoryMetaData

public class RepositoryMetaData
extends java.lang.Object

Metadata about registered repository

Field Summary

Fields

Modifier and Type	Field	Description
static Version	REPO_GEN_IN_CS_VERSION

Constructor Summary

Constructors

Constructor	Description
RepositoryMetaData(java.lang.String name, java.lang.String type, Settings settings)	Constructs new repository metadata
RepositoryMetaData(java.lang.String name, java.lang.String type, Settings settings, long generation, long pendingGeneration)
RepositoryMetaData(RepositoryMetaData metaData, long generation, long pendingGeneration)
RepositoryMetaData(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
boolean	equalsIgnoreGenerations(RepositoryMetaData other)	Checks if this instance is equal to the other instance in all fields other than generation and pendingGeneration.
long	generation()	Returns the safe repository generation.
int	hashCode()
java.lang.String	name()	Returns repository name
long	pendingGeneration()	Returns the pending repository generation.
Settings	settings()	Returns repository settings
java.lang.String	toString()
java.lang.String	type()	Returns repository type
void	writeTo(StreamOutput out)	Writes repository metadata to stream output

Methods inherited from class java.lang.Object

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

Field Details

REPO_GEN_IN_CS_VERSION

public static final Version REPO_GEN_IN_CS_VERSION

Constructor Details

RepositoryMetaData

public RepositoryMetaData(java.lang.String name, java.lang.String type, Settings settings)

Constructs new repository metadata

Parameters:

name - repository name

type - repository type

settings - repository settings

RepositoryMetaData

public RepositoryMetaData(RepositoryMetaData metaData, long generation, long pendingGeneration)

RepositoryMetaData

public RepositoryMetaData(java.lang.String name, java.lang.String type, Settings settings, long generation, long pendingGeneration)

RepositoryMetaData

public RepositoryMetaData(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

Method Details

name

public java.lang.String name()

Returns repository name

Returns:

repository name

type

public java.lang.String type()

Returns repository type

Returns:

repository type

settings

public Settings settings()

Returns repository settings

Returns:

repository settings

generation

public long generation()

Returns the safe repository generation. RepositoryData for this generation is assumed to exist in the repository. All operations on the repository must be based on the RepositoryData at this generation. See package level documentation for the blob store based repositories org.elasticsearch.repositories.blobstore for details on how this value is used during snapshots.

Returns:

safe repository generation

pendingGeneration

public long pendingGeneration()

Returns the pending repository generation. RepositoryData for this generation and all generations down to the safe generation generation may exist in the repository and should not be reused for writing new RepositoryData to the repository. See package level documentation for the blob store based repositories org.elasticsearch.repositories.blobstore for details on how this value is used during snapshots.

Returns:

highest pending repository generation

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Writes repository metadata to stream output

Parameters:

out - stream output

Throws:

java.io.IOException

equalsIgnoreGenerations

public boolean equalsIgnoreGenerations(RepositoryMetaData other)

Checks if this instance is equal to the other instance in all fields other than generation and pendingGeneration.

Parameters:

other - other repository metadata

Returns:

true if both instances equal in all fields but the generation fields

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object