TumblingWindowTrigger Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public 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
static TumblingWindowTrigger fromJson(JsonReader jsonReader)

Reads an instance of TumblingWindowTrigger from the JsonReader.
Object getDelay()

Get the delay property: Specifies how long the trigger waits past due time before triggering new run.
List<DependencyReference> getDependsOn()

Get the dependsOn property: Triggers that this trigger depends on.
OffsetDateTime getEndTime()

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 getFrequency()

Get the frequency property: The frequency of the time windows.
int getInterval()

Get the interval property: The interval of the time windows.
int getMaxConcurrency()

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

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

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

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

Get the type property: Trigger type.
TumblingWindowTrigger setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the trigger.
TumblingWindowTrigger setDelay(Object delay)

Set the delay property: Specifies how long the trigger waits past due time before triggering new run.
TumblingWindowTrigger setDependsOn(List<DependencyReference> dependsOn)

Set the dependsOn property: Triggers that this trigger depends on.
TumblingWindowTrigger setDescription(String description)

Set the description property: Trigger description.
TumblingWindowTrigger setEndTime(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 setFrequency(TumblingWindowFrequency frequency)

Set the frequency property: The frequency of the time windows.
TumblingWindowTrigger setInterval(int interval)

Set the interval property: The interval of the time windows.
TumblingWindowTrigger setMaxConcurrency(int maxConcurrency)

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

Set the pipeline property: Pipeline for which runs are created when an event is fired for trigger window that is ready.
TumblingWindowTrigger setRetryPolicy(RetryPolicy retryPolicy)

Set the retryPolicy property: Retry policy that will be applied for failed pipeline runs.
TumblingWindowTrigger setStartTime(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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from Trigger

fromJson getAdditionalProperties getAnnotations getDescription getRuntimeState getType setAdditionalProperties setAnnotations setDescription toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TumblingWindowTrigger

public TumblingWindowTrigger()

Creates an instance of TumblingWindowTrigger class.

Method Details

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.

getDelay

public Object getDelay()

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.

getDependsOn

public List<DependencyReference> getDependsOn()

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

Returns:

the dependsOn value.

getEndTime

public OffsetDateTime getEndTime()

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.

getFrequency

public TumblingWindowFrequency getFrequency()

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

Returns:

the frequency value.

getInterval

public int getInterval()

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

Returns:

the interval value.

getMaxConcurrency

public int getMaxConcurrency()

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.

getPipeline

public TriggerPipelineReference getPipeline()

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.

getRetryPolicy

public RetryPolicy getRetryPolicy()

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

Returns:

the retryPolicy value.

getStartTime

public OffsetDateTime getStartTime()

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.

getType

public String getType()

Get the type property: Trigger type.

Overrides:

TumblingWindowTrigger.getType()

Returns:

the type value.

setAnnotations

public TumblingWindowTrigger setAnnotations(List<Object> annotations)

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

Overrides:

TumblingWindowTrigger.setAnnotations(List<Object> annotations)

Parameters:

annotations

setDelay

public TumblingWindowTrigger setDelay(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.

setDependsOn

public TumblingWindowTrigger setDependsOn(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.

setDescription

public TumblingWindowTrigger setDescription(String description)

Set the description property: Trigger description.

Overrides:

TumblingWindowTrigger.setDescription(String description)

Parameters:

description

setEndTime

public TumblingWindowTrigger setEndTime(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.

setFrequency

public TumblingWindowTrigger setFrequency(TumblingWindowFrequency frequency)

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

Parameters:

frequency - the frequency value to set.

Returns:

the TumblingWindowTrigger object itself.

setInterval

public TumblingWindowTrigger setInterval(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.

setMaxConcurrency

public TumblingWindowTrigger setMaxConcurrency(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.

setPipeline

public TumblingWindowTrigger setPipeline(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.

setRetryPolicy

public TumblingWindowTrigger setRetryPolicy(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.

setStartTime

public TumblingWindowTrigger setStartTime(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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

TumblingWindowTrigger.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to