org.apache.beam.sdk.options

Interface PortablePipelineOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

All Known Subinterfaces:

SparkPortableStreamingPipelineOptions, TestPortablePipelineOptions, TestUniversalRunner.Options

@Experimental(value=PORTABILITY)
public interface PortablePipelineOptions
extends PipelineOptions

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()
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.util.List<java.lang.String>	getFilesToStage() List of local files to make available to workers.
java.lang.String	getJobEndpoint()
boolean	getLoadBalanceBundles()
@Nullable java.lang.String	getOutputExecutablePath()
int	getSdkWorkerParallelism()
void	setDefaultEnvironmentConfig(@Nullable java.lang.String config)
void	setDefaultEnvironmentType(java.lang.String environmentType)
void	setEnvironmentCacheMillis(int environmentCacheMillis)
void	setEnvironmentExpirationMillis(int environmentExpirationMillis)
void	setEnvironmentOptions(java.util.List<java.lang.String> value)
void	setFilesToStage(java.util.List<java.lang.String> value)
void	setJobEndpoint(java.lang.String endpoint)
void	setLoadBalanceBundles(boolean loadBalanceBundles)
void	setOutputExecutablePath(java.lang.String outputExecutablePath)
void	setSdkWorkerParallelism(int parallelism)

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

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

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

populateDisplayData

Method Detail

getFilesToStage

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

List of local files to make available to workers.

Files are placed on the worker's classpath.

The default value is the list of jars from the main program's classpath.

setFilesToStage

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

getJobEndpoint

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

setJobEndpoint

void setJobEndpoint(java.lang.String endpoint)

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.