org.apache.beam.sdk.options

Interface PortablePipelineOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

All Known Subinterfaces:

TestPortablePipelineOptions

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.NoOpMetricsSink, PipelineOptions.UserAgentFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SDK_WORKER_PARALLELISM_PIPELINE
static java.lang.String	SDK_WORKER_PARALLELISM_STAGE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultEnvironmentConfig()
java.lang.String	getDefaultEnvironmentType()
java.lang.String	getDefaultJavaEnvironmentUrl()
java.util.List<java.lang.String>	getFilesToStage() List of local files to make available to workers.
java.lang.String	getJobEndpoint()
java.lang.String	getSdkWorkerParallelism()
void	setDefaultEnvironmentConfig(java.lang.String config)
void	setDefaultEnvironmentType(java.lang.String environmentType)
void	setDefaultJavaEnvironmentUrl(java.lang.String url)
void	setFilesToStage(java.util.List<java.lang.String> value)
void	setJobEndpoint(java.lang.String endpoint)
void	setSdkWorkerParallelism(java.lang.String parallelism)

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

as, getJobName, getMetricsHttpSinkUrl, getMetricsPushPeriod, getMetricsSink, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, setJobName, setMetricsHttpSinkUrl, setMetricsPushPeriod, setMetricsSink, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

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

populateDisplayData

Field Detail

SDK_WORKER_PARALLELISM_PIPELINE

static final java.lang.String SDK_WORKER_PARALLELISM_PIPELINE

See Also:

Constant Field Values

SDK_WORKER_PARALLELISM_STAGE

static final java.lang.String SDK_WORKER_PARALLELISM_STAGE

See Also:

Constant Field Values

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)

getDefaultJavaEnvironmentUrl

java.lang.String getDefaultJavaEnvironmentUrl()

setDefaultJavaEnvironmentUrl

void setDefaultJavaEnvironmentUrl(java.lang.String url)

getJobEndpoint

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

setJobEndpoint

void setJobEndpoint(java.lang.String endpoint)

getDefaultEnvironmentType

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

@Nullable
java.lang.String getSdkWorkerParallelism()

setSdkWorkerParallelism

void setSdkWorkerParallelism(@Nullable
                             java.lang.String parallelism)