Package org.apache.beam.runners.dataflow.options

Interface DataflowStreamingPipelineOptions

All Superinterfaces:

org.apache.beam.sdk.transforms.display.HasDisplayData, org.apache.beam.sdk.options.PipelineOptions

All Known Subinterfaces:

DataflowPipelineOptions, DataflowWorkerHarnessOptions, TestDataflowPipelineOptions

@Hidden
public interface DataflowStreamingPipelineOptions
extends org.apache.beam.sdk.options.PipelineOptions

[Internal] Options for configuring StreamingDataflowWorker.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DataflowStreamingPipelineOptions.EnableWindmillServiceDirectPathFactory	EnableStreamingEngine defaults to false unless one of the experiment is set.
static class	DataflowStreamingPipelineOptions.GlobalConfigRefreshPeriodFactory	Read global get config request period from system property 'windmill.global_config_refresh_period'.
static class	DataflowStreamingPipelineOptions.HarnessUpdateReportingPeriodFactory	Read counter reporting period from system property 'windmill.harness_update_reporting_period'.
static class	DataflowStreamingPipelineOptions.LocalWindmillHostportFactory	Factory for creating local Windmill address.
static class	DataflowStreamingPipelineOptions.MaxStackTraceDepthToReportFactory	Read 'MaxStackTraceToReport' from system property 'windmill.max_stack_trace_to_report' or Integer.MAX_VALUE if unspecified.
static class	DataflowStreamingPipelineOptions.PeriodicStatusPageDirectoryFactory	Read 'PeriodicStatusPageOutputDirector' from system property 'windmill.periodic_status_page_directory' or null if unspecified.
static class	DataflowStreamingPipelineOptions.WindmillServiceStreamingRpcBatchLimitFactory	Factory for setting value of WindmillServiceStreamingRpcBatchLimit based on environment.

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions

org.apache.beam.sdk.options.PipelineOptions.AtomicLongFactory, org.apache.beam.sdk.options.PipelineOptions.CheckEnabled, org.apache.beam.sdk.options.PipelineOptions.DirectRunner, org.apache.beam.sdk.options.PipelineOptions.JobNameFactory, org.apache.beam.sdk.options.PipelineOptions.UserAgentFactory

Method Summary

Modifier and Type	Method	Description
int	getActiveWorkRefreshPeriodMillis()
boolean	getChannelzShowOnlyWindmillServiceChannels()
org.joda.time.Duration	getGlobalConfigRefreshPeriod()
boolean	getIsWindmillServiceDirectPathEnabled()
java.lang.String	getLocalWindmillHostport()
int	getMaxBundlesFromWindmillOutstanding()	Maximum number of bundles outstanding from windmill before the worker stops requesting.
long	getMaxBytesFromWindmillOutstanding()	Maximum number of bytes outstanding from windmill before the worker stops requesting.
int	getMaxStackTraceDepthToReport()
java.lang.String	getOverrideWindmillBinary()	Custom windmill_main binary to use with the streaming runner.
java.lang.String	getPeriodicStatusPageOutputDirectory()
int	getPerWorkerMetricsUpdateReportingPeriodMillis()
java.lang.Integer	getStreamingSideInputCacheExpirationMillis()
java.lang.Integer	getStreamingSideInputCacheMb()
int	getStuckCommitDurationMillis()
java.lang.Boolean	getUseSeparateWindmillHeartbeatStreams()
java.lang.Boolean	getUseWindmillIsolatedChannels()
int	getWindmillGetDataStreamCount()
org.joda.time.Duration	getWindmillHarnessUpdateReportingPeriod()
int	getWindmillMessagesBetweenIsReadyChecks()
boolean	getWindmillRequestBatchedGetWorkResponse()
java.lang.Integer	getWindmillServiceCommitThreads()
java.lang.String	getWindmillServiceEndpoint()	Custom windmill service endpoint.
int	getWindmillServicePort()
int	getWindmillServiceRpcChannelAliveTimeoutSec()
int	getWindmillServiceStreamingLogEveryNStreamFailures()
int	getWindmillServiceStreamingRpcBatchLimit()
int	getWindmillServiceStreamingRpcHealthCheckPeriodMs()
int	getWindmillServiceStreamMaxBackoffMillis()
void	setActiveWorkRefreshPeriodMillis(int value)
void	setChannelzShowOnlyWindmillServiceChannels(boolean value)
void	setGlobalConfigRefreshPeriod(org.joda.time.Duration value)
void	setIsWindmillServiceDirectPathEnabled(boolean isWindmillServiceDirectPathEnabled)
void	setLocalWindmillHostport(java.lang.String value)
void	setMaxBundlesFromWindmillOutstanding(int value)
void	setMaxBytesFromWindmillOutstanding(long value)
void	setMaxStackTraceDepthToReport(int value)
void	setOverrideWindmillBinary(java.lang.String value)
void	setPeriodicStatusPageOutputDirectory(java.lang.String directory)
void	setPerWorkerMetricsUpdateReportingPeriodMillis(int value)
void	setStreamingSideInputCacheExpirationMillis(java.lang.Integer value)
void	setStreamingSideInputCacheMb(java.lang.Integer value)
void	setStuckCommitDurationMillis(int value)
void	setUseSeparateWindmillHeartbeatStreams(java.lang.Boolean value)
void	setUseWindmillIsolatedChannels(java.lang.Boolean value)
void	setWindmillGetDataStreamCount(int value)
void	setWindmillHarnessUpdateReportingPeriod(org.joda.time.Duration value)
void	setWindmillMessagesBetweenIsReadyChecks(int value)
void	setWindmillRequestBatchedGetWorkResponse(boolean value)
void	setWindmillServiceCommitThreads(java.lang.Integer value)
void	setWindmillServiceEndpoint(java.lang.String value)
void	setWindmillServicePort(int value)
void	setWindmillServiceRpcChannelAliveTimeoutSec(int value)
void	setWindmillServiceStreamingLogEveryNStreamFailures(int value)
void	setWindmillServiceStreamingRpcBatchLimit(int value)
void	setWindmillServiceStreamingRpcHealthCheckPeriodMs(int value)
void	setWindmillServiceStreamMaxBackoffMillis(int value)

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

populateDisplayData

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Method Detail

getOverrideWindmillBinary

java.lang.String getOverrideWindmillBinary()

Custom windmill_main binary to use with the streaming runner.

setOverrideWindmillBinary

void setOverrideWindmillBinary(java.lang.String value)

getWindmillServiceEndpoint

java.lang.String getWindmillServiceEndpoint()

Custom windmill service endpoint.

setWindmillServiceEndpoint

void setWindmillServiceEndpoint(java.lang.String value)

getWindmillServicePort

@Integer(443)
int getWindmillServicePort()

setWindmillServicePort

void setWindmillServicePort(int value)

getLocalWindmillHostport

@InstanceFactory(LocalWindmillHostportFactory.class)
java.lang.String getLocalWindmillHostport()

setLocalWindmillHostport

void setLocalWindmillHostport(java.lang.String value)

getMaxBundlesFromWindmillOutstanding

@Integer(0)
int getMaxBundlesFromWindmillOutstanding()

Maximum number of bundles outstanding from windmill before the worker stops requesting.

If <= 0, use the default value of 100 + getNumberOfWorkerHarnessThreads()

setMaxBundlesFromWindmillOutstanding

void setMaxBundlesFromWindmillOutstanding(int value)

getMaxBytesFromWindmillOutstanding

@Long(0L)
long getMaxBytesFromWindmillOutstanding()

Maximum number of bytes outstanding from windmill before the worker stops requesting.

If <= 0, use the default value of 50% of jvm memory.

setMaxBytesFromWindmillOutstanding

void setMaxBytesFromWindmillOutstanding(long value)

getStreamingSideInputCacheMb

@Integer(100)
java.lang.Integer getStreamingSideInputCacheMb()

setStreamingSideInputCacheMb

void setStreamingSideInputCacheMb(java.lang.Integer value)

getStreamingSideInputCacheExpirationMillis

@Integer(60000)
java.lang.Integer getStreamingSideInputCacheExpirationMillis()

setStreamingSideInputCacheExpirationMillis

void setStreamingSideInputCacheExpirationMillis(java.lang.Integer value)

getWindmillServiceCommitThreads

@Integer(1)
java.lang.Integer getWindmillServiceCommitThreads()

setWindmillServiceCommitThreads

void setWindmillServiceCommitThreads(java.lang.Integer value)

getActiveWorkRefreshPeriodMillis

@Integer(10000)
int getActiveWorkRefreshPeriodMillis()

setActiveWorkRefreshPeriodMillis

void setActiveWorkRefreshPeriodMillis(int value)

getWindmillServiceStreamingRpcHealthCheckPeriodMs

@Integer(10000)
int getWindmillServiceStreamingRpcHealthCheckPeriodMs()

setWindmillServiceStreamingRpcHealthCheckPeriodMs

void setWindmillServiceStreamingRpcHealthCheckPeriodMs(int value)

getWindmillMessagesBetweenIsReadyChecks

@Integer(10)
int getWindmillMessagesBetweenIsReadyChecks()

setWindmillMessagesBetweenIsReadyChecks

void setWindmillMessagesBetweenIsReadyChecks(int value)

getUseWindmillIsolatedChannels

java.lang.Boolean getUseWindmillIsolatedChannels()

setUseWindmillIsolatedChannels

void setUseWindmillIsolatedChannels(java.lang.Boolean value)

getUseSeparateWindmillHeartbeatStreams

java.lang.Boolean getUseSeparateWindmillHeartbeatStreams()

setUseSeparateWindmillHeartbeatStreams

void setUseSeparateWindmillHeartbeatStreams(java.lang.Boolean value)

getWindmillRequestBatchedGetWorkResponse

@Boolean(true)
boolean getWindmillRequestBatchedGetWorkResponse()

setWindmillRequestBatchedGetWorkResponse

void setWindmillRequestBatchedGetWorkResponse(boolean value)

getWindmillGetDataStreamCount

@Integer(1)
int getWindmillGetDataStreamCount()

setWindmillGetDataStreamCount

void setWindmillGetDataStreamCount(int value)

getChannelzShowOnlyWindmillServiceChannels

@Boolean(true)
boolean getChannelzShowOnlyWindmillServiceChannels()

setChannelzShowOnlyWindmillServiceChannels

void setChannelzShowOnlyWindmillServiceChannels(boolean value)

getWindmillHarnessUpdateReportingPeriod

@InstanceFactory(HarnessUpdateReportingPeriodFactory.class)
org.joda.time.Duration getWindmillHarnessUpdateReportingPeriod()

setWindmillHarnessUpdateReportingPeriod

void setWindmillHarnessUpdateReportingPeriod(org.joda.time.Duration value)

getPerWorkerMetricsUpdateReportingPeriodMillis

@Integer(30000)
int getPerWorkerMetricsUpdateReportingPeriodMillis()

setPerWorkerMetricsUpdateReportingPeriodMillis

void setPerWorkerMetricsUpdateReportingPeriodMillis(int value)

getMaxStackTraceDepthToReport

@InstanceFactory(MaxStackTraceDepthToReportFactory.class)
int getMaxStackTraceDepthToReport()

setMaxStackTraceDepthToReport

void setMaxStackTraceDepthToReport(int value)

getStuckCommitDurationMillis

@Integer(600000)
int getStuckCommitDurationMillis()

setStuckCommitDurationMillis

void setStuckCommitDurationMillis(int value)

getGlobalConfigRefreshPeriod

@InstanceFactory(GlobalConfigRefreshPeriodFactory.class)
org.joda.time.Duration getGlobalConfigRefreshPeriod()

setGlobalConfigRefreshPeriod

void setGlobalConfigRefreshPeriod(org.joda.time.Duration value)

getPeriodicStatusPageOutputDirectory

@InstanceFactory(PeriodicStatusPageDirectoryFactory.class)
java.lang.String getPeriodicStatusPageOutputDirectory()

setPeriodicStatusPageOutputDirectory

void setPeriodicStatusPageOutputDirectory(java.lang.String directory)

getWindmillServiceStreamingRpcBatchLimit

@InstanceFactory(WindmillServiceStreamingRpcBatchLimitFactory.class)
int getWindmillServiceStreamingRpcBatchLimit()

setWindmillServiceStreamingRpcBatchLimit

void setWindmillServiceStreamingRpcBatchLimit(int value)

getWindmillServiceStreamingLogEveryNStreamFailures

@Integer(20)
int getWindmillServiceStreamingLogEveryNStreamFailures()

setWindmillServiceStreamingLogEveryNStreamFailures

void setWindmillServiceStreamingLogEveryNStreamFailures(int value)

getWindmillServiceRpcChannelAliveTimeoutSec

@Integer(40)
int getWindmillServiceRpcChannelAliveTimeoutSec()

setWindmillServiceRpcChannelAliveTimeoutSec

void setWindmillServiceRpcChannelAliveTimeoutSec(int value)

getWindmillServiceStreamMaxBackoffMillis

@Integer(30000)
int getWindmillServiceStreamMaxBackoffMillis()

setWindmillServiceStreamMaxBackoffMillis

void setWindmillServiceStreamMaxBackoffMillis(int value)

getIsWindmillServiceDirectPathEnabled

@InstanceFactory(EnableWindmillServiceDirectPathFactory.class)
boolean getIsWindmillServiceDirectPathEnabled()

setIsWindmillServiceDirectPathEnabled

void setIsWindmillServiceDirectPathEnabled(boolean isWindmillServiceDirectPathEnabled)