ShardSnapshotState (controller-docs 2.0.1 API)

java.lang.Object
- org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState

All Implemented Interfaces:

Serializable, Snapshot.State
```
public class ShardSnapshotState
extends Object
implements Snapshot.State
```
Encapsulates the snapshot State for a Shard.

Author:

Thomas Pantelis

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`ShardSnapshotState(@NonNull ShardDataTreeSnapshot snapshot)`
`ShardSnapshotState(@NonNull ShardDataTreeSnapshot snapshot, boolean migrated)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`@NonNull ShardDataTreeSnapshot`	`getSnapshot()`
`boolean`	`needsMigration()`	Indicate whether the snapshot requires migration, i.e.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ShardSnapshotState
```
public ShardSnapshotState(@NonNull ShardDataTreeSnapshot snapshot,
                          boolean migrated)
```
  - ShardSnapshotState
```
public ShardSnapshotState(@NonNull ShardDataTreeSnapshot snapshot)
```
- Method Detail
  - getSnapshot
```
public @NonNull ShardDataTreeSnapshot getSnapshot()
```
  - needsMigration
```
public boolean needsMigration()
```
    Description copied from interface: Snapshot.State
    
    Indicate whether the snapshot requires migration, i.e. a new snapshot should be created after recovery. Default implementation returns false, i.e. do not re-snapshot.
    
    Specified by:
    
    needsMigration in interface Snapshot.State
    
    Returns:
    
    True if complete recovery based upon this snapshot should trigger a new snapshot.