com.aerospike.client.policy

Class ScanPolicy

java.lang.Object

com.aerospike.client.policy.Policy

com.aerospike.client.policy.ScanPolicy

public final class ScanPolicy
extends Policy

Container object for optional parameters used in scan operations.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	concurrentNodes Issue scan requests in parallel or serially.
boolean	failOnClusterChange Terminate scan if cluster in migration state.
boolean	includeBinData Indicates if bin data is retrieved.
int	maxConcurrentNodes Maximum number of concurrent requests to server nodes at any point in time.
int	scanPercent Percent of data to scan.

Fields inherited from class com.aerospike.client.policy.Policy

consistencyLevel, linearizeRead, maxRetries, priority, replica, sendKey, sleepBetweenRetries, socketTimeout, timeoutDelay, totalTimeout

Constructor Summary

Constructors

Constructor and Description
ScanPolicy() Default constructor.
ScanPolicy(ScanPolicy other) Copy scan policy from another scan policy.

Method Summary

Methods inherited from class com.aerospike.client.policy.Policy

setTimeout, setTimeouts

Methods inherited from class java.lang.Object

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

Field Detail

scanPercent

public int scanPercent

Percent of data to scan. Valid integer range is 1 to 100. Default is 100.

maxConcurrentNodes

public int maxConcurrentNodes

Maximum number of concurrent requests to server nodes at any point in time. If there are 16 nodes in the cluster and maxConcurrentNodes is 8, then scan requests will be made to 8 nodes in parallel. When a scan completes, a new scan request will be issued until all 16 nodes have been scanned.

This field is only relevant when concurrentNodes is true. Default (0) is to issue requests to all server nodes in parallel.

concurrentNodes

public boolean concurrentNodes

Issue scan requests in parallel or serially.

includeBinData

public boolean includeBinData

Indicates if bin data is retrieved. If false, only record digests (and user keys if stored on the server) are retrieved.

failOnClusterChange

public boolean failOnClusterChange

Terminate scan if cluster in migration state.

Constructor Detail

ScanPolicy

public ScanPolicy(ScanPolicy other)

Copy scan policy from another scan policy.

ScanPolicy

public ScanPolicy()

Default constructor.