oracle.kv

## Class StoreIteratorConfig

- java.lang.Object
- - oracle.kv.StoreIteratorConfig

-     public class StoreIteratorConfig
      extends Object

  The configuration object for `KVStore.storeIterator(Direction, int, Key, KeyRange, Depth, Consistency, long, TimeUnit, StoreIteratorConfig)`.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `StoreIteratorConfig()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `getMaxConcurrentRequests()` Returns the maximum number of concurrent requests.
    `int` | `getMaxResultsBatches()` Returns the maximum number of results batches that can be held in the NoSQL Database client process.
    `StoreIteratorConfig` | `setMaxConcurrentRequests(int maxConcurrentRequests)` Sets the maximum degree of parallelism (in effect the maximum number of client-side threads) to be used when running a parallel store iteration.
    `StoreIteratorConfig` | `setMaxResultsBatches(int maxResultsBatches)` Specifies the maximum number of results batches that can be held in the NoSQL Database client process before processing on the Replication Node pauses.
    `String` | `toString()`

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

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

- - ### Constructor Detail

    - #### StoreIteratorConfig

          public StoreIteratorConfig()

  - ### Method Detail

    - #### setMaxConcurrentRequests

          public StoreIteratorConfig setMaxConcurrentRequests(int maxConcurrentRequests)

      Sets the maximum degree of parallelism (in effect the maximum number of client-side threads) to be used when running a parallel store iteration. Setting maxConcurrentRequests to 1 causes the store iteration to be performed using only the current thread. Setting it to 0 lets the KV Client determine the number of threads based on topology information (up to a maximum of the number of available processors as returned by java.lang.Runtime.availableProcessors()). Values less than 0 are reserved for some future use and cause an IllegalArgumentException to be thrown.
      Parameters:
        `maxConcurrentRequests` - the maximum number of client-side threads.
      Returns:
        this
      Throws:
        `IllegalArgumentException` - if a value less than 0 is passed for maxConcurrentRequests.
      See Also:
        `StoreIteratorMetrics`

    - #### getMaxConcurrentRequests

          public int getMaxConcurrentRequests()

      Returns the maximum number of concurrent requests.
      Returns:
        the maximum number of concurrent requests
      See Also:
        `StoreIteratorMetrics`

    - #### setMaxResultsBatches

          public StoreIteratorConfig setMaxResultsBatches(int maxResultsBatches)

      Specifies the maximum number of results batches that can be held in the NoSQL Database client process before processing on the Replication Node pauses. This ensures that client side memory is not exceeded if the client can't consume results as fast as they are generated by the Rep Nodes. The default value is the value of maxConcurrentRequests.
      Parameters:
        `maxResultsBatches` - the maximum number of results sets that can be held on the client side before Replication Node processing pauses.
      Returns:
        this
      See Also:
        `StoreIteratorMetrics`

    - #### getMaxResultsBatches

          public int getMaxResultsBatches()

      Returns the maximum number of results batches that can be held in the NoSQL Database client process.
      Returns:
        the maximum number of results batches that can be held in the NoSQL Database client process.
      See Also:
        `StoreIteratorMetrics`

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright (c) 2011, 2014 Oracle and/or its affiliates. All rights reserved.