StreamingOptions (Apache Beam 2.67.0)

All Superinterfaces:: ApplicationNameOptions, HasDisplayData, PipelineOptions

All Known Subinterfaces:: BigQueryOptions, CloudResourceManagerOptions, DataflowPipelineOptions, DataflowWorkerHarnessOptions, FlinkPipelineOptions, PubsubOptions, SnowflakePipelineOptions, SpannerIO.SpannerChangeStreamOptions, SparkCommonPipelineOptions, SparkContextOptions, SparkPipelineOptions, SparkPortableStreamingPipelineOptions, SparkStructuredStreamingPipelineOptions, TestBigQueryOptions, TestDataflowPipelineOptions, TestPubsubOptions, TestSparkPipelineOptions, Twister2PipelineOptions

public interface StreamingOptions extends ApplicationNameOptions, PipelineOptions

Options used to configure streaming.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions
PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory
Method Summary

Modifier and Type

Method

Description

@Nullable String

getUpdateCompatibilityVersion()

boolean

isStreaming()

Set to true if running a streaming pipeline.

void

setStreaming(boolean value)

void

setUpdateCompatibilityVersion(@Nullable String updateCompatibilityVersion)

static boolean

updateCompatibilityVersionLessThan(PipelineOptions options, String version)

Methods inherited from interface org.apache.beam.sdk.options.ApplicationNameOptions
getAppName, setAppName

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 Details
- isStreaming
  
  @Hidden boolean isStreaming()
  
  Set to true if running a streaming pipeline. This will be automatically set to true if the pipeline contains an Unbounded PCollection.
- setStreaming
  
  void setStreaming(boolean value)
- getUpdateCompatibilityVersion
  
  @Nullable String getUpdateCompatibilityVersion()
- setUpdateCompatibilityVersion
  
  void setUpdateCompatibilityVersion(@Nullable String updateCompatibilityVersion)
- updateCompatibilityVersionLessThan
  
  static boolean updateCompatibilityVersionLessThan(PipelineOptions options, String version)