Interface ISnapshot

Snapshots API.

Namespace: GridGain.Core.PersistentStore

Assembly: GridGain.Core.dll

Syntax

public interface ISnapshot

Methods

CancelSnapshotOperationAsync(IgniteGuid, String)

Cancels the snapshot operation.

Declaration

Task<bool> CancelSnapshotOperationAsync(IgniteGuid operationId, string message)

Parameters

Type	Name	Description
IgniteGuid	operationId	The operation identifier.
System.String	message	Optional message (see Message).

Returns

Type	Description
Task<System.Boolean>	Task for the operation.

CheckSnapshotAsync(Int64, IEnumerable<String>, Boolean, String)

Checks the snapshot for issues.

Declaration

ISnapshotTask<ICollection<ISnapshotIssue>> CheckSnapshotAsync(long snapshotId, IEnumerable<string> optionalSearchPaths, bool skipCrc, string message)

Parameters

Type	Name	Description
System.Int64	snapshotId	The snapshot identifier.
IEnumerable<System.String>	optionalSearchPaths	The optional search paths.
System.Boolean	skipCrc	Whether to skip CRC check.
System.String	message	Optional message (see Message).

Returns

Type	Description
ISnapshotTask<ICollection<ISnapshotIssue>>	Task for the operation.

CreateFullSnapshotAsync(IEnumerable<String>, String)

Initiates full snapshot creation. All updates completed before this call returns are guaranteed to be included to the created snapshot.There are no guarantees regarding the updates completed after this method returns but before resulting completes.

Declaration

ISnapshotTask<bool> CreateFullSnapshotAsync(IEnumerable<string> cacheNames, string message)

Parameters

Type	Name	Description
IEnumerable<System.String>	cacheNames	Names of caches to be included in the snapshot.
System.String	message	Optional message (see Message).

Returns

Type	Description
ISnapshotTask<System.Boolean>	Task for async operation.

CreateSnapshotAsync(IEnumerable<String>, String)

Initiates incremental snapshot creation, when possible; otherwise full snapshot. All updates completed before this call returns are guaranteed to be included to the created snapshot.There are no guarantees regarding the updates completed after this method returns but before resulting completes.

Declaration

ISnapshotTask<bool> CreateSnapshotAsync(IEnumerable<string> cacheNames, string message)

Parameters

Type	Name	Description
IEnumerable<System.String>	cacheNames	Names of caches to be included in the snapshot.
System.String	message	Optional message (see Message).

Returns

Type	Description
ISnapshotTask<System.Boolean>	Task for async operation.

DeleteSnapshotAsync(Int64, String)

Deletes the snapshot. Will fail if there are dependent snapshots.

Declaration

ISnapshotTask DeleteSnapshotAsync(long snapshotId, string message)

Parameters

Type	Name	Description
System.Int64	snapshotId	The snapshot identifier.
System.String	message	Optional message (see Message).

Returns

Type	Description
ISnapshotTask	Task for the operation.

ForceDeleteSnapshotAsync(Int64, String)

Deletes the snapshot and all dependent snapshots.

Declaration

ISnapshotTask ForceDeleteSnapshotAsync(long snapshotId, string message)

Parameters

Type	Name	Description
System.Int64	snapshotId	The snapshot identifier.
System.String	message	Optional message (see Message).

Returns

Type	Description
ISnapshotTask	Task for the operation.

ForceMoveSnapshotAsync(Int64, String, String)

Moves the snapshot to the specified path and removes locally, including all dependent snapshots.

Declaration

ISnapshotTask ForceMoveSnapshotAsync(long snapshotId, string destinationPath, string message)

Parameters

Type	Name	Description
System.Int64	snapshotId	The snapshot identifier.
System.String	destinationPath	The destination path.
System.String	message	Optional message (see Message).

Returns

Type	Description
ISnapshotTask	Task for the operation.

GetCurrentSnapshotStatus()

Gets the current snapshot operation status.

Declaration

ISnapshotStatus GetCurrentSnapshotStatus()

Returns

Type	Description
ISnapshotStatus

GetSnapshot(Int64, IEnumerable<String>)

Gets the snapshot by id.

Declaration

ISnapshotInfo GetSnapshot(long snapshotId, IEnumerable<string> optionalSearchPaths)

Parameters

Type	Name	Description
System.Int64	snapshotId	The snapshot identifier.
IEnumerable<System.String>	optionalSearchPaths	The optional search paths.

Returns

Type	Description
ISnapshotInfo	Snapshot information.

GetSnapshots(IEnumerable<String>)

Gets all previously created snapshots.

Declaration

ICollection<ISnapshotInfo> GetSnapshots(IEnumerable<string> optionalSearchPaths)

Parameters

Type	Name	Description
IEnumerable<System.String>	optionalSearchPaths	The optional search paths.

Returns

Type	Description
ICollection<ISnapshotInfo>	Snapshot information.

MoveSnapshotAsync(Int64, String, String)

Moves the snapshot to the specified path and removes locally. Fails if there are dependent snapshots, use ForceMoveSnapshotAsync(Int64, String, String) instead.

Declaration

ISnapshotTask MoveSnapshotAsync(long snapshotId, string destinationPath, string message)

Parameters

Type	Name	Description
System.Int64	snapshotId	The snapshot identifier.
System.String	destinationPath	The destination path.
System.String	message	Optional message (see Message).

Returns

Type	Description
ISnapshotTask	Task for the operation.

RestoreSnapshotAsync(Int64, IEnumerable<String>, IEnumerable<String>, String)

Restores the snapshot by id.

Declaration

ISnapshotTask RestoreSnapshotAsync(long snapshotId, IEnumerable<string> optionalSearchPaths, IEnumerable<string> cacheNames, string message)

Parameters

Type	Name	Description
System.Int64	snapshotId	The snapshot identifier.
IEnumerable<System.String>	optionalSearchPaths	The optional search paths.
IEnumerable<System.String>	cacheNames	The cache names.
System.String	message	Optional message (see Message).

Returns

Type	Description
ISnapshotTask	Task for the operation.