| <!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 (1.8.0_181-google-v7) on Mon Jan 27 16:42:36 PST 2020 --> |
| <title>org.apache.beam.sdk.options (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="org.apache.beam.sdk.options (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/metrics/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/options/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.options</h1> |
| <div class="docSummary"> |
| <div class="block">Defines <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> for configuring pipeline execution.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Options that allow setting the application name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="interface in org.apache.beam.sdk.options">DefaultValueFactory</a><T></td> |
| <td class="colLast"> |
| <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>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ExperimentalOptions.html" title="interface in org.apache.beam.sdk.options">ExperimentalOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Apache Beam provides a number of experimental features that can be enabled with this flag.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ManualDockerEnvironmentOptions.html" title="interface in org.apache.beam.sdk.options">ManualDockerEnvironmentOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Pipeline options to tune DockerEnvironment.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></td> |
| <td class="colLast"> |
| <div class="block">PipelineOptions are used to configure Pipelines.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options">PipelineOptionsRegistrar</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> creators have the ability to automatically have their <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> registered with this SDK by creating a <code>ServiceLoader</code> entry and a |
| concrete implementation of this interface.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PortablePipelineOptions.html" title="interface in org.apache.beam.sdk.options">PortablePipelineOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Pipeline options common to all portable runners.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/RemoteEnvironmentOptions.html" title="interface in org.apache.beam.sdk.options">RemoteEnvironmentOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Options that are used to control configuration of the remote environment.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.html" title="interface in org.apache.beam.sdk.options">SdkHarnessOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Options that are used to control configuration of the SDK harness.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/StreamingOptions.html" title="interface in org.apache.beam.sdk.options">StreamingOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Options used to configure streaming.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a> abstracts the notion of fetching a value that may or may not be currently |
| available.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/DefaultPipelineOptionsRegistrar.html" title="class in org.apache.beam.sdk.options">DefaultPipelineOptionsRegistrar</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptionsRegistrar</code></a> containing the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> subclasses available by |
| default.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ManualDockerEnvironmentOptions.Options.html" title="class in org.apache.beam.sdk.options">ManualDockerEnvironmentOptions.Options</a></td> |
| <td class="colLast"> |
| <div class="block">Register the <a href="../../../../../org/apache/beam/sdk/options/ManualDockerEnvironmentOptions.html" title="interface in org.apache.beam.sdk.options"><code>ManualDockerEnvironmentOptions</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.AtomicLongFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.AtomicLongFactory</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="interface in org.apache.beam.sdk.options"><code>DefaultValueFactory</code></a> which supplies an ID that is guaranteed to be unique within the |
| given process.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.DirectRunner.html" title="class in org.apache.beam.sdk.options">PipelineOptions.DirectRunner</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="interface in org.apache.beam.sdk.options"><code>DefaultValueFactory</code></a> that obtains the class of the <code>DirectRunner</code> if it exists |
| on the classpath, and throws an exception otherwise.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.JobNameFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.JobNameFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Returns a normalized job name constructed from <a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html#getAppName--"><code>ApplicationNameOptions.getAppName()</code></a>, the |
| local system user name (if available), the current time, and a random integer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.UserAgentFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.UserAgentFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Returns a user agent string constructed from <code>ReleaseInfo.getName()</code> and <code>ReleaseInfo.getVersion()</code>, in the format <code>[name]/[version]</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Constructs a <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> or any derived interface that is composable to any other |
| derived interface of <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> via the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#as-java.lang.Class-"><code>PipelineOptions.as(java.lang.Class<T>)</code></a> method.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory.Builder</a></td> |
| <td class="colLast"> |
| <div class="block">A fluent <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> builder.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsValidator.html" title="class in org.apache.beam.sdk.options">PipelineOptionsValidator</a></td> |
| <td class="colLast"> |
| <div class="block">Validates that the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> conforms to all the <a href="../../../../../org/apache/beam/sdk/options/Validation.html" title="annotation in org.apache.beam.sdk.options"><code>Validation</code></a> criteria.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/RemoteEnvironmentOptions.Options.html" title="class in org.apache.beam.sdk.options">RemoteEnvironmentOptions.Options</a></td> |
| <td class="colLast"> |
| <div class="block">Register the <a href="../../../../../org/apache/beam/sdk/options/RemoteEnvironmentOptions.html" title="interface in org.apache.beam.sdk.options"><code>RemoteEnvironmentOptions</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.SdkHarnessLogLevelOverrides.html" title="class in org.apache.beam.sdk.options">SdkHarnessOptions.SdkHarnessLogLevelOverrides</a></td> |
| <td class="colLast"> |
| <div class="block">Defines a log level override for a specific class, package, or name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ValueProvider.Deserializer.html" title="class in org.apache.beam.sdk.options">ValueProvider.Deserializer</a></td> |
| <td class="colLast"> |
| <div class="block"><b>For internal use only; no backwards compatibility guarantees.</b></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ValueProvider.NestedValueProvider.html" title="class in org.apache.beam.sdk.options">ValueProvider.NestedValueProvider</a><T,X></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/options/ValueProvider.NestedValueProvider.html" title="class in org.apache.beam.sdk.options"><code>ValueProvider.NestedValueProvider</code></a> is an implementation of <a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a> that allows for |
| wrapping another <a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a> object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ValueProvider.RuntimeValueProvider.html" title="class in org.apache.beam.sdk.options">ValueProvider.RuntimeValueProvider</a><T></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/options/ValueProvider.RuntimeValueProvider.html" title="class in org.apache.beam.sdk.options"><code>ValueProvider.RuntimeValueProvider</code></a> is an implementation of <a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a> that allows for a |
| value to be provided at execution time rather than at graph construction time.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ValueProvider.Serializer.html" title="class in org.apache.beam.sdk.options">ValueProvider.Serializer</a></td> |
| <td class="colLast"> |
| <div class="block"><b>For internal use only; no backwards compatibility guarantees.</b></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ValueProvider.StaticValueProvider.html" title="class in org.apache.beam.sdk.options">ValueProvider.StaticValueProvider</a><T></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/options/ValueProvider.StaticValueProvider.html" title="class in org.apache.beam.sdk.options"><code>ValueProvider.StaticValueProvider</code></a> is an implementation of <a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a> that allows for a |
| static value to be provided.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/ValueProviders.html" title="class in org.apache.beam.sdk.options">ValueProviders</a></td> |
| <td class="colLast"> |
| <div class="block">Utilities for working with the <a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a> interface.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.CheckEnabled.html" title="enum in org.apache.beam.sdk.options">PipelineOptions.CheckEnabled</a></td> |
| <td class="colLast"> |
| <div class="block">Enumeration of the possible states for a given check.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/PortablePipelineOptions.RetrievalServiceType.html" title="enum in org.apache.beam.sdk.options">PortablePipelineOptions.RetrievalServiceType</a></td> |
| <td class="colLast"> |
| <div class="block">Enumeration of the different implementations of the artifact retrieval service.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/SdkHarnessOptions.LogLevel.html" title="enum in org.apache.beam.sdk.options">SdkHarnessOptions.LogLevel</a></td> |
| <td class="colLast"> |
| <div class="block">The set of log levels that can be used in the SDK harness.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.html" title="annotation in org.apache.beam.sdk.options">Default</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/options/Default.html" title="annotation in org.apache.beam.sdk.options"><code>Default</code></a> represents a set of annotations that can be used to annotate getter properties on |
| <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> with information representing the default value to be returned if no |
| value is specified.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html" title="annotation in org.apache.beam.sdk.options">Default.Boolean</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified boolean primitive value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Byte.html" title="annotation in org.apache.beam.sdk.options">Default.Byte</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified byte primitive value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Character.html" title="annotation in org.apache.beam.sdk.options">Default.Character</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified char primitive value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Class.html" title="annotation in org.apache.beam.sdk.options">Default.Class</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified <code>Class</code> value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Double.html" title="annotation in org.apache.beam.sdk.options">Default.Double</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified double primitive value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Enum.html" title="annotation in org.apache.beam.sdk.options">Default.Enum</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified enum.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Float.html" title="annotation in org.apache.beam.sdk.options">Default.Float</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified float primitive value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options">Default.InstanceFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Value must be of type <a href="../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="interface in org.apache.beam.sdk.options"><code>DefaultValueFactory</code></a> and have a default constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Integer.html" title="annotation in org.apache.beam.sdk.options">Default.Integer</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified int primitive value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Long.html" title="annotation in org.apache.beam.sdk.options">Default.Long</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified long primitive value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.Short.html" title="annotation in org.apache.beam.sdk.options">Default.Short</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified short primitive value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Default.String.html" title="annotation in org.apache.beam.sdk.options">Default.String</a></td> |
| <td class="colLast"> |
| <div class="block">This represents that the default of the option is the specified <code>String</code> value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Description.html" title="annotation in org.apache.beam.sdk.options">Description</a></td> |
| <td class="colLast"> |
| <div class="block">Descriptions are used to generate human readable output when the <code>--help</code> command is |
| specified.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Hidden.html" title="annotation in org.apache.beam.sdk.options">Hidden</a></td> |
| <td class="colLast"> |
| <div class="block">Methods and/or interfaces annotated with <code>@Hidden</code> will be suppressed from being output |
| when <code>--help</code> is specified on the command-line.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Validation.html" title="annotation in org.apache.beam.sdk.options">Validation</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/options/Validation.html" title="annotation in org.apache.beam.sdk.options"><code>Validation</code></a> represents a set of annotations that can be used to annotate getter properties |
| on <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> with information representing the validation criteria to be used when |
| validating with the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsValidator.html" title="class in org.apache.beam.sdk.options"><code>PipelineOptionsValidator</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/options/Validation.Required.html" title="annotation in org.apache.beam.sdk.options">Validation.Required</a></td> |
| <td class="colLast"> |
| <div class="block">This criteria specifies that the value must be not null.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.options Description">Package org.apache.beam.sdk.options Description</h2> |
| <div class="block">Defines <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> for configuring pipeline execution. |
| |
| <p><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> encapsulates the various parameters that |
| describe how a pipeline should be run. <code>PipelineOptions</code> are created using a <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html" title="class in org.apache.beam.sdk.options"><code>PipelineOptionsFactory</code></a>.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/metrics/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/options/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
