org.apache.reef.vortex.api

Class VortexAggregatePolicy

java.lang.Object

org.apache.reef.vortex.api.VortexAggregatePolicy

All Implemented Interfaces:

Serializable

public final class VortexAggregatePolicy
extends Object
implements Serializable

The policy for local aggregation on the VortexWorkers. The Aggregation function will be triggered on the individual VortexFunction results on an "OR" basis of what is specified by the policy. TODO[REEF-504]: Clean up Serializable in Vortex.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VortexAggregatePolicy.AggregatePolicyBuilder A Builder class for VortexAggregatePolicy.

Method Summary

Methods

Modifier and Type	Method and Description
Optional<Integer>	getCount()
int	getPeriodMilliseconds()
static VortexAggregatePolicy.AggregatePolicyBuilder	newBuilder()

Methods inherited from class java.lang.Object

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

Method Detail

getPeriodMilliseconds

public int getPeriodMilliseconds()

Returns:

the aggregation period in milliseconds.

getCount

public Optional<Integer> getCount()

Returns:

the count trigger for the aggregation.

newBuilder

public static VortexAggregatePolicy.AggregatePolicyBuilder newBuilder()

Returns:

a new Builder for VortexAggregatePolicy.