org.apache.flink.streaming.api.functions.sink.filesystem.rollingpolicies

类 DefaultRollingPolicy<IN,BucketID>

java.lang.Object

org.apache.flink.streaming.api.functions.sink.filesystem.rollingpolicies.DefaultRollingPolicy<IN,BucketID>

所有已实现的接口:

Serializable, RollingPolicy<IN,BucketID>

@PublicEvolving
public final class DefaultRollingPolicy<IN,BucketID>
extends Object
implements RollingPolicy<IN,BucketID>

The default implementation of the RollingPolicy.

This policy rolls a part file if:

1. there is no open part file,
2. the current file has reached the maximum bucket size (by default 128MB),
3. the current file is older than the roll over interval (by default 60 sec), or
4. the current file has not been written to for more than the allowed inactivityTime (by default 60 sec).

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	DefaultRollingPolicy.PolicyBuilder A helper class that holds the configuration properties for the DefaultRollingPolicy.

方法概要

限定符和类型	方法和说明
static DefaultRollingPolicy.PolicyBuilder	builder() Creates a new DefaultRollingPolicy.PolicyBuilder that is used to configure and build an instance of DefaultRollingPolicy.
static DefaultRollingPolicy.PolicyBuilder	create() 已过时。
long	getInactivityInterval() Returns time duration of allowed inactivity after which a part file will have to roll.
long	getMaxPartSize() Returns the maximum part file size before rolling.
long	getRolloverInterval() Returns the maximum time duration a part file can stay open before rolling.
boolean	shouldRollOnCheckpoint(PartFileInfo<BucketID> partFileState) Determines if the in-progress part file for a bucket should roll on every checkpoint.
boolean	shouldRollOnEvent(PartFileInfo<BucketID> partFileState, IN element) Determines if the in-progress part file for a bucket should roll based on its current state, e.g. its size.
boolean	shouldRollOnProcessingTime(PartFileInfo<BucketID> partFileState, long currentTime) Determines if the in-progress part file for a bucket should roll based on a time condition.

从类继承的方法 java.lang.Object

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

方法详细资料

shouldRollOnCheckpoint

public boolean shouldRollOnCheckpoint(PartFileInfo<BucketID> partFileState)
                               throws IOException

从接口复制的说明: RollingPolicy

Determines if the in-progress part file for a bucket should roll on every checkpoint.

指定者:

shouldRollOnCheckpoint 在接口中 RollingPolicy<IN,BucketID>

参数:

partFileState - the state of the currently open part file of the bucket.

返回:

True if the part file should roll, false otherwise.

抛出:

IOException

shouldRollOnEvent

public boolean shouldRollOnEvent(PartFileInfo<BucketID> partFileState,
                                 IN element)
                          throws IOException

从接口复制的说明: RollingPolicy

Determines if the in-progress part file for a bucket should roll based on its current state, e.g. its size.

指定者:

shouldRollOnEvent 在接口中 RollingPolicy<IN,BucketID>

参数:

partFileState - the state of the currently open part file of the bucket.

element - the element being processed.

返回:

True if the part file should roll, false otherwise.

抛出:

IOException

shouldRollOnProcessingTime

public boolean shouldRollOnProcessingTime(PartFileInfo<BucketID> partFileState,
                                          long currentTime)

从接口复制的说明: RollingPolicy

Determines if the in-progress part file for a bucket should roll based on a time condition.

指定者:

shouldRollOnProcessingTime 在接口中 RollingPolicy<IN,BucketID>

参数:

partFileState - the state of the currently open part file of the bucket.

currentTime - the current processing time.

返回:

True if the part file should roll, false otherwise.

getMaxPartSize

public long getMaxPartSize()

Returns the maximum part file size before rolling.

返回:

Max size in bytes

getRolloverInterval

public long getRolloverInterval()

Returns the maximum time duration a part file can stay open before rolling.

返回:

Time duration in milliseconds

getInactivityInterval

public long getInactivityInterval()

Returns time duration of allowed inactivity after which a part file will have to roll.

返回:

Time duration in milliseconds

builder

public static DefaultRollingPolicy.PolicyBuilder builder()

Creates a new DefaultRollingPolicy.PolicyBuilder that is used to configure and build an instance of DefaultRollingPolicy.

create

@Deprecated
public static DefaultRollingPolicy.PolicyBuilder create()

已过时。

This method is Deprecated, use builder() instead.