org.apache.flink.api.common.state

Class StateTtlConfig.Builder

java.lang.Object

org.apache.flink.api.common.state.StateTtlConfig.Builder

Enclosing class:

StateTtlConfig

public static class StateTtlConfig.Builder
extends Object

Builder for the StateTtlConfig.

Constructor Summary

Constructors

Constructor and Description
Builder(Time ttl)

Method Summary

Modifier and Type	Method and Description
StateTtlConfig	build()
StateTtlConfig.Builder	cleanupFullSnapshot() Cleanup expired state in full snapshot on checkpoint.
StateTtlConfig.Builder	neverReturnExpired()
StateTtlConfig.Builder	returnExpiredIfNotCleanedUp()
StateTtlConfig.Builder	setStateVisibility(StateTtlConfig.StateVisibility stateVisibility) Sets the state visibility.
StateTtlConfig.Builder	setTimeCharacteristic(StateTtlConfig.TimeCharacteristic timeCharacteristic) Sets the time characteristic.
StateTtlConfig.Builder	setTtl(Time ttl) Sets the ttl time.
StateTtlConfig.Builder	setUpdateType(StateTtlConfig.UpdateType updateType) Sets the ttl update type.
StateTtlConfig.Builder	updateTtlOnCreateAndWrite()
StateTtlConfig.Builder	updateTtlOnReadAndWrite()
StateTtlConfig.Builder	useProcessingTime()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@Nonnull
               Time ttl)

Method Detail

setUpdateType

@Nonnull
public StateTtlConfig.Builder setUpdateType(StateTtlConfig.UpdateType updateType)

Sets the ttl update type.

Parameters:

updateType - The ttl update type configures when to update last access timestamp which prolongs state TTL.

updateTtlOnCreateAndWrite

@Nonnull
public StateTtlConfig.Builder updateTtlOnCreateAndWrite()

updateTtlOnReadAndWrite

@Nonnull
public StateTtlConfig.Builder updateTtlOnReadAndWrite()

setStateVisibility

@Nonnull
public StateTtlConfig.Builder setStateVisibility(@Nonnull
                                                          StateTtlConfig.StateVisibility stateVisibility)

Sets the state visibility.

Parameters:

stateVisibility - The state visibility configures whether expired user value can be returned or not.

returnExpiredIfNotCleanedUp

@Nonnull
public StateTtlConfig.Builder returnExpiredIfNotCleanedUp()

neverReturnExpired

@Nonnull
public StateTtlConfig.Builder neverReturnExpired()

setTimeCharacteristic

@Nonnull
public StateTtlConfig.Builder setTimeCharacteristic(@Nonnull
                                                             StateTtlConfig.TimeCharacteristic timeCharacteristic)

Sets the time characteristic.

Parameters:

timeCharacteristic - The time characteristic configures time scale to use for ttl.

useProcessingTime

@Nonnull
public StateTtlConfig.Builder useProcessingTime()

cleanupFullSnapshot

@Nonnull
public StateTtlConfig.Builder cleanupFullSnapshot()

Cleanup expired state in full snapshot on checkpoint.

setTtl

@Nonnull
public StateTtlConfig.Builder setTtl(@Nonnull
                                              Time ttl)

Sets the ttl time.

Parameters:

ttl - The ttl time.

build

@Nonnull
public StateTtlConfig build()