org.apache.kudu.client

Class KuduScanToken.KuduScanTokenBuilder

java.lang.Object

org.apache.kudu.client.AbstractKuduScannerBuilder<KuduScanToken.KuduScanTokenBuilder,List<KuduScanToken>>

org.apache.kudu.client.KuduScanToken.KuduScanTokenBuilder

Enclosing class:

KuduScanToken

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public static class KuduScanToken.KuduScanTokenBuilder
extends AbstractKuduScannerBuilder<KuduScanToken.KuduScanTokenBuilder,List<KuduScanToken>>

Builds a sequence of scan tokens.

Method Summary

Modifier and Type	Method and Description
List<KuduScanToken>	build()
KuduScanToken.KuduScanTokenBuilder	includeTableMetadata(boolean includeMetadata) If the table metadata is included on the scan token a GetTableSchema RPC call to the master can be avoided when deserializing each scan token into a scanner.
KuduScanToken.KuduScanTokenBuilder	includeTabletMetadata(boolean includeMetadata) If the tablet metadata is included on the scan token a GetTableLocations RPC call to the master can be avoided when scanning with a scanner constructed from a scan token.
KuduScanToken.KuduScanTokenBuilder	setSplitSizeBytes(long splitSizeBytes) Sets the data size of key range.
KuduScanToken.KuduScanTokenBuilder	setTimeout(long timeoutMs) Sets a timeout value to use when building the list of scan tokens.

Methods inherited from class org.apache.kudu.client.AbstractKuduScannerBuilder

addColumnRangePredicate, addColumnRangePredicatesRaw, addPredicate, batchSizeBytes, cacheBlocks, exclusiveUpperBound, exclusiveUpperBoundRaw, keepAlivePeriodMs, limit, lowerBound, lowerBoundRaw, prefetching, readMode, replicaSelection, scanRequestTimeout, setFaultTolerant, setProjectedColumnIndexes, setProjectedColumnNames, snapshotTimestampMicros

Methods inherited from class java.lang.Object

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

Method Detail

setTimeout

public KuduScanToken.KuduScanTokenBuilder setTimeout(long timeoutMs)

Sets a timeout value to use when building the list of scan tokens. If unset, the client operation timeout will be used.

Parameters:

timeoutMs - the timeout in milliseconds.

setSplitSizeBytes

public KuduScanToken.KuduScanTokenBuilder setSplitSizeBytes(long splitSizeBytes)

Sets the data size of key range. It is used to split tablet's primary key range into smaller ranges. The split doesn't change the layout of the tablet. This is a hint: The tablet server may return the size of key range larger or smaller than this value. If unset or <= 0, the key range includes all the data of the tablet.

Parameters:

splitSizeBytes - the data size of key range.

includeTableMetadata

public KuduScanToken.KuduScanTokenBuilder includeTableMetadata(boolean includeMetadata)

If the table metadata is included on the scan token a GetTableSchema RPC call to the master can be avoided when deserializing each scan token into a scanner.

Parameters:

includeMetadata - true, if table metadata should be included.

includeTabletMetadata

public KuduScanToken.KuduScanTokenBuilder includeTabletMetadata(boolean includeMetadata)

If the tablet metadata is included on the scan token a GetTableLocations RPC call to the master can be avoided when scanning with a scanner constructed from a scan token.

Parameters:

includeMetadata - true, if tablet metadata should be included.

build

public List<KuduScanToken> build()

Specified by:

build in class AbstractKuduScannerBuilder<KuduScanToken.KuduScanTokenBuilder,List<KuduScanToken>>