Package org.apache.beam.sdk.options

Interface ExperimentalOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

All Known Subinterfaces:

DataflowPipelineDebugOptions, DataflowPipelineOptions, DataflowWorkerHarnessOptions, TestDataflowPipelineOptions

public interface ExperimentalOptions
extends PipelineOptions

Apache Beam provides a number of experimental features that can be enabled with this flag. If executing against a managed service, please contact the service owners before enabling any experiments.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STATE_CACHE_SIZE
static final String	STATE_SAMPLING_PERIOD_MILLIS

Method Summary

Modifier and Type	Method	Description
static void	addExperiment(ExperimentalOptions options, String experiment)	Adds experiment to options if not already present.
@Nullable List<String>	getExperiments()
static String	getExperimentValue(PipelineOptions options, String experiment)	Return the value for the specified experiment or null if not present.
static boolean	hasExperiment(PipelineOptions options, String experiment)	Returns true iff the provided pipeline options has the specified experiment enabled.
void	setExperiments(@Nullable List<String> 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

Field Details

STATE_CACHE_SIZE

static final String STATE_CACHE_SIZE

See Also:

• Constant Field Values

STATE_SAMPLING_PERIOD_MILLIS

static final String STATE_SAMPLING_PERIOD_MILLIS

See Also:

• Constant Field Values

Method Details

getExperiments

@Nullable List<String> getExperiments()

setExperiments

void setExperiments(@Nullable List<String> value)

hasExperiment

static boolean hasExperiment(PipelineOptions options,
 String experiment)

Returns true iff the provided pipeline options has the specified experiment enabled.

addExperiment

static void addExperiment(ExperimentalOptions options,
 String experiment)

Adds experiment to options if not already present.

getExperimentValue

static String getExperimentValue(PipelineOptions options,
 String experiment)

Return the value for the specified experiment or null if not present.