Package org.apache.beam.sdk.options

Interface DefaultValueFactory<T>

Type Parameters:
T - The type of object this factory produces.
All Known Implementing Classes:
AwsOptions.AwsRegionFactory, AwsOptions.AwsUserCredentialsFactory, AzureOptions.AzureUserCredentialsFactory, CosmosOptions.CosmosClientBuilderFactory, DataflowPipelineDebugOptions.DataflowClientFactory, DataflowPipelineDebugOptions.StagerFactory, DataflowPipelineDebugOptions.UnboundedReaderMaxReadTimeFactory, DataflowPipelineOptions.StagingLocationFactory, DataflowStreamingPipelineOptions.EnableWindmillServiceDirectPathFactory, DataflowStreamingPipelineOptions.GlobalConfigRefreshPeriodFactory, DataflowStreamingPipelineOptions.HarnessUpdateReportingPeriodFactory, DataflowStreamingPipelineOptions.LocalWindmillHostportFactory, DataflowStreamingPipelineOptions.MaxStackTraceDepthToReportFactory, DataflowStreamingPipelineOptions.PeriodicStatusPageDirectoryFactory, DataflowStreamingPipelineOptions.WindmillServiceStreamingRpcBatchLimitFactory, DefaultGcpRegionFactory, DirectOptions.AvailableParallelismFactory, ExecutorOptions.ScheduledExecutorServiceFactory, ExpansionServiceOptions.ExpansionServiceConfigFactory, ExpansionServiceOptions.JavaClassLookupAllowListFactory, FlinkPipelineOptions.MaxBundleSizeFactory, FlinkPipelineOptions.MaxBundleTimeFactory, GcpOptions.DefaultProjectFactory, GcpOptions.EnableStreamingEngineFactory, GcpOptions.GcpOAuthScopesFactory, GcpOptions.GcpTempLocationFactory, GcpOptions.GcpUserCredentialsFactory, GcsOptions.ExecutorServiceFactory, GcsOptions.PathValidatorFactory, GcsUtil.GcsReadOptionsFactory, GcsUtil.GcsUtilFactory, GoogleAdsOptions.GoogleAdsCredentialsFactory, HadoopFileSystemOptions.ConfigurationLocator, KinesisIOOptions.MapFactory, MetricsOptions.NoOpMetricsSink, PipelineOptions.AtomicLongFactory, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory, ResourceHintsOptions.EmptyListDefault, S3Options.S3UploadBufferSizeBytesFactory, S3Options.SSECustomerKeyFactory, SdkHarnessOptions.BundleProcessorCacheTimeoutFactory, SdkHarnessOptions.DefaultMaxCacheMemoryUsageMbFactory, SparkCommonPipelineOptions.StorageLevelFactory, SparkCommonPipelineOptions.TmpCheckpointDirFactory, SparkContextOptions.EmptyListenersList, TestPipelineOptions.AlwaysPassMatcherFactory, TestPortablePipelineOptions.DefaultJobServerConfigFactory, TestSparkPipelineOptions.DefaultStopPipelineWatermarkFactory
public interface 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. When a property on a PipelineOptions is fetched, and is currently unset, the default value factory will be instantiated and invoked.

Care must be taken to not produce an infinite loop when accessing other fields on the PipelineOptions object.

  • Method Details

    • create

      T create(PipelineOptions options)
      Creates a default value for a getter marked with Default.InstanceFactory.
      Parameters:
      options - The current pipeline options.
      Returns:
      The default value to be used for the annotated getter.