Package org.opensearch.cluster
Class SnapshotsInProgress
java.lang.Object
org.opensearch.cluster.AbstractNamedDiffable<ClusterState.Custom>
org.opensearch.cluster.SnapshotsInProgress
- All Implemented Interfaces:
ClusterState.Custom
,ClusterState.FeatureAware
,Diffable<ClusterState.Custom>
,NamedDiffable<ClusterState.Custom>
,NamedWriteable
,VersionedNamedWriteable
,Writeable
,org.opensearch.common.xcontent.ToXContent
,org.opensearch.common.xcontent.ToXContentFragment
public class SnapshotsInProgress extends AbstractNamedDiffable<ClusterState.Custom> implements ClusterState.Custom
Meta data about snapshots that are currently executing
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SnapshotsInProgress.Entry
static class
SnapshotsInProgress.ShardSnapshotStatus
static class
SnapshotsInProgress.ShardState
static class
SnapshotsInProgress.State
Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent
org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ABORTED_FAILURE_TEXT
static SnapshotsInProgress
EMPTY
static java.lang.String
TYPE
-
Constructor Summary
Constructors Constructor Description SnapshotsInProgress(StreamInput in)
-
Method Summary
Modifier and Type Method Description static boolean
completed(com.carrotsearch.hppc.ObjectContainer<SnapshotsInProgress.ShardSnapshotStatus> shards)
Checks if all shards in the list have completedjava.util.List<SnapshotsInProgress.Entry>
entries()
boolean
equals(java.lang.Object o)
Version
getMinimalSupportedVersion()
The minimal version of the recipient this object can be sent tojava.lang.String
getWriteableName()
Returns the name of the writeable objectint
hashCode()
static SnapshotsInProgress
of(java.util.List<SnapshotsInProgress.Entry> entries)
static NamedDiff<ClusterState.Custom>
readDiffFrom(StreamInput in)
SnapshotsInProgress.Entry
snapshot(Snapshot snapshot)
static SnapshotsInProgress.Entry
startClone(Snapshot snapshot, SnapshotId source, java.util.List<IndexId> indices, long startTime, long repositoryStateId, Version version)
Creates the initial snapshot clone entrystatic SnapshotsInProgress.Entry
startedEntry(Snapshot snapshot, boolean includeGlobalState, boolean partial, java.util.List<IndexId> indices, java.util.List<java.lang.String> dataStreams, long startTime, long repositoryStateId, ImmutableOpenMap<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards, java.util.Map<java.lang.String,java.lang.Object> userMetadata, Version version)
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
.java.lang.String
toString()
org.opensearch.common.xcontent.XContentBuilder
toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
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.opensearch.cluster.ClusterState.FeatureAware
getRequiredFeature
-
Field Details
-
EMPTY
-
TYPE
public static final java.lang.String TYPE- See Also:
- Constant Field Values
-
ABORTED_FAILURE_TEXT
public static final java.lang.String ABORTED_FAILURE_TEXT- See Also:
- Constant Field Values
-
-
Constructor Details
-
SnapshotsInProgress
- Throws:
java.io.IOException
-
-
Method Details
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
startedEntry
public static SnapshotsInProgress.Entry startedEntry(Snapshot snapshot, boolean includeGlobalState, boolean partial, java.util.List<IndexId> indices, java.util.List<java.lang.String> dataStreams, long startTime, long repositoryStateId, ImmutableOpenMap<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards, java.util.Map<java.lang.String,java.lang.Object> userMetadata, Version version)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, java.util.List<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
public static boolean completed(com.carrotsearch.hppc.ObjectContainer<SnapshotsInProgress.ShardSnapshotStatus> shards)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
-
of
-
entries
-
snapshot
-
getWriteableName
public java.lang.String 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
public static NamedDiff<ClusterState.Custom> readDiffFrom(StreamInput in) throws java.io.IOException- Throws:
java.io.IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.opensearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-