SnapshotConfiguration (GridGain 8.9.14)

java.lang.Object
- org.gridgain.grid.configuration.SnapshotConfiguration

```
public class SnapshotConfiguration
extends Object
```
GridGain snapshot configuration. When set, enables snapshot.

Field Summary

Fields
Modifier and Type	Field and Description
`static org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption`	`DEFAULT_COMPRESSION` Default value for snapshot's compression option.
`static int`	`DEFAULT_COMPRESSION_LEVEL` Default snapshot operation creation compression level.
`static int`	`DEFAULT_COMPRESSION_LEVEL_PARAMETER` Default snapshot operation creation compression level. -1 Means turned off by default.
`static boolean`	`DEFAULT_EXCHANGELESS_SNAPSHOT` Default mode for exchange triggering on snapshot creation.
`static int`	`DEFAULT_RESTORE_OPERATION_PARALLELISM` Default snapshot restore operation parallelism level.
`static int`	`DEFAULT_SNAPSHOT_OPERATION_PARALLELISM` Default snapshot operation parallelism level.
`static long`	`DEFAULT_SNAPSHOT_PROGRESS_THROTTLING_TIME` Default snapshot progress throttling time.
`static boolean`	`DFLT_PITR_ENABLED` Default snapshot progress throttling time.
`static String`	`DFLT_SNAPSHOTS_PATH` Default snapshot path.

Constructor Summary

Constructors
Constructor and Description

SnapshotConfiguration()

SnapshotConfiguration(SnapshotConfiguration other)

Constructors
Constructor and Description
`SnapshotConfiguration()`
`SnapshotConfiguration(SnapshotConfiguration other)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getCompressionLevel()` Compression level.
`org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption`	`getCompressionOption()`
`MessageDigestFactory`	`getMessageDigestFactory()`
`SnapshotRegistryTransformer`	`getRegistryTransformer()`
`int`	`getRestoreOperationParallelism()` Snapshot restore operation parallelism level.
`SftpConfiguration`	`getSftpConfiguration()`
`int`	`getSnapshotOperationParallelism()` Snapshot Operation parallelism level.
`long`	`getSnapshotProgressThrottlingInterval()`
`SnapshotsCatalogConnectorConfiguration`	`getSnapshotsCatalogConnectorConfiguration()` Deprecated. Snapshot Catalog functionality was removed from GridGain completely as obsolete. Providing configuration for Catalog Connectior won't have any effect.
`String`	`getSnapshotsPath()` Gets database snapshot SPI.
`boolean`	`isCompressionCodecSupported(org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption compressionCodec)` Checks whether given compression codec is supported by this configuration.
`boolean`	`isPointInTimeRecoveryEnabled()` Deprecated. See `setPointInTimeRecoveryEnabled(boolean)`.
`SnapshotConfiguration`	`setCompressionLevel(int compressionLevel)`
`SnapshotConfiguration`	`setCompressionOption(org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption compressionOption)`
`SnapshotConfiguration`	`setMessageDigestFactory(MessageDigestFactory msgDigestFactory)` Allows to plug in a custom factory of `MessageDigest` objects to control the integrity of snapshot files.
`SnapshotConfiguration`	`setPointInTimeRecoveryEnabled(boolean pointInTimeRecoveryEnabled)` Deprecated. Use control.sh/.bat '--property' command to set 'pointInTimeRecoveryEnabled' property cluster-wide.
`SnapshotConfiguration`	`setRegistryTransformer(SnapshotRegistryTransformer snapshotRegistryTransformer)` Allows to plug in custom transformer for snapshot file registry to enable its authenticity.
`SnapshotConfiguration`	`setRestoreOperationParallelism(int restoreOperationParallelism)`
`SnapshotConfiguration`	`setSftpConfiguration(SftpConfiguration sftpConfiguration)` Allows to use sftp storage in snapshot commands.
`SnapshotConfiguration`	`setSnapshotOperationParallelism(int snapshotOperationParallelism)`
`SnapshotConfiguration`	`setSnapshotProgressThrottlingInterval(long snapshotProgressThrottlingInterval)` Set time in ms which would be used to update snapshot operation progress (progress couldn't be updated more often) -1 means that throttling would turn off
`SnapshotConfiguration`	`setSnapshotsCatalogConnectorConfiguration(SnapshotsCatalogConnectorConfiguration catalogCfg)` Deprecated. Snapshot Catalog functionality was removed from GridGain completely as obsolete. Providing configuration for Catalog Connectior won't have any effect.
`SnapshotConfiguration`	`setSnapshotsPath(String snapshotsPath)` Sets database snapshot SPI.
`void`	`setSupportedCompressionCodecs(EnumSet<org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption> supportedCompressionCodecs)` Sets collection of supported compression codecs.
`String`	`toString()`

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

- Field Detail
  - DFLT_SNAPSHOTS_PATH
```
public static final String DFLT_SNAPSHOTS_PATH
```
    Default snapshot path.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SNAPSHOT_PROGRESS_THROTTLING_TIME
```
public static final long DEFAULT_SNAPSHOT_PROGRESS_THROTTLING_TIME
```
    Default snapshot progress throttling time.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMPRESSION
```
public static final org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption DEFAULT_COMPRESSION
```
    Default value for snapshot's compression option.
  - DEFAULT_SNAPSHOT_OPERATION_PARALLELISM
```
public static final int DEFAULT_SNAPSHOT_OPERATION_PARALLELISM
```
    Default snapshot operation parallelism level.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RESTORE_OPERATION_PARALLELISM
```
public static final int DEFAULT_RESTORE_OPERATION_PARALLELISM
```
    Default snapshot restore operation parallelism level.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMPRESSION_LEVEL_PARAMETER
```
public static final int DEFAULT_COMPRESSION_LEVEL_PARAMETER
```
    Default snapshot operation creation compression level. -1 Means turned off by default.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMPRESSION_LEVEL
```
public static final int DEFAULT_COMPRESSION_LEVEL
```
    Default snapshot operation creation compression level.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EXCHANGELESS_SNAPSHOT
```
public static final boolean DEFAULT_EXCHANGELESS_SNAPSHOT
```
    Default mode for exchange triggering on snapshot creation.
    
    See Also:
    
    Constant Field Values
  - DFLT_PITR_ENABLED
```
public static final boolean DFLT_PITR_ENABLED
```
    Default snapshot progress throttling time.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SnapshotConfiguration
```
public SnapshotConfiguration()
```
  - SnapshotConfiguration
```
public SnapshotConfiguration(SnapshotConfiguration other)
```
    Parameters:
    
    other - Snapshot configuration to copy from.
- Method Detail
  - getSnapshotsPath
```
public String getSnapshotsPath()
```
    Gets database snapshot SPI. If not set, default will be used.
    
    Returns:
    
    Database snapshot SPI.
  - setSnapshotsPath
```
public SnapshotConfiguration setSnapshotsPath(String snapshotsPath)
```
    Sets database snapshot SPI.
    
    Parameters:
    
    snapshotsPath - Snapshots path.
    
    Returns:
    
    this for chaining.
  - getSnapshotsCatalogConnectorConfiguration
```
@Deprecated
public SnapshotsCatalogConnectorConfiguration getSnapshotsCatalogConnectorConfiguration()
```
    Deprecated. Snapshot Catalog functionality was removed from GridGain completely as obsolete. Providing configuration for Catalog Connectior won't have any effect.
    
    Returns:
    
    Connector configuration on null if snapshots catalog disabled.
  - setSnapshotsCatalogConnectorConfiguration
```
@Deprecated
public SnapshotConfiguration setSnapshotsCatalogConnectorConfiguration(SnapshotsCatalogConnectorConfiguration catalogCfg)
```
    Deprecated. Snapshot Catalog functionality was removed from GridGain completely as obsolete. Providing configuration for Catalog Connectior won't have any effect.
    
    Parameters:
    
    catalogCfg - New connector configuration.
    
    Returns:
    
    this for chaining.
  - getSnapshotProgressThrottlingInterval
```
public long getSnapshotProgressThrottlingInterval()
```
    Returns:
    
    time in ms which would be used to update snapshot operation progress (progress couldn't be updated more often) -1 means that throttling is turned off
  - setSnapshotProgressThrottlingInterval
```
public SnapshotConfiguration setSnapshotProgressThrottlingInterval(long snapshotProgressThrottlingInterval)
```
    Set time in ms which would be used to update snapshot operation progress (progress couldn't be updated more often) -1 means that throttling would turn off
    
    Parameters:
    
    snapshotProgressThrottlingInterval - Snapshot progress throttling time.
  - isPointInTimeRecoveryEnabled
```
@Deprecated
public boolean isPointInTimeRecoveryEnabled()
```
    Deprecated. See setPointInTimeRecoveryEnabled(boolean).
    
    Returns:
    
    True If point-in-time enable.
  - setPointInTimeRecoveryEnabled
```
@Deprecated
public SnapshotConfiguration setPointInTimeRecoveryEnabled(boolean pointInTimeRecoveryEnabled)
```
    Deprecated. Use control.sh/.bat '--property' command to set 'pointInTimeRecoveryEnabled' property cluster-wide.
    
    Parameters:
    
    pointInTimeRecoveryEnabled - True for enable point-in-time.
  - getCompressionOption
```
public org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption getCompressionOption()
```
    Returns:
    
    Compression options for snapshot files. Default is NONE.
  - setCompressionOption
```
public SnapshotConfiguration setCompressionOption(org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption compressionOption)
```
    Parameters:
    
    compressionOption - Set compression option options for snapshot files.
  - getSnapshotOperationParallelism
```
public int getSnapshotOperationParallelism()
```
    Snapshot Operation parallelism level.
    
    Returns:
    
    Level of parallelism for snapshot operation. Default is DEFAULT_SNAPSHOT_OPERATION_PARALLELISM.
  - setSnapshotOperationParallelism
```
public SnapshotConfiguration setSnapshotOperationParallelism(int snapshotOperationParallelism)
```
    Parameters:
    
    snapshotOperationParallelism - Level of parallelism for snapshot operation.
  - getRestoreOperationParallelism
```
public int getRestoreOperationParallelism()
```
    Snapshot restore operation parallelism level.
    
    Returns:
    
    Level of parallelism for snapshot restore operation. Default is DEFAULT_RESTORE_OPERATION_PARALLELISM.
  - setRestoreOperationParallelism
```
public SnapshotConfiguration setRestoreOperationParallelism(int restoreOperationParallelism)
```
    Parameters:
    
    restoreOperationParallelism - Level of parallelism for snapshot restore operation.
  - getCompressionLevel
```
public int getCompressionLevel()
```
    Compression level.
    
    Returns:
    
    Level of compresssion for snapshot creation. Default is best speed.
  - setCompressionLevel
```
public SnapshotConfiguration setCompressionLevel(int compressionLevel)
```
    Parameters:
    
    compressionLevel - Level of compression for snapshot creation.
  - setMessageDigestFactory
```
public SnapshotConfiguration setMessageDigestFactory(MessageDigestFactory msgDigestFactory)
```
    Allows to plug in a custom factory of MessageDigest objects to control the integrity of snapshot files. This setting is utilized only when proper SnapshotSecurityLevel is set. Default is null and indicates that a SHA-512 digest algorithm will be used under the hood.
    
    Parameters:
    
    msgDigestFactory - Factory of MessageDigest objects.
    
    Returns:
    
    this for chaining.
  - getMessageDigestFactory
```
public MessageDigestFactory getMessageDigestFactory()
```
    Returns:
    
    Factory of MessageDigest objects to control the integrity of snapshot files.
  - setRegistryTransformer
```
public SnapshotConfiguration setRegistryTransformer(SnapshotRegistryTransformer snapshotRegistryTransformer)
```
    Allows to plug in custom transformer for snapshot file registry to enable its authenticity. This setting is utilized only when proper SnapshotSecurityLevel is set. Default is null and indicates that no provisions will be made for authenticity.
    
    Parameters:
    
    snapshotRegistryTransformer - Snapshot file registry transformer.
    
    Returns:
    
    this for chaining.
  - getRegistryTransformer
```
public SnapshotRegistryTransformer getRegistryTransformer()
```
    Returns:
    
    Snapshot file registry transformer.
  - setSftpConfiguration
```
public SnapshotConfiguration setSftpConfiguration(SftpConfiguration sftpConfiguration)
```
    Allows to use sftp storage in snapshot commands.
    
    Parameters:
    
    sftpConfiguration - SFTP storage configuration.
    
    Returns:
    
    this for chaining.
  - getSftpConfiguration
```
public SftpConfiguration getSftpConfiguration()
```
    Returns:
    
    SFTP configuration.
  - setSupportedCompressionCodecs
```
public void setSupportedCompressionCodecs(EnumSet<org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption> supportedCompressionCodecs)
```
    Sets collection of supported compression codecs.
    
    Parameters:
    
    supportedCompressionCodecs - Set of supported codecs.
  - isCompressionCodecSupported
```
public boolean isCompressionCodecSupported(org.gridgain.grid.internal.processors.cache.database.snapshot.CompressionOption compressionCodec)
```
    Checks whether given compression codec is supported by this configuration.
    
    Parameters:
    
    compressionCodec - Compression codec.
    
    Returns:
    
    True if the codec enabled by the configuration, else False.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SnapshotConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DFLT_SNAPSHOTS_PATH

DEFAULT_SNAPSHOT_PROGRESS_THROTTLING_TIME

DEFAULT_COMPRESSION

DEFAULT_SNAPSHOT_OPERATION_PARALLELISM

DEFAULT_RESTORE_OPERATION_PARALLELISM

DEFAULT_COMPRESSION_LEVEL_PARAMETER

DEFAULT_COMPRESSION_LEVEL

DEFAULT_EXCHANGELESS_SNAPSHOT

DFLT_PITR_ENABLED

Constructor Detail

SnapshotConfiguration

SnapshotConfiguration

Method Detail

getSnapshotsPath

setSnapshotsPath

getSnapshotsCatalogConnectorConfiguration

setSnapshotsCatalogConnectorConfiguration

getSnapshotProgressThrottlingInterval

setSnapshotProgressThrottlingInterval

isPointInTimeRecoveryEnabled

setPointInTimeRecoveryEnabled

getCompressionOption

setCompressionOption

getSnapshotOperationParallelism

setSnapshotOperationParallelism

getRestoreOperationParallelism

setRestoreOperationParallelism

getCompressionLevel

setCompressionLevel

setMessageDigestFactory

getMessageDigestFactory

setRegistryTransformer

getRegistryTransformer

setSftpConfiguration

getSftpConfiguration

setSupportedCompressionCodecs

isCompressionCodecSupported

toString