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

Interface DataflowStreamingPipelineOptions

All Superinterfaces:
HasDisplayData, PipelineOptions
All Known Subinterfaces:
DataflowPipelineOptions, DataflowWorkerHarnessOptions, TestDataflowPipelineOptions
@Hidden public interface DataflowStreamingPipelineOptions extends PipelineOptions
[Internal] Options for configuring StreamingDataflowWorker.

  • Method Details

    • getOverrideWindmillBinary

      String getOverrideWindmillBinary()
      Custom windmill_main binary to use with the streaming runner.

    • setOverrideWindmillBinary

      void setOverrideWindmillBinary(String value)

    • getWindmillServiceEndpoint

      String getWindmillServiceEndpoint()
      Custom windmill service endpoint.

    • setWindmillServiceEndpoint

      void setWindmillServiceEndpoint(String value)

    • getWindmillServicePort

      @Integer(443) int getWindmillServicePort()

    • setWindmillServicePort

      void setWindmillServicePort(int value)

    • getLocalWindmillHostport

      @InstanceFactory(LocalWindmillHostportFactory.class) String getLocalWindmillHostport()

    • setLocalWindmillHostport

      void setLocalWindmillHostport(String value)

    • getMaxBundlesFromWindmillOutstanding

      @Integer(0) int getMaxBundlesFromWindmillOutstanding()
      Maximum number of bundles outstanding from windmill before the worker stops requesting.

      If invalid input: '<'= 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 invalid input: '<'= 0, use the default value of 50% of jvm memory.

    • setMaxBytesFromWindmillOutstanding

      void setMaxBytesFromWindmillOutstanding(long value)

    • getStreamingSideInputCacheMb

      @Integer(100) Integer getStreamingSideInputCacheMb()

    • setStreamingSideInputCacheMb

      void setStreamingSideInputCacheMb(Integer value)

    • getStreamingSideInputCacheExpirationMillis

      @Integer(60000) Integer getStreamingSideInputCacheExpirationMillis()

    • setStreamingSideInputCacheExpirationMillis

      void setStreamingSideInputCacheExpirationMillis(Integer value)

    • getWindmillServiceCommitThreads

      @Integer(1) Integer getWindmillServiceCommitThreads()

    • setWindmillServiceCommitThreads

      void setWindmillServiceCommitThreads(Integer value)

    • getWindmillServiceDirectPathCommitThreads

      @Integer(1) Integer getWindmillServiceDirectPathCommitThreads()

    • setWindmillServiceDirectPathCommitThreads

      void setWindmillServiceDirectPathCommitThreads(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

      @Deprecated Boolean getUseWindmillIsolatedChannels()
      Deprecated.
      since 2.73.0

    • setUseWindmillIsolatedChannels

      void setUseWindmillIsolatedChannels(Boolean value)

    • getUseSeparateWindmillHeartbeatStreams

      @Deprecated Boolean getUseSeparateWindmillHeartbeatStreams()
      Deprecated.
      since beam 2.73.0

    • setUseSeparateWindmillHeartbeatStreams

      void setUseSeparateWindmillHeartbeatStreams(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) Duration getWindmillHarnessUpdateReportingPeriod()

    • setWindmillHarnessUpdateReportingPeriod

      void setWindmillHarnessUpdateReportingPeriod(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(3600000) int getStuckCommitDurationMillis()

    • setStuckCommitDurationMillis

      void setStuckCommitDurationMillis(int value)

    • getCommitWorkStreamRetryTimeoutMillis

      @InstanceFactory(CommitWorkStreamRetryTimeoutMillisFactory.class) long getCommitWorkStreamRetryTimeoutMillis()

    • setCommitWorkStreamRetryTimeoutMillis

      void setCommitWorkStreamRetryTimeoutMillis(long value)

    • getGlobalConfigRefreshPeriod

      @InstanceFactory(GlobalConfigRefreshPeriodFactory.class) Duration getGlobalConfigRefreshPeriod()

    • setGlobalConfigRefreshPeriod

      void setGlobalConfigRefreshPeriod(Duration value)

    • getPeriodicStatusPageOutputDirectory

      @InstanceFactory(PeriodicStatusPageDirectoryFactory.class) String getPeriodicStatusPageOutputDirectory()

    • setPeriodicStatusPageOutputDirectory

      void setPeriodicStatusPageOutputDirectory(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)

    • getSkipInputElementsWithDecodingExceptions

      ValueProvider<Boolean> getSkipInputElementsWithDecodingExceptions()

    • setSkipInputElementsWithDecodingExceptions

      void setSkipInputElementsWithDecodingExceptions(ValueProvider<Boolean> value)

    • getIsWindmillServiceDirectPathEnabled

      @InstanceFactory(EnableWindmillServiceDirectPathFactory.class) boolean getIsWindmillServiceDirectPathEnabled()

    • setIsWindmillServiceDirectPathEnabled

      void setIsWindmillServiceDirectPathEnabled(boolean isWindmillServiceDirectPathEnabled)

    • getMaxWindmillStateCacheEntryBytes

      @Long(9223372036854775807L) Long getMaxWindmillStateCacheEntryBytes()
      The maximum size of cached entries in bytes. Entries (eg: values, bags) larger than this limit will not be cached by the windmill state cache

    • setMaxWindmillStateCacheEntryBytes

      void setMaxWindmillStateCacheEntryBytes(Long value)