Package com.apple.foundationdb.record
Class ExecuteProperties.Builder
- java.lang.Object
-
- com.apple.foundationdb.record.ExecuteProperties.Builder
-
- Enclosing class:
- ExecuteProperties
public static class ExecuteProperties.Builder extends Object
A builder forExecuteProperties
.ExecuteProperties.newBuilder().setSkip(s).setReturnedRowLimit(l).build()
-
-
Method Summary
-
-
-
Method Detail
-
setIsolationLevel
@Nonnull public ExecuteProperties.Builder setIsolationLevel(@Nonnull IsolationLevel isolationLevel)
-
getIsolationLevel
@Nonnull public IsolationLevel getIsolationLevel()
-
setSkip
@Nonnull public ExecuteProperties.Builder setSkip(int skip)
-
getSkip
public int getSkip()
-
setReturnedRowLimit
@Nonnull public ExecuteProperties.Builder setReturnedRowLimit(int rowLimit)
-
clearReturnedRowLimit
@Nonnull public ExecuteProperties.Builder clearReturnedRowLimit()
-
getReturnedRowLimit
public int getReturnedRowLimit()
-
getReturnedRowLimitOrMax
public int getReturnedRowLimitOrMax()
-
clearSkipAndAdjustLimit
@Nonnull public ExecuteProperties.Builder clearSkipAndAdjustLimit()
-
setTimeLimit
@Nonnull public ExecuteProperties.Builder setTimeLimit(long timeLimit)
-
clearTimeLimit
@Nonnull public ExecuteProperties.Builder clearTimeLimit()
-
getTimeLimit
public long getTimeLimit()
-
setScannedRecordsLimit
@Nonnull public ExecuteProperties.Builder setScannedRecordsLimit(int limit)
Set the limit on the number of records that may be scanned. Note that at most one ofscannedRecordsLimit
andexecuteState
may be set at the same time, since theExecuteState
contains a sharedRecordScanLimiter
.- Parameters:
limit
- the maximum number of records to scan- Returns:
- an updated builder
-
clearScannedRecordsLimit
@Nonnull public ExecuteProperties.Builder clearScannedRecordsLimit()
-
setScannedBytesLimit
@Nonnull public ExecuteProperties.Builder setScannedBytesLimit(long limit)
-
clearScannedBytesLimit
@Nonnull public ExecuteProperties.Builder clearScannedBytesLimit()
-
setState
@Nonnull public ExecuteProperties.Builder setState(@Nullable ExecuteState state)
-
clearState
@Nonnull public ExecuteProperties.Builder clearState()
-
setFailOnScanLimitReached
public ExecuteProperties.Builder setFailOnScanLimitReached(boolean failOnScanLimitReached)
Set how scan limit reached is handled. This setting has no effect ifsetScannedRecordsLimit(int)
is not also set.- Parameters:
failOnScanLimitReached
-true
to throw an exception,false
to return early- Returns:
- an updated builder
-
getDefaultCursorStreamingMode
public CursorStreamingMode getDefaultCursorStreamingMode()
Get the defaultCursorStreamingMode
for newScanProperties
.- Returns:
- the default streaming mode
-
setDefaultCursorStreamingMode
public ExecuteProperties.Builder setDefaultCursorStreamingMode(CursorStreamingMode defaultCursorStreamingMode)
Set the defaultCursorStreamingMode
for newScanProperties
.- Parameters:
defaultCursorStreamingMode
- default streaming mode- Returns:
- an updated builder
-
build
@Nonnull public ExecuteProperties build()
-
-