Painless API Reference

Painless has a strict whitelist for methods and classes per context to ensure all painless scripts are secure. Most of these methods are exposed directly from the Java Runtime Environment (JRE) while others are part of Elasticsearch or Painless itself. Below is a list of the available APIs per context. The shared API is available to all contexts, while the specialized API available differs between contexts.

Aggregation Selector

Shared API

 

Aggs

Shared API

 

Aggs Combine

Shared API

 

Aggs Init

Shared API

 

Aggs Map

Shared API

 

Aggs Reduce

Shared API

 

Analysis

Shared API

Specialized API

Bucket Aggregation

Shared API

 

Field

Shared API

Specialized API

Filter

Shared API

 

Ingest

Shared API

Specialized API

Interval

Shared API

 

Moving Function

Shared API

Specialized API

Number Sort

Shared API

 

Painless Test

Shared API

 

Processor Conditional

Shared API

 

Score

Shared API

Specialized API

Script Heuristic

Shared API

 

Similarity

Shared API

 

Similarity Weight

Shared API

 

String Sort

Shared API

 

Template

Shared API

 

Terms Set

Shared API

 

Update

Shared API

 

Watcher Condition

Shared API

 

Watcher Transform

Shared API

 

Xpack Template

Shared API