Trigger (Spark 3.3.0 JavaDoc)

Object
- org.apache.spark.sql.streaming.Trigger

```
@Evolving
public class Trigger
extends Object
```
Policy used to indicate how often results should be produced by a [[StreamingQuery]].

Since:

2.0.0

Constructor Summary

Constructors
Constructor and Description

Trigger()

Constructors
Constructor and Description
`Trigger()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Trigger`	`AvailableNow()` A trigger that processes all available data at the start of the query in one or multiple batches, then terminates the query.
`static Trigger`	`Continuous(scala.concurrent.duration.Duration interval)` (Scala-friendly) A trigger that continuously processes streaming data, asynchronously checkpointing at the specified interval.
`static Trigger`	`Continuous(long intervalMs)` A trigger that continuously processes streaming data, asynchronously checkpointing at the specified interval.
`static Trigger`	`Continuous(long interval, java.util.concurrent.TimeUnit timeUnit)` A trigger that continuously processes streaming data, asynchronously checkpointing at the specified interval.
`static Trigger`	`Continuous(String interval)` A trigger that continuously processes streaming data, asynchronously checkpointing at the specified interval.
`static Trigger`	`Once()` A trigger that processes all available data in a single batch then terminates the query.
`static Trigger`	`ProcessingTime(scala.concurrent.duration.Duration interval)` (Scala-friendly) A trigger policy that runs a query periodically based on an interval in processing time.
`static Trigger`	`ProcessingTime(long intervalMs)` A trigger policy that runs a query periodically based on an interval in processing time.
`static Trigger`	`ProcessingTime(long interval, java.util.concurrent.TimeUnit timeUnit)` (Java-friendly) A trigger policy that runs a query periodically based on an interval in processing time.
`static Trigger`	`ProcessingTime(String interval)` A trigger policy that runs a query periodically based on an interval in processing time.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Trigger
```
public Trigger()
```
- Method Detail
  - ProcessingTime
```
public static Trigger ProcessingTime(long intervalMs)
```
    A trigger policy that runs a query periodically based on an interval in processing time. If `interval` is 0, the query will run as fast as possible.
    
    Since:
    
    2.2.0
  - ProcessingTime
```
public static Trigger ProcessingTime(long interval,
                                     java.util.concurrent.TimeUnit timeUnit)
```
    (Java-friendly) A trigger policy that runs a query periodically based on an interval in processing time. If `interval` is 0, the query will run as fast as possible. {{{ import java.util.concurrent.TimeUnit df.writeStream().trigger(Trigger.ProcessingTime(10, TimeUnit.SECONDS)) }}}
    
    Since:
    
    2.2.0
  - ProcessingTime
```
public static Trigger ProcessingTime(scala.concurrent.duration.Duration interval)
```
    (Scala-friendly) A trigger policy that runs a query periodically based on an interval in processing time. If `duration` is 0, the query will run as fast as possible. {{{ import scala.concurrent.duration._ df.writeStream.trigger(Trigger.ProcessingTime(10.seconds)) }}}
    
    Since:
    
    2.2.0
  - ProcessingTime
```
public static Trigger ProcessingTime(String interval)
```
    A trigger policy that runs a query periodically based on an interval in processing time. If `interval` is effectively 0, the query will run as fast as possible. {{{ df.writeStream.trigger(Trigger.ProcessingTime("10 seconds")) }}}
    
    Since:
    
    2.2.0
  - Once
```
public static Trigger Once()
```
    A trigger that processes all available data in a single batch then terminates the query. For better scalability, AvailableNow can be used alternatively to process the data in multiple batches.
    
    Since:
    
    2.2.0
  - AvailableNow
```
public static Trigger AvailableNow()
```
    A trigger that processes all available data at the start of the query in one or multiple batches, then terminates the query.
    
    Since:
    
    3.3.0
  - Continuous
```
public static Trigger Continuous(long intervalMs)
```
    A trigger that continuously processes streaming data, asynchronously checkpointing at the specified interval.
    
    Since:
    
    2.3.0
  - Continuous
```
public static Trigger Continuous(long interval,
                                 java.util.concurrent.TimeUnit timeUnit)
```
    A trigger that continuously processes streaming data, asynchronously checkpointing at the specified interval. {{{ import java.util.concurrent.TimeUnit df.writeStream.trigger(Trigger.Continuous(10, TimeUnit.SECONDS)) }}}
    
    Since:
    
    2.3.0
  - Continuous
```
public static Trigger Continuous(scala.concurrent.duration.Duration interval)
```
    (Scala-friendly) A trigger that continuously processes streaming data, asynchronously checkpointing at the specified interval. {{{ import scala.concurrent.duration._ df.writeStream.trigger(Trigger.Continuous(10.seconds)) }}}
    
    Since:
    
    2.3.0
  - Continuous
```
public static Trigger Continuous(String interval)
```
    A trigger that continuously processes streaming data, asynchronously checkpointing at the specified interval. {{{ df.writeStream.trigger(Trigger.Continuous("10 seconds")) }}}
    
    Since:
    
    2.3.0

Class Trigger

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

Trigger

Method Detail

ProcessingTime

ProcessingTime

ProcessingTime

ProcessingTime

Once

AvailableNow

Continuous

Continuous

Continuous

Continuous