com.google.cloud.dataflow.sdk.options

Interface PipelineOptions

All Known Subinterfaces:

ApplicationNameOptions, BigQueryOptions, BlockingDataflowPipelineOptions, DataflowPipelineDebugOptions, DataflowPipelineOptions, DataflowPipelineWorkerPoolOptions, DataflowWorkerHarnessOptions, DataflowWorkerLoggingOptions, DirectPipelineOptions, GcpOptions, GcsOptions, GoogleApiDebugOptions, StreamingOptions, TestDataflowPipelineOptions

public interface PipelineOptions

Dataflow SDK pipeline configuration options.

Serialization

For runners which execute their work remotely, every property available within PipelineOptions must either be serializable using Jackson's ObjectMapper or the getter method for the property annotated with @JsonIgnore.

It is an error to have the same property available in multiple interfaces with only some of them being annotated with @JsonIgnore. It is also an error to mark a setter for a property with @JsonIgnore.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends PipelineOptions> T	as(java.lang.Class<T> kls) Transforms this object into an object of type <T>.
java.lang.Class<? extends PipelineRunner<?>>	getRunner()
void	setRunner(java.lang.Class<? extends PipelineRunner<?>> kls)

Method Detail

as

<T extends PipelineOptions> T as(java.lang.Class<T> kls)

Transforms this object into an object of type <T>. <T> must extend PipelineOptions.

If <T> is not registered with the PipelineOptionsFactory, then we attempt to verify that <T> is composable with every interface that this instance of the PipelineOptions has seen.

Parameters:

kls - The class of the type to transform to.

Returns:

An object of type kls.

getRunner

java.lang.Class<? extends PipelineRunner<?>> getRunner()

setRunner

void setRunner(java.lang.Class<? extends PipelineRunner<?>> kls)