| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>DefaultValueFactory (Apache Beam 2.38.0-SNAPSHOT)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DefaultValueFactory (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/beam/sdk/options/DefaultPipelineOptionsRegistrar.html" title="class in org.apache.beam.sdk.options"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/options/Description.html" title="annotation in org.apache.beam.sdk.options"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/options/DefaultValueFactory.html" target="_top">Frames</a></li> |
| <li><a href="DefaultValueFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.options</div> |
| <h2 title="Interface DefaultValueFactory" class="title">Interface DefaultValueFactory<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type of object this factory produces.</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/io/aws/options/AwsOptions.AwsRegionFactory.html" title="class in org.apache.beam.sdk.io.aws.options">AwsOptions.AwsRegionFactory</a>, <a href="../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.AwsRegionFactory.html" title="class in org.apache.beam.sdk.io.aws2.options">AwsOptions.AwsRegionFactory</a>, <a href="../../../../../org/apache/beam/sdk/io/aws/options/AwsOptions.AwsUserCredentialsFactory.html" title="class in org.apache.beam.sdk.io.aws.options">AwsOptions.AwsUserCredentialsFactory</a>, <a href="../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.AwsUserCredentialsFactory.html" title="class in org.apache.beam.sdk.io.aws2.options">AwsOptions.AwsUserCredentialsFactory</a>, <a href="../../../../../org/apache/beam/sdk/io/aws/options/AwsOptions.ClientConfigurationFactory.html" title="class in org.apache.beam.sdk.io.aws.options">AwsOptions.ClientConfigurationFactory</a>, <a href="../../../../../org/apache/beam/sdk/io/azure/options/BlobstoreOptions.AzureUserCredentialsFactory.html" title="class in org.apache.beam.sdk.io.azure.options">BlobstoreOptions.AzureUserCredentialsFactory</a>, <a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions.DataflowClientFactory</a>, <a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.StagerFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions.StagerFactory</a>, <a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.StagingLocationFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions.StagingLocationFactory</a>, <a href="../../../../../org/apache/beam/runners/dataflow/options/DefaultGcpRegionFactory.html" title="class in org.apache.beam.runners.dataflow.options">DefaultGcpRegionFactory</a>, <a href="../../../../../org/apache/beam/runners/direct/DirectOptions.AvailableParallelismFactory.html" title="class in org.apache.beam.runners.direct">DirectOptions.AvailableParallelismFactory</a>, <a href="../../../../../org/apache/beam/sdk/expansion/service/ExpansionServiceOptions.JavaClassLookupAllowListFactory.html" title="class in org.apache.beam.sdk.expansion.service">ExpansionServiceOptions.JavaClassLookupAllowListFactory</a>, <a href="../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.DefaultProjectFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.DefaultProjectFactory</a>, <a href="../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.EnableStreamingEngineFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.EnableStreamingEngineFactory</a>, <a href="../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.GcpTempLocationFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.GcpTempLocationFactory</a>, <a href="../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.GcpUserCredentialsFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.GcpUserCredentialsFactory</a>, <a href="../../../../../org/apache/beam/sdk/extensions/gcp/options/GcsOptions.ExecutorServiceFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcsOptions.ExecutorServiceFactory</a>, <a href="../../../../../org/apache/beam/sdk/extensions/gcp/options/GcsOptions.PathValidatorFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcsOptions.PathValidatorFactory</a>, <a href="../../../../../org/apache/beam/sdk/extensions/gcp/util/GcsUtil.GcsUtilFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.util">GcsUtil.GcsUtilFactory</a>, <a href="../../../../../org/apache/beam/sdk/io/hdfs/HadoopFileSystemOptions.ConfigurationLocator.html" title="class in org.apache.beam.sdk.io.hdfs">HadoopFileSystemOptions.ConfigurationLocator</a>, <a href="../../../../../org/apache/beam/sdk/metrics/MetricsOptions.NoOpMetricsSink.html" title="class in org.apache.beam.sdk.metrics">MetricsOptions.NoOpMetricsSink</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.AtomicLongFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.AtomicLongFactory</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.DirectRunner.html" title="class in org.apache.beam.sdk.options">PipelineOptions.DirectRunner</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.JobNameFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.JobNameFactory</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.UserAgentFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.UserAgentFactory</a>, <a href="../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHintsOptions.EmptyListDefault.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHintsOptions.EmptyListDefault</a>, <a href="../../../../../org/apache/beam/sdk/io/aws/options/S3Options.S3UploadBufferSizeBytesFactory.html" title="class in org.apache.beam.sdk.io.aws.options">S3Options.S3UploadBufferSizeBytesFactory</a>, <a href="../../../../../org/apache/beam/sdk/io/aws2/options/S3Options.S3UploadBufferSizeBytesFactory.html" title="class in org.apache.beam.sdk.io.aws2.options">S3Options.S3UploadBufferSizeBytesFactory</a>, <a href="../../../../../org/apache/beam/sdk/io/aws2/options/S3Options.SSECustomerKeyFactory.html" title="class in org.apache.beam.sdk.io.aws2.options">S3Options.SSECustomerKeyFactory</a>, <a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.DefaultMaxCacheMemoryUsageMbFactory.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.DefaultMaxCacheMemoryUsageMbFactory</a>, <a href="../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.TmpCheckpointDirFactory.html" title="class in org.apache.beam.runners.spark">SparkCommonPipelineOptions.TmpCheckpointDirFactory</a>, <a href="../../../../../org/apache/beam/runners/spark/SparkContextOptions.EmptyListenersList.html" title="class in org.apache.beam.runners.spark">SparkContextOptions.EmptyListenersList</a>, <a href="../../../../../org/apache/beam/sdk/testing/TestPipelineOptions.AlwaysPassMatcherFactory.html" title="class in org.apache.beam.sdk.testing">TestPipelineOptions.AlwaysPassMatcherFactory</a>, <a href="../../../../../org/apache/beam/runners/portability/testing/TestPortablePipelineOptions.DefaultJobServerConfigFactory.html" title="class in org.apache.beam.runners.portability.testing">TestPortablePipelineOptions.DefaultJobServerConfigFactory</a>, <a href="../../../../../org/apache/beam/runners/spark/TestSparkPipelineOptions.DefaultStopPipelineWatermarkFactory.html" title="class in org.apache.beam.runners.spark">TestSparkPipelineOptions.DefaultStopPipelineWatermarkFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">DefaultValueFactory<T></span></pre> |
| <div class="block">An interface used with the <a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options"><code>Default.InstanceFactory</code></a> annotation to specify the class that |
| will be an instance factory to produce default values for a given getter on <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>. When a property on a <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> is fetched, and is currently |
| unset, the default value factory will be instantiated and invoked. |
| |
| <p>Care must be taken to not produce an infinite loop when accessing other fields on the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> object.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="type parameter in DefaultValueFactory">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html#create-org.apache.beam.sdk.options.PipelineOptions-">create</a></span>(<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</code> |
| <div class="block">Creates a default value for a getter marked with <a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options"><code>Default.InstanceFactory</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="create-org.apache.beam.sdk.options.PipelineOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="type parameter in DefaultValueFactory">T</a> create(<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</pre> |
| <div class="block">Creates a default value for a getter marked with <a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options"><code>Default.InstanceFactory</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - The current pipeline options.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The default value to be used for the annotated getter.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/beam/sdk/options/DefaultPipelineOptionsRegistrar.html" title="class in org.apache.beam.sdk.options"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/options/Description.html" title="annotation in org.apache.beam.sdk.options"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/options/DefaultValueFactory.html" target="_top">Frames</a></li> |
| <li><a href="DefaultValueFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
