Google Cloud Dataflow SDK for Java, version 1.9.1
Package com.google.cloud.dataflow.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.BlockingDataflowPipelineOptions Options that are used to configure theBlockingDataflowPipelineRunner
.CloudDebuggerOptions Options for controlling Cloud Debugger.DataflowPipelineDebugOptions Internal.DataflowPipelineOptions Options that can be used to configure theDataflowPipeline
.DataflowPipelineWorkerPoolOptions Options that are used to configure the Dataflow pipeline worker pool.DataflowProfilingOptions Options for controlling profiling of pipeline execution.DataflowWorkerHarnessOptions Options that are used exclusively within the Dataflow worker harness.DataflowWorkerLoggingOptions Options that are used to control logging configuration on the Dataflow worker.DefaultValueFactory<T> An interface used with theDefault.InstanceFactory
annotation to specify the class that will be an instance factory to produce default values for a given getter onPipelineOptions
.DirectPipelineOptions Options that can be used to configure theDirectPipeline
.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 theirPipelineOptions
registered with this SDK by creating aServiceLoader
entry and a concrete implementation of this interface.StreamingOptions Options used to configure streaming.ValueProvider<T> ValueProvider
is an interface which abstracts the notion of fetching a value that may or may not be currently available. -
Class Summary Class Description BlockingDataflowPipelineOptions.StandardOutputFactory Returns a default ofSystem.out
.DataflowPipelineDebugOptions.DataflowClientFactory Returns the default Dataflow client built from the passed in PipelineOptions.DataflowPipelineDebugOptions.PathValidatorFactory Creates aPathValidator
object using the class specified inDataflowPipelineDebugOptions.getPathValidatorClass()
.DataflowPipelineDebugOptions.StagerFactory Creates aStager
object using the class specified inDataflowPipelineDebugOptions.getStagerClass()
.DataflowPipelineOptions.JobNameFactory Returns a normalized job name constructed fromApplicationNameOptions.getAppName()
, the local system user name (if available), and the current time.DataflowPipelineWorkerPoolOptions.WorkerHarnessContainerImageFactory Returns the default Docker container image that executes Dataflow worker harness, residing in Google Container Registry.DataflowProfilingOptions.DataflowProfilingAgentConfiguration Configuration the for profiling agent.DataflowWorkerLoggingOptions.WorkerLogLevelOverrides Defines a log level override for a specific class, package, or name.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.GcpUserCredentialsFactory Attempts to load the GCP credentials.GcsOptions.ExecutorServiceFactory Returns the defaultExecutorService
to use within the Dataflow SDK.GoogleApiDebugOptions.GoogleApiTracer AGoogleClientRequestInitializer
that adds the trace destination to Google API calls.PipelineOptions.AtomicLongFactory DefaultValueFactory
which supplies an ID that is guaranteed to be unique within the given process.PipelineOptionsFactory Constructs aPipelineOptions
or any derived interface that is composable to any other derived interface ofPipelineOptions
via thePipelineOptions.as(java.lang.Class<T>)
method.PipelineOptionsFactory.Builder A fluentPipelineOptions
builder.PipelineOptionsValidator Validates that thePipelineOptions
conforms to all theValidation
criteria.ValueProvider.Deserializer Deserializer forValueProvider
, which handles type marshalling.ValueProvider.NestedValueProvider<T,X> ValueProvider.NestedValueProvider
is an implementation ofValueProvider
that allows for wrapping anotherValueProvider
object.ValueProvider.RuntimeValueProvider<T> ValueProvider.RuntimeValueProvider
is an implementation ofValueProvider
that allows for a value to be provided at execution time rather than at graph construction time.ValueProvider.Serializer Serializer forValueProvider
.ValueProvider.StaticValueProvider<T> ValueProvider.StaticValueProvider
is an implementation ofValueProvider
that allows for a static value to be provided.ValueProviderUtils Utilities for working with theValueProvider
interface. -
Enum Summary Enum Description DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType Type of autoscaling algorithm to use.DataflowPipelineWorkerPoolOptions.TeardownPolicy Deprecated Dataflow Service will only support TEARDOWN_ALWAYS policy in the future.DataflowWorkerLoggingOptions.Level The set of log levels that can be used on the Dataflow worker.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 onPipelineOptions
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 specifiedClass
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 typeDefaultValueFactory
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 specifiedString
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 onPipelineOptions
with information representing the validation criteria to be used when validating with thePipelineOptionsValidator
.Validation.Required This criteria specifies that the value must be not null.
Package com.google.cloud.dataflow.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
.