ConcurrentScannerThrottlingAware (platform/sdk 5.6.1.0 API)

All Superinterfaces:

ConcurrentDocumentFetcherScanner
```
public interface ConcurrentScannerThrottlingAware
extends ConcurrentDocumentFetcherScanner
```
The scanner will implement this to if it wants platform level throttling support. It extends ConcurrentDocumentFetcherScanner since throttling is needed only when multiple threads try to access the server concurrently.

Field Summary
- Fields inherited from interface com.attivio.sdk.scanner.concurrency.ConcurrentDocumentFetcherScanner
  FETCHER_TIMEOUT_DEFAULT, THREADPOOL_SIZE_DEFAULT

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`long`	`getDocumentRequestsUpperLimit()`	An upper limit on the number of fetch requests the connector framework implementation will execute in a given `time period`.
`default long`	`getTimePeriodMillis()`	Returns the time period for which to test the upper limit of document requests.
`void`	`setDocumentRequestsUpperLimit(long documentRequestsUpperLimit)`	Sets an upper limit on the number of fetch requests the connector framework implementation will execute in a given `time period`.
`default void`	`setTimePeriodMillis(long timePeriodMillis)`	Sets time period for which to test the upper limit of document requests.

Methods inherited from interface com.attivio.sdk.scanner.concurrency.ConcurrentDocumentFetcherScanner
getFetcherTimeout, getThreadpoolSize, setConcurrencyProvider, setFetcherTimeout, setThreadpoolSize, stop

- Method Detail
  - setDocumentRequestsUpperLimit
```
void setDocumentRequestsUpperLimit(long documentRequestsUpperLimit)
```
    Sets an upper limit on the number of fetch requests the connector framework implementation will execute in a given time period.
    
    Parameters:
    
    documentRequestsUpperLimit - the upper limit for document requests in a time period; set -1 for no limit
  - getDocumentRequestsUpperLimit
```
long getDocumentRequestsUpperLimit()
```
    An upper limit on the number of fetch requests the connector framework implementation will execute in a given time period.
    
    Returns:
    
    the upper limit for document requests in a time period; -1 implies no limit
  - setTimePeriodMillis
```
default void setTimePeriodMillis(long timePeriodMillis)
```
    Sets time period for which to test the upper limit of document requests.
    
    Parameters:
    
    timePeriodMillis - the time period in milliseconds
  - getTimePeriodMillis
```
default long getTimePeriodMillis()
```
    Returns the time period for which to test the upper limit of document requests.
    
    Returns:
    
    the time period in milliseconds