\Elastica\AggregationSerialDiff

Class SerialDiff.

Summary

Methods

Properties

Constants

__construct()
setBucketsPath()
setLag()
setGapPolicy()
setFormat()
toArray()

No public properties found

DEFAULT_GAP_POLICY_VALUE

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: Aggregation/SerialDiff.php
Package: Default
Class hierarchy: \Elastica\Aggregation\AbstractAggregation

\Elastica\Aggregation\SerialDiff
See also: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html

Constants

DEFAULT_GAP_POLICY_VALUE

DEFAULT_GAP_POLICY_VALUE

Methods

__construct()

__construct(string  $name, string|null  $bucketsPath = null)

Parameters

string	$name
string\|null	$bucketsPath

setBucketsPath()

setBucketsPath(string  $bucketsPath) : $this

Set the buckets_path for this aggregation.

Parameters

string

$bucketsPath

Returns

$this

setLag()

setLag(integer  $lag = 1) : $this

Set the lag for this aggregation.

Parameters

integer

$lag

Returns

$this

setGapPolicy()

setGapPolicy(string  $gapPolicy) : $this

Set the gap policy for this aggregation.

Parameters

string

$gapPolicy

Returns

$this

setFormat()

setFormat(string  $format = null) : $this

Set the format for this aggregation.

Parameters

string

$format

Returns

$this

toArray()

toArray() : array

Throws

\Elastica\Exception\InvalidException: If buckets path is not set

Returns

array