Documentation

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

Methods

getMaxRecords()

*************************************************************************** MultiPolicy Attrs ***************************************************************************

public getMaxRecords() : int
Return values
int

getMaxRetries()

*************************************************************************** ReadPolicy Attrs ***************************************************************************

public getMaxRetries() : int
Return values
int

setExitFastOnExhaustedConnectionPool()

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

        
On this page

Search results