public class TableIteratorOptions extends ReadOptions
KVStoreConfig
.Constructor and Description |
---|
TableIteratorOptions(Direction direction,
Consistency consistency,
long timeout,
TimeUnit timeoutUnit)
Creates a
TableIteratorOptions with the specified parameters. |
TableIteratorOptions(Direction direction,
Consistency consistency,
long timeout,
TimeUnit timeoutUnit,
int maxConcurrentRequests,
int batchResultsSize,
int maxResultsBatches)
Creates a
TableIteratorOptions with the specified parameters. |
Modifier and Type | Method and Description |
---|---|
Direction |
getDirection()
Returns the direction.
|
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.
|
int |
getResultsBatchSize()
Returns the number of results per request.
|
getConsistency, getTimeout, getTimeoutUnit
public TableIteratorOptions(Direction direction, Consistency consistency, long timeout, TimeUnit timeoutUnit)
TableIteratorOptions
with the specified parameters.
Equivalent to
TableIteratorOptions(direction, consistency, timeout,
timeoutUnit, 0, 0, 0)
direction
- a directionconsistency
- the read consistency to use or nulltimeout
- the timeout value to usetimeoutUnit
- the TimeUnit
used by the
timeout
parameter or nullIllegalArgumentException
- if direction is null, the timeout
is negative or timeout is > 0 and timeoutUnit is nullpublic TableIteratorOptions(Direction direction, Consistency consistency, long timeout, TimeUnit timeoutUnit, int maxConcurrentRequests, int batchResultsSize, int maxResultsBatches)
TableIteratorOptions
with the specified parameters.
If consistency
is null
, the
default consistency
is used. If timeout
is zero the
default request timeout
is used.
maxConcurrentRequests
specifies the maximum degree of parallelism
(in effect the maximum number of client-side threads) to be used when
running an iteration. Setting maxConcurrentRequests
to 1 causes
the 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.
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.
direction
- a directionconsistency
- the read consistency to use or nulltimeout
- the timeout value to usetimeoutUnit
- the TimeUnit
used by the
timeout
parameter or nullmaxConcurrentRequests
- the maximum number of client-side threadsbatchResultsSize
- the number of results per requestmaxResultsBatches
- the maximum number of results sets that can be
held on the client sideIllegalArgumentException
- if direction is null, the timeout
is negative, timeout is > 0 and timeoutUnit is null, or if
maxConcurrentRequests, maxResultsSize, or maxResultsBatches is less
than 0.public Direction getDirection()
public int getMaxConcurrentRequests()
public int getResultsBatchSize()
public int getMaxResultsBatches()
Copyright (c) 2011, 2014 Oracle and/or its affiliates. All rights reserved.