Module org.elasticsearch.server

Package org.elasticsearch.cluster

Class SnapshotsInProgress.Entry

java.lang.Object

org.elasticsearch.cluster.SnapshotsInProgress.Entry

All Implemented Interfaces:

Writeable, RepositoryOperation, ToXContent

Enclosing class:

SnapshotsInProgress

public static class SnapshotsInProgress.Entry
extends Object
implements Writeable, ToXContent, RepositoryOperation

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Entry(Snapshot snapshot, boolean includeGlobalState, boolean partial, SnapshotsInProgress.State state, Map<String,IndexId> indices, List<String> dataStreams, List<SnapshotFeatureInfo> featureStates, long startTime, long repositoryStateId, Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards, String failure, Map<String,Object> userMetadata, Version version)

Method Summary

Modifier and Type	Method	Description
SnapshotsInProgress.Entry	abort()	Create a new instance by aborting this instance.
List<String>	dataStreams()
boolean	equals(Object o)
String	failure()
List<SnapshotFeatureInfo>	featureStates()
int	hashCode()
boolean	includeGlobalState()
Index	indexByName(String name)
Map<String,IndexId>	indices()
boolean	isClone()
boolean	isFragment()
boolean	partial()
String	repository()	Name of the repository affected.
long	repositoryStateId()	The repository state id at the time the operation began.
ShardId	shardId(RepositoryShardId repositoryShardId)
Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus>	shards()
Map<RepositoryShardId,SnapshotsInProgress.ShardSnapshotStatus>	shardsByRepoShardId()
Snapshot	snapshot()
SnapshotId	source()
long	startTime()
SnapshotsInProgress.State	state()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Map<String,Object>	userMetadata()
Version	version()	What version of metadata to use for the snapshot in the repository
SnapshotsInProgress.Entry	withClones(Map<RepositoryShardId,SnapshotsInProgress.ShardSnapshotStatus> updatedClones)
SnapshotsInProgress.Entry	withRepoGen(long newRepoGen)
SnapshotsInProgress.Entry	withShardStates(Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards)	Create a new instance that has its shard assignments replaced by the given shard assignment map.
SnapshotsInProgress.Entry	withStartedShards(Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards)	Same as withShardStates(java.util.Map<org.elasticsearch.index.shard.ShardId, org.elasticsearch.cluster.SnapshotsInProgress.ShardSnapshotStatus>) but does not check if the snapshot completed and thus is only to be used when starting new shard snapshots on data nodes for a running snapshot.
SnapshotsInProgress.Entry	withUpdatedIndexIds(Map<IndexId,IndexId> updates)	Reassigns all IndexId in a snapshot that can be found as keys in the given updates to the IndexId value that they map to.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Constructor Details

Entry

public Entry(Snapshot snapshot,
 boolean includeGlobalState,
 boolean partial,
 SnapshotsInProgress.State state,
 Map<String,IndexId> indices,
 List<String> dataStreams,
 List<SnapshotFeatureInfo> featureStates,
 long startTime,
 long repositoryStateId,
 Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards,
 String failure,
 Map<String,Object> userMetadata,
 Version version)

Method Details

withRepoGen

public SnapshotsInProgress.Entry withRepoGen(long newRepoGen)

withUpdatedIndexIds

public SnapshotsInProgress.Entry withUpdatedIndexIds(Map<IndexId,IndexId> updates)

Reassigns all IndexId in a snapshot that can be found as keys in the given updates to the IndexId value that they map to. This method is used in an edge case of removing a SnapshotDeletionsInProgress.Entry from the cluster state at the end of a delete. If the delete removed the last use of a certain IndexId from the repository then we do not want to reuse that IndexId because the implementation of BlobStoreRepository assumes that a given IndexId will never be reused if it went from referenced to unreferenced in the RepositoryData in a delete.

Parameters:

updates - map of existing IndexId to updated IndexId

Returns:

a new instance with updated index ids or this instance if unchanged

withClones

public SnapshotsInProgress.Entry withClones(Map<RepositoryShardId,SnapshotsInProgress.ShardSnapshotStatus> updatedClones)

abort

@Nullable
public SnapshotsInProgress.Entry abort()

Create a new instance by aborting this instance. Moving all in-progress shards to SnapshotsInProgress.ShardState.ABORTED if assigned to a data node or to SnapshotsInProgress.ShardState.FAILED if not assigned to any data node. If the instance had no in-progress shard snapshots assigned to data nodes it's moved to state SnapshotsInProgress.State.SUCCESS, otherwise it's moved to state SnapshotsInProgress.State.ABORTED. In the special case where this instance has not yet made any progress on any shard this method just returns null since no abort is needed and the snapshot can simply be removed from the cluster state outright.

Returns:

aborted snapshot entry or null if entry can be removed from the cluster state directly

withShardStates

public SnapshotsInProgress.Entry withShardStates(Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards)

Create a new instance that has its shard assignments replaced by the given shard assignment map. If the given shard assignments show all shard snapshots in a completed state then the returned instance will be of state SnapshotsInProgress.State.SUCCESS, otherwise the state remains unchanged.

Parameters:

shards - new shard snapshot states

Returns:

new snapshot entry

withStartedShards

public SnapshotsInProgress.Entry withStartedShards(Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards)

Same as withShardStates(java.util.Map<org.elasticsearch.index.shard.ShardId, org.elasticsearch.cluster.SnapshotsInProgress.ShardSnapshotStatus>) but does not check if the snapshot completed and thus is only to be used when starting new shard snapshots on data nodes for a running snapshot.

repository

public String repository()

Description copied from interface: RepositoryOperation

Name of the repository affected.

Specified by:

repository in interface RepositoryOperation

snapshot

public Snapshot snapshot()

shardsByRepoShardId

public Map<RepositoryShardId,SnapshotsInProgress.ShardSnapshotStatus> shardsByRepoShardId()

indexByName

public Index indexByName(String name)

shards

public Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards()

shardId

public ShardId shardId(RepositoryShardId repositoryShardId)

state

public SnapshotsInProgress.State state()

indices

public Map<String,IndexId> indices()

includeGlobalState

public boolean includeGlobalState()

userMetadata

public Map<String,Object> userMetadata()

partial

public boolean partial()

startTime

public long startTime()

dataStreams

public List<String> dataStreams()

featureStates

public List<SnapshotFeatureInfo> featureStates()

repositoryStateId

public long repositoryStateId()

Description copied from interface: RepositoryOperation

The repository state id at the time the operation began.

Specified by:

repositoryStateId in interface RepositoryOperation

failure

public String failure()

version

public Version version()

What version of metadata to use for the snapshot in the repository

source

@Nullable
public SnapshotId source()

isClone

public boolean isClone()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

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

isFragment

public boolean isFragment()

Specified by:

isFragment in interface ToXContent