org.gridgain.grid.persistentstore

Class RestoreSnapshotParams

java.lang.Object

org.gridgain.grid.persistentstore.RestoreSnapshotParams

public class RestoreSnapshotParams
extends Object

Parameters for restore snapshot operation.

Constructor Summary

Constructors

Constructor and Description
RestoreSnapshotParams()

Method Summary

Modifier and Type	Method and Description
@Nullable Set<String>	cacheNames() Collection of cache names to restore from this snapshot.
RestoreSnapshotParams	cacheNames(@Nullable Set<String> cacheNames) Sets collection of cache names to restore from this snapshot.
IgniteBiClosure<String,CacheConfiguration,CacheConfiguration>	conversionClosure()
RestoreSnapshotParams	conversionClosure(IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> conversionClosure) Sets closure for CacheConfiguration conversion during snapshot restore.
@Nullable Set<String>	excludedCacheNames() Collection of cache names excluded from this snapshot.
RestoreSnapshotParams	excludedCacheNames(@Nullable Set<String> excludedCacheNames) Sets collection of cache names excluded from this snapshot.
boolean	forceRestore()
RestoreSnapshotParams	forceRestore(boolean forceRestore) Sets flag indicating restore force: if newly created cache in group may be destroyed by this restore, default is false.
String	message()
RestoreSnapshotParams	message(String msg) Sets user message.
Collection<SnapshotPath>	optionalSearchPaths()
RestoreSnapshotParams	optionalSearchPaths(Collection<SnapshotPath> optSearchPaths) Sets Optional path to search for snapshots data.
Integer	parallelism()
RestoreSnapshotParams	parallelism(Integer parallelism) Sets parallelism level for snapshot restore operation.
long	snapshotId()
RestoreSnapshotParams	snapshotId(long snapshotId) Sets id of snapshot to restore.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreSnapshotParams

public RestoreSnapshotParams()

Method Detail

snapshotId

public long snapshotId()

Returns:

Snapshot id to restore.

snapshotId

public RestoreSnapshotParams snapshotId(long snapshotId)

Sets id of snapshot to restore. If a cache with the given name already exists, it will be destroyed and contents will be applied in-place. This operations (destroy and restore) are not atomic, so it is recommended to create a snapshot before restoring the data.

Parameters:

snapshotId - Id of snapshot to restore.

Returns:

RestoreSnapshotParams in builder style.

optionalSearchPaths

public Collection<SnapshotPath> optionalSearchPaths()

Returns:

Optional search snapshot paths.

optionalSearchPaths

public RestoreSnapshotParams optionalSearchPaths(Collection<SnapshotPath> optSearchPaths)

Sets Optional path to search for snapshots data. If a snapshot was moved to an external directory or was initially created in custom directory, this external directory may be specified in this parameter for a snapshot restore.

Parameters:

optSearchPaths - Optional search snapshot paths.

Returns:

RestoreSnapshotParams in builder style.

cacheNames

@Nullable
public @Nullable Set<String> cacheNames()

Collection of cache names to restore from this snapshot. If null, all saved caches will be restored.

Returns:

Collection of cache names to restore from this snapshot.

cacheNames

public RestoreSnapshotParams cacheNames(@Nullable
                                        @Nullable Set<String> cacheNames)

Sets collection of cache names to restore from this snapshot. If null, all saved caches will be restored.

Parameters:

cacheNames - Cache names to restore.

Returns:

RestoreSnapshotParams in builder style.

excludedCacheNames

@Nullable
public @Nullable Set<String> excludedCacheNames()

Collection of cache names excluded from this snapshot. If null, no caches will be excluded.

Returns:

Collection of cache names excluded from this snapshot.

excludedCacheNames

public RestoreSnapshotParams excludedCacheNames(@Nullable
                                                @Nullable Set<String> excludedCacheNames)

Sets collection of cache names excluded from this snapshot. If null, no caches will be excluded.

Parameters:

excludedCacheNames - Cache names excluded from restoring.

Returns:

RestoreSnapshotParams in builder style.

forceRestore

public boolean forceRestore()

Returns:

Flag indicating restore force.

forceRestore

public RestoreSnapshotParams forceRestore(boolean forceRestore)

Sets flag indicating restore force: if newly created cache in group may be destroyed by this restore, default is false.

Parameters:

forceRestore - Flag indicating restore force.

Returns:

RestoreSnapshotParams in builder style.

conversionClosure

public IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> conversionClosure()

Returns:

Closure for CacheConfiguration conversion during snapshot restore.

conversionClosure

public RestoreSnapshotParams conversionClosure(IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> conversionClosure)

Sets closure for CacheConfiguration conversion during snapshot restore.

Parameters:

conversionClosure - Closure for CacheConfiguration conversion during snapshot restore.

Returns:

RestoreSnapshotParams in builder style.

message

public String message()

Returns:

User message that will be printed out to the log and will be saved in snapshot catalog.

message

public RestoreSnapshotParams message(String msg)

Sets user message.

Parameters:

msg - User message.

Returns:

RestoreSnapshotParams in builder style.

parallelism

public Integer parallelism()

Returns:

Parallelism level for restore operation.

parallelism

public RestoreSnapshotParams parallelism(Integer parallelism)

Sets parallelism level for snapshot restore operation.

Parameters:

parallelism - Level of parallelism for restore operation.

Returns:

RestoreSnapshotParams in builder style.

toString

public String toString()

Overrides:

toString in class Object