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)
Creates a
TableIteratorOptions with the specified parameters. |
TableIteratorOptions(Direction direction,
Consistency consistency,
long timeout,
TimeUnit timeoutUnit,
int maxConcurrentRequests,
int batchResultsSize,
int maxResultsBatches)
Deprecated.
since 3.4, no longer supported.
replaced by
TableIteratorOptions(Direction, Consistency, long,
TimeUnit, int, int) |
Modifier and Type | Method and Description |
---|---|
Direction |
getDirection()
Returns the direction.
|
int |
getMaxConcurrentRequests()
Returns the maximum number of concurrent requests.
|
int |
getMaxResultsBatches()
Deprecated.
since 3.4, no longer supported.
Returns the value set by deprecated TableIteratorOptions constructor.
|
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)
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)
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.
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 requestIllegalArgumentException
- if direction is null, the timeout
is negative, timeout is > 0 and timeoutUnit is null, or if
maxConcurrentRequests or maxResultsSize is less
than 0.@Deprecated public TableIteratorOptions(Direction direction, Consistency consistency, long timeout, TimeUnit timeoutUnit, int maxConcurrentRequests, int batchResultsSize, int maxResultsBatches)
TableIteratorOptions(Direction, Consistency, long,
TimeUnit, int, int)
public Direction getDirection()
public int getMaxConcurrentRequests()
public int getResultsBatchSize()
@Deprecated public int getMaxResultsBatches()
Copyright (c) 2011, 2017 Oracle and/or its affiliates. All rights reserved.