TumblingWindowTrigger Class

public final class TumblingWindowTrigger
extends Trigger

Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).

Constructor Summary

Constructor Description
TumblingWindowTrigger()

Creates an instance of TumblingWindowTrigger class.

Method Summary

Modifier and Type Method and Description
Object delay()

Get the delay property: Specifies how long the trigger waits past due time before triggering new run.

List<DependencyReference> dependsOn()

Get the dependsOn property: Triggers that this trigger depends on.

OffsetDateTime endTime()

Get the endTime property: The end time for the time period for the trigger during which events are fired for windows that are ready.

TumblingWindowFrequency frequency()

Get the frequency property: The frequency of the time windows.

static TumblingWindowTrigger fromJson(JsonReader jsonReader)

Reads an instance of TumblingWindowTrigger from the JsonReader.

int interval()

Get the interval property: The interval of the time windows.

int maxConcurrency()

Get the maxConcurrency property: The max number of parallel time windows (ready for execution) for which a new run is triggered.

TriggerPipelineReference pipeline()

Get the pipeline property: Pipeline for which runs are created when an event is fired for trigger window that is ready.

RetryPolicy retryPolicy()

Get the retryPolicy property: Retry policy that will be applied for failed pipeline runs.

OffsetDateTime startTime()

Get the startTime property: The start time for the time period for the trigger during which events are fired for windows that are ready.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Trigger type.

void validate()

Validates the instance.

TumblingWindowTrigger withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the trigger.

TumblingWindowTrigger withDelay(Object delay)

Set the delay property: Specifies how long the trigger waits past due time before triggering new run.

TumblingWindowTrigger withDependsOn(List<DependencyReference> dependsOn)

Set the dependsOn property: Triggers that this trigger depends on.

TumblingWindowTrigger withDescription(String description)

Set the description property: Trigger description.

TumblingWindowTrigger withEndTime(OffsetDateTime endTime)

Set the endTime property: The end time for the time period for the trigger during which events are fired for windows that are ready.

TumblingWindowTrigger withFrequency(TumblingWindowFrequency frequency)

Set the frequency property: The frequency of the time windows.

TumblingWindowTrigger withInterval(int interval)

Set the interval property: The interval of the time windows.

TumblingWindowTrigger withMaxConcurrency(int maxConcurrency)

Set the maxConcurrency property: The max number of parallel time windows (ready for execution) for which a new run is triggered.

TumblingWindowTrigger withPipeline(TriggerPipelineReference pipeline)

Set the pipeline property: Pipeline for which runs are created when an event is fired for trigger window that is ready.

TumblingWindowTrigger withRetryPolicy(RetryPolicy retryPolicy)

Set the retryPolicy property: Retry policy that will be applied for failed pipeline runs.

TumblingWindowTrigger withStartTime(OffsetDateTime startTime)

Set the startTime property: The start time for the time period for the trigger during which events are fired for windows that are ready.

Methods inherited from Trigger

Methods inherited from java.lang.Object

Constructor Details

TumblingWindowTrigger

public TumblingWindowTrigger()

Creates an instance of TumblingWindowTrigger class.

Method Details

delay

public Object delay()

Get the delay property: Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Returns:

the delay value.

dependsOn

public List<DependencyReference> dependsOn()

Get the dependsOn property: Triggers that this trigger depends on. Only tumbling window triggers are supported.

Returns:

the dependsOn value.

endTime

public OffsetDateTime endTime()

Get the endTime property: The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

Returns:

the endTime value.

frequency

public TumblingWindowFrequency frequency()

Get the frequency property: The frequency of the time windows.

Returns:

the frequency value.

fromJson

public static TumblingWindowTrigger fromJson(JsonReader jsonReader)

Reads an instance of TumblingWindowTrigger from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of TumblingWindowTrigger if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

interval

public int interval()

Get the interval property: The interval of the time windows. The minimum interval allowed is 15 Minutes.

Returns:

the interval value.

maxConcurrency

public int maxConcurrency()

Get the maxConcurrency property: The max number of parallel time windows (ready for execution) for which a new run is triggered.

Returns:

the maxConcurrency value.

pipeline

public TriggerPipelineReference pipeline()

Get the pipeline property: Pipeline for which runs are created when an event is fired for trigger window that is ready.

Returns:

the pipeline value.

retryPolicy

public RetryPolicy retryPolicy()

Get the retryPolicy property: Retry policy that will be applied for failed pipeline runs.

Returns:

the retryPolicy value.

startTime

public OffsetDateTime startTime()

Get the startTime property: The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

Returns:

the startTime value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

TumblingWindowTrigger.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Trigger type.

Overrides:

TumblingWindowTrigger.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

TumblingWindowTrigger.validate()

withAnnotations

public TumblingWindowTrigger withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the trigger.

Overrides:

TumblingWindowTrigger.withAnnotations(List<Object> annotations)

Parameters:

annotations

withDelay

public TumblingWindowTrigger withDelay(Object delay)

Set the delay property: Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Parameters:

delay - the delay value to set.

Returns:

the TumblingWindowTrigger object itself.

withDependsOn

public TumblingWindowTrigger withDependsOn(List<DependencyReference> dependsOn)

Set the dependsOn property: Triggers that this trigger depends on. Only tumbling window triggers are supported.

Parameters:

dependsOn - the dependsOn value to set.

Returns:

the TumblingWindowTrigger object itself.

withDescription

public TumblingWindowTrigger withDescription(String description)

Set the description property: Trigger description.

Overrides:

TumblingWindowTrigger.withDescription(String description)

Parameters:

description

withEndTime

public TumblingWindowTrigger withEndTime(OffsetDateTime endTime)

Set the endTime property: The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

Parameters:

endTime - the endTime value to set.

Returns:

the TumblingWindowTrigger object itself.

withFrequency

public TumblingWindowTrigger withFrequency(TumblingWindowFrequency frequency)

Set the frequency property: The frequency of the time windows.

Parameters:

frequency - the frequency value to set.

Returns:

the TumblingWindowTrigger object itself.

withInterval

public TumblingWindowTrigger withInterval(int interval)

Set the interval property: The interval of the time windows. The minimum interval allowed is 15 Minutes.

Parameters:

interval - the interval value to set.

Returns:

the TumblingWindowTrigger object itself.

withMaxConcurrency

public TumblingWindowTrigger withMaxConcurrency(int maxConcurrency)

Set the maxConcurrency property: The max number of parallel time windows (ready for execution) for which a new run is triggered.

Parameters:

maxConcurrency - the maxConcurrency value to set.

Returns:

the TumblingWindowTrigger object itself.

withPipeline

public TumblingWindowTrigger withPipeline(TriggerPipelineReference pipeline)

Set the pipeline property: Pipeline for which runs are created when an event is fired for trigger window that is ready.

Parameters:

pipeline - the pipeline value to set.

Returns:

the TumblingWindowTrigger object itself.

withRetryPolicy

public TumblingWindowTrigger withRetryPolicy(RetryPolicy retryPolicy)

Set the retryPolicy property: Retry policy that will be applied for failed pipeline runs.

Parameters:

retryPolicy - the retryPolicy value to set.

Returns:

the TumblingWindowTrigger object itself.

withStartTime

public TumblingWindowTrigger withStartTime(OffsetDateTime startTime)

Set the startTime property: The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

Parameters:

startTime - the startTime value to set.

Returns:

the TumblingWindowTrigger object itself.

Applies to