Package org.eclipse.ditto.services.utils.akka.streaming

Class StreamTrigger

java.lang.Object

org.eclipse.ditto.services.utils.akka.streaming.StreamTrigger

public final class StreamTrigger
extends Object

Contains timestamps required for triggering a stream.

Method Summary

Modifier and Type	Method	Description
static StreamTrigger	calculateStreamTrigger(Instant now, Instant queryStart, Duration startOffset, Duration streamInterval)	Calculates a StreamTrigger based on the given parameters.
boolean	equals(Object o)
Instant	getPlannedStreamStart()	Returns the planned start of the stream.
Instant	getQueryEnd()	Returns the minimum creation time of the entities to be queried.
Instant	getQueryStart()	Returns the maximum creation time of the entities to be queried.
int	hashCode()
static StreamTrigger	of(Instant queryStart, Instant queryEnd, Instant plannedStreamStart)	Constructor.
StreamTrigger	rescheduleAt(Instant newPlannedStreamStart)	Reschedules this trigger at newPlannedStreamStart.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static StreamTrigger of(Instant queryStart,
                               Instant queryEnd,
                               Instant plannedStreamStart)

Constructor.

Parameters:

queryStart - the minimum creation time of the entities to be queried

queryEnd - the maximum creation time of the entities to be queried

plannedStreamStart - the planned start of the stream: will normally be some time after queryStart, otherwise data might get lost due to clock drift etc.

Returns:

the new trigger.

getPlannedStreamStart

public Instant getPlannedStreamStart()

Returns the planned start of the stream.

Returns:

the planned start of the stream.

getQueryEnd

public Instant getQueryEnd()

Returns the minimum creation time of the entities to be queried.

Returns:

the minimum creation time of the entities to be queried.

getQueryStart

public Instant getQueryStart()

Returns the maximum creation time of the entities to be queried.

Returns:

the maximum creation time of the entities to be queried.

rescheduleAt

public StreamTrigger rescheduleAt(Instant newPlannedStreamStart)

Reschedules this trigger at newPlannedStreamStart.

Parameters:

newPlannedStreamStart - the new planned stream start

Returns:

a new instance of trigger with newPlannedStreamStart.

calculateStreamTrigger

public static StreamTrigger calculateStreamTrigger(Instant now,
                                                   Instant queryStart,
                                                   Duration startOffset,
                                                   Duration streamInterval)

Calculates a StreamTrigger based on the given parameters.

Parameters:

now - the current time

queryStart - the minimum creation time of the entities to be queried.

startOffset - the start-offset: the planned stream start (getPlannedStreamStart() will be at least this offset after queryStart. The actual start-offset may be bigger if queryStart is in the past.

streamInterval - the interval of the stream: the query end getQueryEnd() is calculated by adding this interval to the query start getQueryStart().

Returns:

the trigger

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object