Package org.apache.beam.sdk.options

Defines PipelineOptions for configuring pipeline execution.

See: Description

Interface Summary

Interface	Description
ApplicationNameOptions	Options that allow setting the application name.
BigQueryOptions	Properties needed when using BigQuery with the Dataflow SDK.
DefaultValueFactory<T>	An interface used with the Default.InstanceFactory annotation to specify the class that will be an instance factory to produce default values for a given getter on PipelineOptions.
GcpOptions	Options used to configure Google Cloud Platform project and credentials.
GcsOptions	Options used to configure Google Cloud Storage.
GoogleApiDebugOptions	These options configure debug settings for Google API clients created within the Dataflow SDK.
PipelineOptions	PipelineOptions are used to configure Pipelines.
PipelineOptionsRegistrar	PipelineOptions creators have the ability to automatically have their PipelineOptions registered with this SDK by creating a ServiceLoader entry and a concrete implementation of this interface.
PubsubOptions	Properties that can be set when using Pubsub with the Beam SDK.
StreamingOptions	Options used to configure streaming.

Class Summary

Class	Description
DefaultPipelineOptionsRegistrar	A registrar containing the default SDK options.
GcpOptions.CredentialDirFactory	Returns the default credential directory of ${user.home}/.store/data-flow.
GcpOptions.DefaultProjectFactory	Attempts to infer the default project based upon the environment this application is executing within.
GcpOptions.GcpTempLocationFactory	Returns PipelineOptions.getTempLocation() as the default GCP temp location.
GcpOptions.GcpUserCredentialsFactory	Attempts to load the GCP credentials.
GcsOptions.ExecutorServiceFactory	Returns the default ExecutorService to use within the Dataflow SDK.
GoogleApiDebugOptions.GoogleApiTracer	A GoogleClientRequestInitializer that adds the trace destination to Google API calls.
PipelineOptions.DirectRunner	A DefaultValueFactory that obtains the class of the DirectRunner if it exists on the classpath, and throws an exception otherwise.
PipelineOptionsFactory	Constructs a PipelineOptions or any derived interface that is composable to any other derived interface of PipelineOptions via the PipelineOptions.as(java.lang.Class<T>) method.
PipelineOptionsFactory.Builder	A fluent PipelineOptions builder.
PipelineOptionsValidator	Validates that the PipelineOptions conforms to all the Validation criteria.

Enum Summary

Enum	Description
PipelineOptions.CheckEnabled	Enumeration of the possible states for a given check.

Annotation Types Summary

Annotation Type	Description
Default	Default represents a set of annotations that can be used to annotate getter properties on PipelineOptions with information representing the default value to be returned if no value is specified.
Default.Boolean	This represents that the default of the option is the specified boolean primitive value.
Default.Byte	This represents that the default of the option is the specified byte primitive value.
Default.Character	This represents that the default of the option is the specified char primitive value.
Default.Class	This represents that the default of the option is the specified Class value.
Default.Double	This represents that the default of the option is the specified double primitive value.
Default.Enum	This represents that the default of the option is the specified enum.
Default.Float	This represents that the default of the option is the specified float primitive value.
Default.InstanceFactory	Value must be of type DefaultValueFactory and have a default constructor.
Default.Integer	This represents that the default of the option is the specified int primitive value.
Default.Long	This represents that the default of the option is the specified long primitive value.
Default.Short	This represents that the default of the option is the specified short primitive value.
Default.String	This represents that the default of the option is the specified String value.
Description	Descriptions are used to generate human readable output when the --help command is specified.
Hidden	Methods and/or interfaces annotated with @Hidden will be suppressed from being output when --help is specified on the command-line.
Validation	Validation represents a set of annotations that can be used to annotate getter properties on PipelineOptions with information representing the validation criteria to be used when validating with the PipelineOptionsValidator.
Validation.Required	This criteria specifies that the value must be not null.

Package org.apache.beam.sdk.options Description

Defines PipelineOptions for configuring pipeline execution.

PipelineOptions encapsulates the various parameters that describe how a pipeline should be run. PipelineOptions are created using a PipelineOptionsFactory.