java.lang.Object
org.elasticsearch.snapshots.RegisteredPolicySnapshots
- All Implemented Interfaces:
Diffable<Metadata.Custom>,Metadata.Custom,NamedDiffable<Metadata.Custom>,NamedWriteable,VersionedNamedWriteable,Writeable,ChunkedToXContent
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 ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final RegisteredPolicySnapshotsstatic final ConstructingObjectParser<RegisteredPolicySnapshots, Void> static final String -
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionbuilder()booleancontains(SnapshotId snapshotId) context()diff(Metadata.Custom previousState) Returns serializable object representing differences between this and previousStatebooleanThe minimal version of the recipient this object can be sent togetSnapshotsByPolicy(String policy) Returns the name of the writeable objectinthashCode()static RegisteredPolicySnapshotsparse(XContentParser parser) toString()Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored) Create an iterator ofToXContentchunks for a REST response.voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
isFragment, toXContentChunkedV7Methods inherited from interface org.elasticsearch.cluster.metadata.Metadata.Custom
isRestorable
-
Field Details
-
TYPE
- See Also:
-
EMPTY
-
PARSER
-
-
Constructor Details
-
RegisteredPolicySnapshots
-
RegisteredPolicySnapshots
- Throws:
IOException
-
-
Method Details
-
getSnapshots
-
contains
-
getSnapshotsByPolicy
-
context
- Specified by:
contextin interfaceMetadata.Custom
-
diff
Description copied from interface:DiffableReturns serializable object representing differences between this and previousState- Specified by:
diffin interfaceDiffable<Metadata.Custom>
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object- Specified by:
getWriteableNamein interfaceNamedWriteable- Specified by:
getWriteableNamein interfaceVersionedNamedWriteable
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to- Specified by:
getMinimalSupportedVersionin interfaceVersionedNamedWriteable
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContentChunked
Description copied from interface:ChunkedToXContentCreate an iterator ofToXContentchunks for a REST response. Each chunk is serialized with the sameXContentBuilderandToXContent.Params, which is also the same as theToXContent.Paramspassed as theparamsargument. For best results, all chunks should beO(1)size. The last chunk in the iterator must always yield at least one byte of output. See alsoChunkedToXContentHelperfor 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:
toXContentChunkedin interfaceChunkedToXContent- Returns:
- iterator over chunks of
ToXContent
-
parse
- Throws:
IOException
-
toString
-
hashCode
public int hashCode() -
equals
-
builder
-