ScanPolicy
    
            
            in package
            
        
    
    
    
`ScanPolicy` encapsulates optional parameters used in scan operations.
Table of Contents
Properties
- $exit_fast_on_exhausted_connection_pool : mixed
- $filter_expression : mixed
- $max_concurrent_nodes : mixed
- $max_records : mixed
- $max_retries : mixed
- $read_mode_ap : mixed
- $read_mode_sc : mixed
- $record_queue_size : mixed
- $send_key : mixed
- $sleep_multiplier : mixed
- $socket_timeout : mixed
- $total_timeout : mixed
- $use_compression : mixed
Methods
- __construct() : mixed
- getExitFastOnExhaustedConnectionPool() : bool
- getFilterExpression() : Expression|null
- getMaxConcurrentNodes() : int
- getMaxRecords() : int
- *************************************************************************** MultiPolicy Attrs ***************************************************************************
- getMaxRetries() : int
- *************************************************************************** ReadPolicy Attrs ***************************************************************************
- getReadModeAp() : ReadModeAP
- getReadModeSc() : ReadModeSC
- getRecordQueueSize() : int
- getSendKey() : bool
- getSleepMultiplier() : float
- getSocketTimeout() : int
- getTotalTimeout() : int
- getUseCompression() : bool
- setExitFastOnExhaustedConnectionPool() : mixed
- setFilterExpression() : mixed
- setMaxConcurrentNodes() : mixed
- setMaxRecords() : mixed
- setMaxRetries() : mixed
- setReadModeAp() : mixed
- setReadModeSc() : mixed
- setRecordQueueSize() : mixed
- setSendKey() : mixed
- setSleepMultiplier() : mixed
- setSocketTimeout() : mixed
- setTotalTimeout() : mixed
- setUseCompression() : mixed
Properties
$exit_fast_on_exhausted_connection_pool
    public
        mixed
    $exit_fast_on_exhausted_connection_pool
    
    
    
    
$filter_expression
    public
        mixed
    $filter_expression
    
    
    
    
$max_concurrent_nodes
    public
        mixed
    $max_concurrent_nodes
    
    
    
    
$max_records
    public
        mixed
    $max_records
    
    
    
    
$max_retries
    public
        mixed
    $max_retries
    
    
    
    
$read_mode_ap
    public
        mixed
    $read_mode_ap
    
    
    
    
$read_mode_sc
    public
        mixed
    $read_mode_sc
    
    
    
    
$record_queue_size
    public
        mixed
    $record_queue_size
    
    
    
    
$send_key
    public
        mixed
    $send_key
    
    
    
    
$sleep_multiplier
    public
        mixed
    $sleep_multiplier
    
    
    
    
$socket_timeout
    public
        mixed
    $socket_timeout
    
    
    
    
$total_timeout
    public
        mixed
    $total_timeout
    
    
    
    
$use_compression
    public
        mixed
    $use_compression
    
    
    
    
Methods
__construct()
    public
                    __construct() : mixed
    getExitFastOnExhaustedConnectionPool()
    public
                    getExitFastOnExhaustedConnectionPool() : bool
    Return values
boolgetFilterExpression()
    public
                    getFilterExpression() : Expression|null
    Return values
Expression|nullgetMaxConcurrentNodes()
    public
                    getMaxConcurrentNodes() : int
    Return values
intgetMaxRecords()
*************************************************************************** MultiPolicy Attrs ***************************************************************************
    public
                    getMaxRecords() : int
    Return values
intgetMaxRetries()
*************************************************************************** ReadPolicy Attrs ***************************************************************************
    public
                    getMaxRetries() : int
    Return values
intgetReadModeAp()
    public
                    getReadModeAp() : ReadModeAP
    Return values
ReadModeAPgetReadModeSc()
    public
                    getReadModeSc() : ReadModeSC
    Return values
ReadModeSCgetRecordQueueSize()
    public
                    getRecordQueueSize() : int
    Return values
intgetSendKey()
    public
                    getSendKey() : bool
    Return values
boolgetSleepMultiplier()
    public
                    getSleepMultiplier() : float
    Return values
floatgetSocketTimeout()
    public
                    getSocketTimeout() : int
    Return values
intgetTotalTimeout()
    public
                    getTotalTimeout() : int
    Return values
intgetUseCompression()
    public
                    getUseCompression() : bool
    Return values
boolsetExitFastOnExhaustedConnectionPool()
    public
                    setExitFastOnExhaustedConnectionPool(bool $exit_fast_on_exhausted_connection_pool) : mixed
    Parameters
- $exit_fast_on_exhausted_connection_pool : bool
setFilterExpression()
    public
                    setFilterExpression(mixed $filter_expression) : mixed
    Parameters
- $filter_expression : mixed
setMaxConcurrentNodes()
    public
                    setMaxConcurrentNodes(int $max_concurrent_nodes) : mixed
    Parameters
- $max_concurrent_nodes : int
setMaxRecords()
    public
                    setMaxRecords(int $max_records) : mixed
    Parameters
- $max_records : int
setMaxRetries()
    public
                    setMaxRetries(int $max_retries) : mixed
    Parameters
- $max_retries : int
setReadModeAp()
    public
                    setReadModeAp(mixed $read_mode_ap) : mixed
    Parameters
- $read_mode_ap : mixed
setReadModeSc()
    public
                    setReadModeSc(mixed $read_mode_sc) : mixed
    Parameters
- $read_mode_sc : mixed
setRecordQueueSize()
    public
                    setRecordQueueSize(int $record_queue_size) : mixed
    Parameters
- $record_queue_size : int
setSendKey()
    public
                    setSendKey(bool $send_key) : mixed
    Parameters
- $send_key : bool
setSleepMultiplier()
    public
                    setSleepMultiplier(float $sleep_multiplier) : mixed
    Parameters
- $sleep_multiplier : float
setSocketTimeout()
    public
                    setSocketTimeout(int $timeout_millis) : mixed
    Parameters
- $timeout_millis : int
setTotalTimeout()
    public
                    setTotalTimeout(int $timeout_millis) : mixed
    Parameters
- $timeout_millis : int
setUseCompression()
    public
                    setUseCompression(bool $use_compression) : mixed
    Parameters
- $use_compression : bool