Module org.elasticsearch.server

Package org.elasticsearch.snapshots

Class RegisteredPolicySnapshots

java.lang.Object

org.elasticsearch.snapshots.RegisteredPolicySnapshots

All Implemented Interfaces:

Diffable<Metadata.Custom>, Metadata.Custom, NamedDiffable<Metadata.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public class RegisteredPolicySnapshots
extends Object
implements Metadata.Custom

RegisteredPolicySnapshots records a set of snapshot IDs along with their SLM policy name. It is used to infer the failure of snapshots which did not record their failure in SnapshotLifecycleStats. The set is stored in the cluster state as custom metadata. When a snapshot is started by SLM, it is added to this set. Upon completion, is it removed. If a snapshot does not record its failure in SnapshotLifecycleStats, likely due to a master shutdown, it will not be removed from the registered set. A subsequent snapshot will then find that a registered snapshot is no longer running and will infer that it failed, updating SnapshotLifecycleStats accordingly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RegisteredPolicySnapshots.Builder
static class	RegisteredPolicySnapshots.PolicySnapshot
static class	RegisteredPolicySnapshots.RegisteredSnapshotsDiff

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 RegisteredPolicySnapshots	EMPTY
static final ConstructingObjectParser<RegisteredPolicySnapshots,Void>	PARSER
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
RegisteredPolicySnapshots(List<RegisteredPolicySnapshots.PolicySnapshot> snapshots)
RegisteredPolicySnapshots(StreamInput in)

Method Summary

Modifier and Type	Method	Description
RegisteredPolicySnapshots.Builder	builder()
boolean	contains(SnapshotId snapshotId)
EnumSet<Metadata.XContentContext>	context()
Diff<Metadata.Custom>	diff(Metadata.Custom previousState)	Returns serializable object representing differences between this and previousState
boolean	equals(Object obj)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
List<RegisteredPolicySnapshots.PolicySnapshot>	getSnapshots()
List<SnapshotId>	getSnapshotsByPolicy(String policy)
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static RegisteredPolicySnapshots	parse(XContentParser parser)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

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

isFragment, toXContentChunkedV7

Methods inherited from interface org.elasticsearch.cluster.metadata.Metadata.Custom

isRestorable

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

EMPTY

public static final RegisteredPolicySnapshots EMPTY

PARSER

public static final ConstructingObjectParser<RegisteredPolicySnapshots,Void> PARSER

Constructor Details

RegisteredPolicySnapshots

public RegisteredPolicySnapshots(List<RegisteredPolicySnapshots.PolicySnapshot> snapshots)

RegisteredPolicySnapshots

public RegisteredPolicySnapshots(StreamInput in)
                          throws IOException

Throws:

IOException

Method Details

getSnapshots

public List<RegisteredPolicySnapshots.PolicySnapshot> getSnapshots()

contains

public boolean contains(SnapshotId snapshotId)

getSnapshotsByPolicy

public List<SnapshotId> getSnapshotsByPolicy(String policy)

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.Custom

diff

public Diff<Metadata.Custom> diff(Metadata.Custom previousState)

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<Metadata.Custom>

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

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

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

parse

public static RegisteredPolicySnapshots parse(XContentParser parser)
                                       throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

builder

public RegisteredPolicySnapshots.Builder builder()