PHP Class Elastica\Aggregation\BucketScript

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html
Inheritance: extends AbstractAggregation
Show file Open project: ruflin/elastica

Public Methods

Method Description
__construct ( string $name, array | null $bucketsPath = null, string | null $script = null )
setBucketsPath ( array $bucketsPath ) Set the buckets_path for this aggregation.
setFormat ( string $format ) Set the format for this aggregation.
setGapPolicy ( string $gapPolicy ) Set the gap policy for this aggregation.
setScript ( string $script ) Set the script for this aggregation.
toArray ( ) : array

Method Details

__construct() public method

public __construct ( string $name, array | null $bucketsPath = null, string | null $script = null )
$name string
$bucketsPath array | null
$script string | null

setBucketsPath() public method

Set the buckets_path for this aggregation.
public setBucketsPath ( array $bucketsPath )
$bucketsPath array

setFormat() public method

Set the format for this aggregation.
public setFormat ( string $format )
$format string

setGapPolicy() public method

Set the gap policy for this aggregation.
public setGapPolicy ( string $gapPolicy )
$gapPolicy string

setScript() public method

Set the script for this aggregation.
public setScript ( string $script )
$script string

toArray() public method

public toArray ( ) : array
return array