StopCrawlerOnMaxEventListener

The following example will stop the crawler when the sum of committed documents (upserts + deletions) reaches 100.

crawler/coreJavadoc: StopCrawlerOnMaxEventListener

Notes

The following example will stop the crawler when the sum of committed documents (upserts + deletions) reaches 100.

Examples

YAML

class: StopCrawlerOnMaxEventListener
maximum: 100
onMultiple: SUM
eventMatcher:
  method: CSV
  pattern: DOCUMENT_COMMITTED_UPSERT,DOCUMENT_COMMITTED_DELETE

JSON

{
  "class": "StopCrawlerOnMaxEventListener",
  "maximum": 100,
  "onMultiple": "SUM",
  "eventMatcher": {
    "method": "CSV",
    "pattern": "DOCUMENT_COMMITTED_UPSERT,DOCUMENT_COMMITTED_DELETE"
  }
}

XML

<class>StopCrawlerOnMaxEventListener</class>
<maximum>100</maximum>
<onMultiple>SUM</onMultiple>
<eventMatcher>
  <method>CSV</method>
  <pattern>DOCUMENT_COMMITTED_UPSERT,DOCUMENT_COMMITTED_DELETE</pattern>
</eventMatcher>

Usage

Full configuration skeleton, with every option and its default

YAML

class: StopCrawlerOnMaxEventListener
eventMatcher:
  ignoreCase: false
  ignoreDiacritic: false
  matchEmpty: false
  method: BASIC
  negateMatches: false
  partial: false
  pattern: string
  replaceAll: false
  trim: false
maximum: 0
onMultiple: ANY

JSON

{
  "class": "StopCrawlerOnMaxEventListener",
  "eventMatcher": {
    "ignoreCase": false,
    "ignoreDiacritic": false,
    "matchEmpty": false,
    "method": "BASIC",
    "negateMatches": false,
    "partial": false,
    "pattern": "string",
    "replaceAll": false,
    "trim": false
  },
  "maximum": 0,
  "onMultiple": "ANY"
}

XML

<stopCrawlerOnMaxEventListener>
  <class>StopCrawlerOnMaxEventListener</class>
  <eventMatcher>
    <ignoreCase>false</ignoreCase>
    <ignoreDiacritic>false</ignoreDiacritic>
    <matchEmpty>false</matchEmpty>
    <method>BASIC</method>
    <negateMatches>false</negateMatches>
    <partial>false</partial>
    <pattern>string</pattern>
    <replaceAll>false</replaceAll>
    <trim>false</trim>
  </eventMatcher>
  <maximum>0</maximum>
  <onMultiple>ANY</onMultiple>
</stopCrawlerOnMaxEventListener>

Properties

Property	Type	Required	Default
eventMatcher	TextMatcher	No	TextMatcher
maximum	integer	No	0
onMultiple	enum	No	ANY

Property Details

eventMatcher

A text matcher identifying which crawler events are counted toward the maximum threshold. When the threshold is reached, the crawler is stopped.

maximum

The maximum number of matching events before the crawler is stopped.

onMultiple

Determines how the maximum count is evaluated when multiple event types are matched. ANY stops when any single event type reaches the maximum; ALL stops when all matched event types reach the maximum; SUM stops when the combined total of all matching events reaches the maximum. Default is ANY.

Allowed Values

• ANY
• ALL
• SUM