Package org.elasticsearch.cluster
Class SnapshotsInProgress
java.lang.Object
org.elasticsearch.cluster.AbstractNamedDiffable<ClusterState.Custom>
org.elasticsearch.cluster.SnapshotsInProgress
- All Implemented Interfaces:
ClusterState.Custom
,Diffable<ClusterState.Custom>
,NamedDiffable<ClusterState.Custom>
,NamedWriteable
,VersionedNamedWriteable
,Writeable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentFragment
public class SnapshotsInProgress
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom
Meta data about snapshots that are currently executing
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static enum
static enum
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
Modifier and TypeFieldDescriptionstatic final String
static final SnapshotsInProgress
static final String
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionasStream()
static boolean
Checks if all shards in the list have completedint
count()
boolean
The minimal version of the recipient this object can be sent toReturns the name of the writeable objectint
hashCode()
boolean
isEmpty()
obsoleteGenerations
(String repository, SnapshotsInProgress old) Computes a map of repository shard id to set of generations, containing all shard generations that became obsolete and may be deleted from the repository as the cluster state moved from the givenold
value ofSnapshotsInProgress
to this instance.static NamedDiff<ClusterState.Custom>
static SnapshotsInProgress.Entry
startClone
(Snapshot snapshot, SnapshotId source, Map<String, IndexId> indices, long startTime, long repositoryStateId, Version version) Creates the initial snapshot clone entrystatic SnapshotsInProgress.Entry
startedEntry
(Snapshot snapshot, boolean includeGlobalState, boolean partial, Map<String, IndexId> indices, List<String> dataStreams, long startTime, long repositoryStateId, ImmutableOpenMap<ShardId, SnapshotsInProgress.ShardSnapshotStatus> shards, Map<String, Object> userMetadata, Version version, List<SnapshotFeatureInfo> featureStates) Creates the initialSnapshotsInProgress.Entry
when starting a snapshot, if no shard-level snapshot work is to be done the resulting entry will be in stateSnapshotsInProgress.State.SUCCESS
right away otherwise it will be in stateSnapshotsInProgress.State.STARTED
.toString()
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) Serialize thisClusterState.Custom
for diagnostic purposes, exposed by thewithUpdatedEntriesForRepo
(String repository, List<SnapshotsInProgress.Entry> updatedEntries) 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.Custom
isPrivate
Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
EMPTY
-
TYPE
- See Also:
-
ABORTED_FAILURE_TEXT
- See Also:
-
-
Constructor Details
-
SnapshotsInProgress
- Throws:
IOException
-
-
Method Details
-
withUpdatedEntriesForRepo
public SnapshotsInProgress withUpdatedEntriesForRepo(String repository, List<SnapshotsInProgress.Entry> updatedEntries) -
withAddedEntry
-
forRepo
-
isEmpty
public boolean isEmpty() -
count
public int count() -
entriesByRepo
-
asStream
-
snapshot
-
obsoleteGenerations
public Map<RepositoryShardId,Set<ShardGeneration>> obsoleteGenerations(String repository, SnapshotsInProgress old) Computes a map of repository shard id to set of generations, containing all shard generations that became obsolete and may be deleted from the repository as the cluster state moved from the givenold
value ofSnapshotsInProgress
to this instance. -
getWriteableName
Description copied from interface:VersionedNamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
- Specified by:
getWriteableName
in interfaceVersionedNamedWriteable
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteable
The minimal version of the recipient this object can be sent to- Specified by:
getMinimalSupportedVersion
in interfaceVersionedNamedWriteable
-
readDiffFrom
- Throws:
IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException Description copied from interface:ClusterState.Custom
Serialize thisClusterState.Custom
for diagnostic purposes, exposed by theGET _cluster/state
API etc. The XContent representation does not need to be 100% faithful since we never reconstruct a cluster state from its XContent representation, but the more faithful it is the more useful it is for diagnostics.- Specified by:
toXContent
in interfaceClusterState.Custom
- Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
toString
-
startedEntry
public static SnapshotsInProgress.Entry startedEntry(Snapshot snapshot, boolean includeGlobalState, boolean partial, Map<String, IndexId> indices, List<String> dataStreams, long startTime, long repositoryStateId, ImmutableOpenMap<ShardId, SnapshotsInProgress.ShardSnapshotStatus> shards, Map<String, Object> userMetadata, Version version, List<SnapshotFeatureInfo> featureStates) Creates the initialSnapshotsInProgress.Entry
when starting a snapshot, if no shard-level snapshot work is to be done the resulting entry will be in stateSnapshotsInProgress.State.SUCCESS
right away otherwise it will be in stateSnapshotsInProgress.State.STARTED
. -
startClone
public static SnapshotsInProgress.Entry startClone(Snapshot snapshot, SnapshotId source, Map<String, IndexId> indices, long startTime, long repositoryStateId, Version version) Creates the initial snapshot clone entry- Parameters:
snapshot
- snapshot to clone intosource
- snapshot to clone fromindices
- indices to clonestartTime
- start timerepositoryStateId
- repository state id that this clone is based onversion
- repository metadata version to write- Returns:
- snapshot clone entry
-
completed
Checks if all shards in the list have completed- Parameters:
shards
- list of shard statuses- Returns:
- true if all shards have completed (either successfully or failed), false otherwise
-