org.apache.beam.sdk.options

Interface PortablePipelineOptions

All Superinterfaces:

FileStagingOptions, HasDisplayData, PipelineOptions

All Known Subinterfaces:

PrismPipelineOptions, SparkPortableStreamingPipelineOptions, TestPortablePipelineOptions, TestPrismPipelineOptions, TestUniversalRunner.Options

public interface PortablePipelineOptions
extends PipelineOptions, FileStagingOptions

Pipeline options common to all portable runners.

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 and Description
@Nullable java.lang.String	getDefaultEnvironmentConfig()
@Nullable java.lang.String	getDefaultEnvironmentType()
boolean	getEnableHeapDumps() If true and PipelineOption tempLocation is set, save a heap dump before shutting down the JVM due to GC thrashing or out of memory.
int	getEnvironmentCacheMillis()
int	getEnvironmentExpirationMillis()
static java.lang.String	getEnvironmentOption(PortablePipelineOptions options, java.lang.String environmentOptionName) Return the value for the specified environment option or empty string if not present.
java.util.List<java.lang.String>	getEnvironmentOptions()
java.lang.String	getJobEndpoint()
int	getJobServerTimeout()
boolean	getLoadBalanceBundles()
@Nullable java.lang.String	getOutputExecutablePath()
int	getSdkWorkerParallelism()
void	setDefaultEnvironmentConfig(@Nullable java.lang.String config)
void	setDefaultEnvironmentType(java.lang.String environmentType)
void	setEnableHeapDumps(boolean enableHeapDumps)
void	setEnvironmentCacheMillis(int environmentCacheMillis)
void	setEnvironmentExpirationMillis(int environmentExpirationMillis)
void	setEnvironmentOptions(java.util.List<java.lang.String> value)
void	setJobEndpoint(java.lang.String endpoint)
void	setJobServerTimeout(int timeout)
void	setLoadBalanceBundles(boolean loadBalanceBundles)
void	setOutputExecutablePath(java.lang.String outputExecutablePath)
void	setSdkWorkerParallelism(int parallelism)

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

getFilesToStage, setFilesToStage

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

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

populateDisplayData

Method Detail

getJobEndpoint

@Validation.Required
java.lang.String getJobEndpoint()

setJobEndpoint

void setJobEndpoint(java.lang.String endpoint)

getJobServerTimeout

@Default.Integer(value=60)
int getJobServerTimeout()

setJobServerTimeout

void setJobServerTimeout(int timeout)

getDefaultEnvironmentType

@Nullable java.lang.String getDefaultEnvironmentType()

setDefaultEnvironmentType

void setDefaultEnvironmentType(java.lang.String environmentType)

getDefaultEnvironmentConfig

@Nullable java.lang.String getDefaultEnvironmentConfig()

setDefaultEnvironmentConfig

void setDefaultEnvironmentConfig(@Nullable java.lang.String config)

getSdkWorkerParallelism

@Default.Integer(value=1)
int getSdkWorkerParallelism()

setSdkWorkerParallelism

void setSdkWorkerParallelism(int parallelism)

getEnvironmentCacheMillis

@Default.Integer(value=0)
int getEnvironmentCacheMillis()

setEnvironmentCacheMillis

void setEnvironmentCacheMillis(int environmentCacheMillis)

getEnvironmentExpirationMillis

@Default.Integer(value=0)
int getEnvironmentExpirationMillis()

setEnvironmentExpirationMillis

void setEnvironmentExpirationMillis(int environmentExpirationMillis)

getLoadBalanceBundles

@Default.Boolean(value=false)
boolean getLoadBalanceBundles()

setLoadBalanceBundles

void setLoadBalanceBundles(boolean loadBalanceBundles)

getOutputExecutablePath

@Nullable java.lang.String getOutputExecutablePath()

setOutputExecutablePath

void setOutputExecutablePath(java.lang.String outputExecutablePath)

getEnvironmentOptions

java.util.List<java.lang.String> getEnvironmentOptions()

setEnvironmentOptions

void setEnvironmentOptions(java.util.List<java.lang.String> value)

getEnvironmentOption

static java.lang.String getEnvironmentOption(PortablePipelineOptions options,
                                             java.lang.String environmentOptionName)

Return the value for the specified environment option or empty string if not present.

getEnableHeapDumps

@Default.Boolean(value=false)
boolean getEnableHeapDumps()

If true and PipelineOption tempLocation is set, save a heap dump before shutting down the JVM due to GC thrashing or out of memory. The heap will be dumped to local disk and then uploaded to the tempLocation.

CAUTION: Heap dumps can take up more disk than the JVM memory. Ensure the local disk is configured to have sufficient free space before enabling this option.

setEnableHeapDumps

void setEnableHeapDumps(boolean enableHeapDumps)