public interface FlinkPipelineOptions extends PipelineOptions, ApplicationNameOptions, StreamingOptions
Avoid using `org.apache.flink.*` members below. This allows including the flink runner without requiring flink on the classpath (e.g. to use with the direct runner).
PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AUTO |
static java.lang.String |
EXACTLY_ONCE |
static java.lang.String |
PIPELINED |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getAllowNonRestoredState() |
java.lang.Long |
getAutoWatermarkInterval() |
java.lang.Long |
getCheckpointingInterval() |
java.lang.String |
getCheckpointingMode() |
java.lang.Long |
getCheckpointTimeoutMillis() |
java.lang.Boolean |
getDisableMetrics() |
java.lang.String |
getExecutionModeForBatch() |
java.lang.Long |
getExecutionRetryDelay() |
java.lang.Boolean |
getFailOnCheckpointingErrors() |
java.util.List<java.lang.String> |
getFilesToStage()
List of local files to make available to workers.
|
java.lang.String |
getFlinkMaster()
The url of the Flink JobManager on which to execute pipelines.
|
java.lang.Long |
getLatencyTrackingInterval() |
java.lang.Long |
getMaxBundleSize() |
java.lang.Long |
getMaxBundleTimeMills() |
java.lang.Integer |
getMaxParallelism() |
java.lang.Long |
getMinPauseBetweenCheckpoints() |
java.lang.Integer |
getNumberOfExecutionRetries() |
java.lang.Boolean |
getObjectReuse() |
java.lang.Integer |
getParallelism() |
java.lang.Boolean |
getRetainExternalizedCheckpointsOnCancellation() |
java.lang.String |
getSavepointPath() |
java.lang.Class<? extends FlinkStateBackendFactory> |
getStateBackendFactory()
State backend to store Beam's state during computation.
|
java.lang.Boolean |
isAutoBalanceWriteFilesShardingEnabled() |
java.lang.Boolean |
isExternalizedCheckpointsEnabled()
Enables or disables externalized checkpoints.
|
java.lang.Boolean |
isShutdownSourcesOnFinalWatermark()
Whether to shutdown sources when their watermark reaches
+Inf . |
void |
setAllowNonRestoredState(java.lang.Boolean allowNonRestoredState) |
void |
setAutoBalanceWriteFilesShardingEnabled(java.lang.Boolean autoBalanceWriteFilesShardingEnabled) |
void |
setAutoWatermarkInterval(java.lang.Long interval) |
void |
setCheckpointingInterval(java.lang.Long interval) |
void |
setCheckpointingMode(java.lang.String mode) |
void |
setCheckpointTimeoutMillis(java.lang.Long checkpointTimeoutMillis) |
void |
setDisableMetrics(java.lang.Boolean enableMetrics) |
void |
setExecutionModeForBatch(java.lang.String executionMode) |
void |
setExecutionRetryDelay(java.lang.Long delay) |
void |
setExternalizedCheckpointsEnabled(java.lang.Boolean externalCheckpoints) |
void |
setFailOnCheckpointingErrors(java.lang.Boolean failOnCheckpointingErrors) |
void |
setFilesToStage(java.util.List<java.lang.String> value) |
void |
setFlinkMaster(java.lang.String value) |
void |
setLatencyTrackingInterval(java.lang.Long interval) |
void |
setMaxBundleSize(java.lang.Long size) |
void |
setMaxBundleTimeMills(java.lang.Long time) |
void |
setMaxParallelism(java.lang.Integer value) |
void |
setMinPauseBetweenCheckpoints(java.lang.Long minPauseInterval) |
void |
setNumberOfExecutionRetries(java.lang.Integer retries) |
void |
setObjectReuse(java.lang.Boolean reuse) |
void |
setParallelism(java.lang.Integer value) |
void |
setRetainExternalizedCheckpointsOnCancellation(java.lang.Boolean retainOnCancellation) |
void |
setSavepointPath(java.lang.String path) |
void |
setShutdownSourcesOnFinalWatermark(java.lang.Boolean shutdownOnFinalWatermark) |
void |
setStateBackendFactory(java.lang.Class<? extends FlinkStateBackendFactory> stateBackendFactory) |
isStreaming, setStreaming
getAppName, setAppName
as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent
populateDisplayData
static final java.lang.String AUTO
static final java.lang.String PIPELINED
static final java.lang.String EXACTLY_ONCE
java.util.List<java.lang.String> getFilesToStage()
Jars are placed on the worker's classpath.
The default value is the list of jars from the main program's classpath.
void setFilesToStage(java.util.List<java.lang.String> value)
@Default.String(value="[auto]") java.lang.String getFlinkMaster()
void setFlinkMaster(java.lang.String value)
@Default.Integer(value=-1) java.lang.Integer getParallelism()
void setParallelism(java.lang.Integer value)
@Default.Integer(value=-1) java.lang.Integer getMaxParallelism()
void setMaxParallelism(java.lang.Integer value)
@Default.Long(value=-1L) java.lang.Long getCheckpointingInterval()
void setCheckpointingInterval(java.lang.Long interval)
@Default.String(value="EXACTLY_ONCE") java.lang.String getCheckpointingMode()
void setCheckpointingMode(java.lang.String mode)
@Default.Long(value=-1L) java.lang.Long getCheckpointTimeoutMillis()
void setCheckpointTimeoutMillis(java.lang.Long checkpointTimeoutMillis)
@Default.Long(value=-1L) java.lang.Long getMinPauseBetweenCheckpoints()
void setMinPauseBetweenCheckpoints(java.lang.Long minPauseInterval)
@Default.Boolean(value=true) java.lang.Boolean getFailOnCheckpointingErrors()
void setFailOnCheckpointingErrors(java.lang.Boolean failOnCheckpointingErrors)
@Default.Integer(value=-1) java.lang.Integer getNumberOfExecutionRetries()
void setNumberOfExecutionRetries(java.lang.Integer retries)
@Default.Long(value=-1L) java.lang.Long getExecutionRetryDelay()
void setExecutionRetryDelay(java.lang.Long delay)
@Default.Boolean(value=false) java.lang.Boolean getObjectReuse()
void setObjectReuse(java.lang.Boolean reuse)
java.lang.Class<? extends FlinkStateBackendFactory> getStateBackendFactory()
void setStateBackendFactory(java.lang.Class<? extends FlinkStateBackendFactory> stateBackendFactory)
@Default.Boolean(value=false) java.lang.Boolean getDisableMetrics()
void setDisableMetrics(java.lang.Boolean enableMetrics)
@Default.Boolean(value=false) java.lang.Boolean isExternalizedCheckpointsEnabled()
void setExternalizedCheckpointsEnabled(java.lang.Boolean externalCheckpoints)
@Default.Boolean(value=false) java.lang.Boolean getRetainExternalizedCheckpointsOnCancellation()
void setRetainExternalizedCheckpointsOnCancellation(java.lang.Boolean retainOnCancellation)
@Default.Long(value=1000L) java.lang.Long getMaxBundleSize()
void setMaxBundleSize(java.lang.Long size)
@Default.Long(value=1000L) java.lang.Long getMaxBundleTimeMills()
void setMaxBundleTimeMills(java.lang.Long time)
@Default.Boolean(value=false) java.lang.Boolean isShutdownSourcesOnFinalWatermark()
+Inf
. For production use cases
you want this to be disabled because Flink will currently (versions <= 1.5) stop
doing checkpoints when any operator (which includes sources) is finished.
Please see FLINK-2491 for progress on this issue.
void setShutdownSourcesOnFinalWatermark(java.lang.Boolean shutdownOnFinalWatermark)
@Default.Long(value=0L) java.lang.Long getLatencyTrackingInterval()
void setLatencyTrackingInterval(java.lang.Long interval)
java.lang.Long getAutoWatermarkInterval()
void setAutoWatermarkInterval(java.lang.Long interval)
@Default.String(value="PIPELINED") java.lang.String getExecutionModeForBatch()
void setExecutionModeForBatch(java.lang.String executionMode)
java.lang.String getSavepointPath()
void setSavepointPath(java.lang.String path)
@Default.Boolean(value=false) java.lang.Boolean getAllowNonRestoredState()
void setAllowNonRestoredState(java.lang.Boolean allowNonRestoredState)
@Default.Boolean(value=false) java.lang.Boolean isAutoBalanceWriteFilesShardingEnabled()
void setAutoBalanceWriteFilesShardingEnabled(java.lang.Boolean autoBalanceWriteFilesShardingEnabled)