Package io.camunda.optimize.service.db.os

Class OpenSearchCompositeAggregationScroller

java.lang.Object

io.camunda.optimize.service.db.os.OpenSearchCompositeAggregationScroller

public class OpenSearchCompositeAggregationScroller
extends Object

Constructor Summary

Constructors

Constructor	Description
OpenSearchCompositeAggregationScroller()

Method Summary

Modifier and Type	Method	Description
OpenSearchCompositeAggregationScroller	aggregations(Map<String,org.opensearch.client.opensearch._types.aggregations.Aggregation> aggregations)
void	consumeAllPages()
boolean	consumePage()	Consumes next page of the composite aggregation.
static OpenSearchCompositeAggregationScroller	create()
OpenSearchCompositeAggregationScroller	index(List<String> indices)
OpenSearchCompositeAggregationScroller	query(org.opensearch.client.opensearch._types.query_dsl.Query query)
OpenSearchCompositeAggregationScroller	setClient(OptimizeOpenSearchClient osClient)
OpenSearchCompositeAggregationScroller	setCompositeBucketConsumer(Consumer<org.opensearch.client.opensearch._types.aggregations.CompositeBucket> compositeBucketConsumer)
OpenSearchCompositeAggregationScroller	setPathToAggregation(String... pathToAggregation)	In order to be able to access the composite aggregation the scroller needs to know where to find the composite aggregation.
OpenSearchCompositeAggregationScroller	size(int size)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenSearchCompositeAggregationScroller

public OpenSearchCompositeAggregationScroller()

Method Details

aggregations

public OpenSearchCompositeAggregationScroller aggregations(Map<String,org.opensearch.client.opensearch._types.aggregations.Aggregation> aggregations)

query

public OpenSearchCompositeAggregationScroller query(org.opensearch.client.opensearch._types.query_dsl.Query query)

index

public OpenSearchCompositeAggregationScroller index(List<String> indices)

size

public OpenSearchCompositeAggregationScroller size(int size)

create

public static OpenSearchCompositeAggregationScroller create()

consumeAllPages

public void consumeAllPages()

consumePage

public boolean consumePage()

Consumes next page of the composite aggregation.

Returns:

true if a page was present, false else

setClient

public OpenSearchCompositeAggregationScroller setClient(OptimizeOpenSearchClient osClient)

setCompositeBucketConsumer

public OpenSearchCompositeAggregationScroller setCompositeBucketConsumer(Consumer<org.opensearch.client.opensearch._types.aggregations.CompositeBucket> compositeBucketConsumer)

setPathToAggregation

public OpenSearchCompositeAggregationScroller setPathToAggregation(String... pathToAggregation)

In order to be able to access the composite aggregation the scroller needs to know where to find the composite aggregation. The path can be stated in this method:

Example: Aggregation: nested("fooNested",..).subAggregation(composite("myComposite")..) Respective call: setPathToAggregation("fooNested", "myComposite")

Parameters:

pathToAggregation - a path to where to find the composite aggregation

Returns:

the scroller object