Package org.apache.ignite.dump

## Class DumpReaderConfiguration

- java.lang.Object
- - org.apache.ignite.dump.DumpReaderConfiguration

-     public class DumpReaderConfiguration
      extends Object

  Configuration class of `DumpReader`.
  See Also:
    `DumpReader`, `DumpConsumer`

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `static int` | `DFLT_THREAD_CNT` | Default thread count.
    `static Duration` | `DFLT_TIMEOUT` | Default timeout.

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `DumpReaderConfiguration​(@Nullable String name, @Nullable String path, @Nullable IgniteConfiguration cfg, DumpConsumer cnsmr, int thCnt, Duration timeout, boolean failFast, boolean keepBinary, boolean keepRaw, String[] grpNames, String[] cacheNames, boolean skipCopies, EncryptionSpi encSpi)` |
    `DumpReaderConfiguration​(String name, @Nullable String path, @Nullable IgniteConfiguration cfg, DumpConsumer cnsmr)` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `String[]` | `cacheNames()` |
    `@Nullable IgniteConfiguration` | `config()` |
    `DumpConsumer` | `consumer()` |
    `@Nullable String` | `dumpName()` |
    `@Nullable String` | `dumpRoot()` |
    `EncryptionSpi` | `encryptionSpi()` |
    `boolean` | `failFast()` |
    `String[]` | `groupNames()` |
    `boolean` | `keepBinary()` | Actual only if `keepRaw` is `false`.
    `boolean` | `keepRaw()` |
    `boolean` | `skipCopies()` |
    `int` | `threadCount()` |
    `Duration` | `timeout()` |

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### DFLT_TIMEOUT

          public static final Duration DFLT_TIMEOUT

      Default timeout.

    - #### DFLT_THREAD_CNT

          public static final int DFLT_THREAD_CNT

      Default thread count.
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### DumpReaderConfiguration

          public DumpReaderConfiguration​(String name,
                                         @Nullable
                                         @Nullable String path,
                                         @Nullable
                                         @Nullable IgniteConfiguration cfg,
                                         DumpConsumer cnsmr)

      Parameters:
        `name` - Optional dump name.
        `path` - Optional path to the dump directory.
        `cfg` - Ignite configuration to resolve standart paths.
        `cnsmr` - Dump consumer.

    - #### DumpReaderConfiguration

          public DumpReaderConfiguration​(@Nullable
                                         @Nullable String name,
                                         @Nullable
                                         @Nullable String path,
                                         @Nullable
                                         @Nullable IgniteConfiguration cfg,
                                         DumpConsumer cnsmr,
                                         int thCnt,
                                         Duration timeout,
                                         boolean failFast,
                                         boolean keepBinary,
                                         boolean keepRaw,
                                         String[] grpNames,
                                         String[] cacheNames,
                                         boolean skipCopies,
                                         EncryptionSpi encSpi)

      Parameters:
        `name` - Optional dump name.
        `path` - Optional path to the dump directory.
        `cfg` - Ignite configuration to resolve standart paths.
        `cnsmr` - Dump consumer.
        `thCnt` - Count of threads to consume dumped partitions.
        `timeout` - Timeout of dump reader invocation.
        `failFast` - Stop processing partitions if consumer fail to process one.
        `keepBinary` - If `true` and if `keepRaw` is `false` then keeps `DumpEntry.key()` and `DumpEntry.value()` as `BinaryObject`.
        `keepRaw` - If `true`, doesn't deserialize cache data and keeps `DumpEntry.key()` as `KeyCacheObject` and `DumpEntry.value()` as `CacheObject`. If `true`, disables `keepBinary`.
        `grpNames` - Cache group names.
        `cacheNames` - Cache names.
        `skipCopies` - Skip copies.
        `encSpi` - Encryption SPI.

  - ### Method Detail

    - #### dumpName

          @Nullable
          public @Nullable String dumpName()

      Returns:
        Root dump name.

    - #### dumpRoot

          @Nullable
          public @Nullable String dumpRoot()

      Returns:
        Root dump directiory.

    - #### config

          @Nullable
          public @Nullable IgniteConfiguration config()

      Returns:
        Ignite configuration.

    - #### consumer

          public DumpConsumer consumer()

      Returns:
        Dump consumer instance.

    - #### threadCount

          public int threadCount()

      Returns:
        Count of threads to consume dumped partitions.

    - #### timeout

          public Duration timeout()

      Returns:
        Timeout of dump reader invocation.

    - #### failFast

          public boolean failFast()

      Returns:
        `True` if stop processing after first consumer error.

    - #### keepBinary

          public boolean keepBinary()

      Actual only if `keepRaw` is `false`.
      Returns:
        `True` if `DumpEntry.key()` and `DumpEntry.value()` are kept as `BinaryObject`.

    - #### keepRaw

          public boolean keepRaw()

      Returns:
        `True` if `DumpEntry.key()` and `DumpEntry.value()` are kept as `KeyCacheObject` and `CacheObject` respectively.

    - #### groupNames

          public String[] groupNames()

      Returns:
        Cache group names.

    - #### cacheNames

          public String[] cacheNames()

      Returns:
        Cache names.

    - #### skipCopies

          public boolean skipCopies()

      Returns:
        Skip copies.

    - #### encryptionSpi

          public EncryptionSpi encryptionSpi()

      Returns:
        Encryption SPI