| <!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>PipelineOptionsFactory (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="PipelineOptionsFactory (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/PipelineOptions.UserAgentFactory.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/PipelineOptionsFactory.Builder.html" title="class 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/PipelineOptionsFactory.html" target="_top">Frames</a></li> |
| <li><a href="PipelineOptionsFactory.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class PipelineOptionsFactory" class="title">Class PipelineOptionsFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.options.PipelineOptionsFactory</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">PipelineOptionsFactory</span> |
| extends java.lang.Object</pre> |
| <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. Being |
| able to compose one derived interface of <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> to another has the following |
| restrictions: |
| |
| <ul> |
| <li>Any property with the same name must have the same return type for all derived interfaces |
| of <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>. |
| <li>Every bean property of any interface derived from <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> must have a |
| getter and setter method. |
| <li>Every method must conform to being a getter or setter for a JavaBean. |
| <li>The derived interface of <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> must be composable with every interface |
| registered with this factory. |
| </ul> |
| |
| <p>See the <a |
| href="http://www.oracle.com/technetwork/java/javase/documentation/spec-136004.html">JavaBeans |
| specification</a> for more details as to what constitutes a property.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory.Builder</a></span></code> |
| <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> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#PipelineOptionsFactory--">PipelineOptionsFactory</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <T extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#as-java.lang.Class-">as</a></span>(java.lang.Class<T> klass)</code> |
| <div class="block">Creates and returns an object that implements <code><T></code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#create--">create</a></span>()</code> |
| <div class="block">Creates and returns an object that implements <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 id="i2" class="altColor"> |
| <td class="colFirst"><code>static java.util.List<org.apache.beam.model.jobmanagement.v1.JobApi.PipelineOptionDescriptor></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#describe-java.util.Set-">describe</a></span>(java.util.Set<java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>>> ifaces)</code> |
| <div class="block">Outputs the set of options available to be set for the passed in <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> |
| interfaces.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#fromArgs-java.lang.String...-">fromArgs</a></span>(java.lang.String... args)</code> |
| <div class="block">Sets the command line arguments to parse when constructing the <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 id="i4" class="altColor"> |
| <td class="colFirst"><code>static java.util.Set<java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#getRegisteredOptions--">getRegisteredOptions</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#printHelp-java.io.PrintStream-">printHelp</a></span>(java.io.PrintStream out)</code> |
| <div class="block">Outputs the set of registered options with the PipelineOptionsFactory with a description for |
| each one if available to the output stream.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#printHelp-java.io.PrintStream-java.lang.Class-">printHelp</a></span>(java.io.PrintStream out, |
| java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>> iface)</code> |
| <div class="block">Outputs the set of options available to be set for the passed in <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> |
| interface.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#register-java.lang.Class-">register</a></span>(java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>> iface)</code> |
| <div class="block">This registers the interface with this factory.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#resetCache--">resetCache</a></span>()</code> |
| <div class="block">Resets the set of interfaces registered with this factory to the default state.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#withValidation--">withValidation</a></span>()</code> |
| <div class="block">After creation we will validate that <code><T></code> conforms to all the validation criteria.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PipelineOptionsFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PipelineOptionsFactory</h4> |
| <pre>public PipelineOptionsFactory()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="create--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> create()</pre> |
| <div class="block">Creates and returns an object that implements <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>. This sets the <a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html#getAppName--"><code>"appName"</code></a> to the calling <code>classes simple name</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An object that implements <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="as-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>as</h4> |
| <pre>public static <T extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>> T as(java.lang.Class<T> klass)</pre> |
| <div class="block">Creates and returns an object that implements <code><T></code>. This sets the <a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html#getAppName--"><code>"appName"</code></a> to the calling <code>classes simple name</code>. |
| |
| <p>Note that <code><T></code> must be composable with every registered interface with this factory. |
| See <code>PipelineOptionsFactory.Cache.validateWellFormed(Class, Set)</code> for more details.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An object that implements <code><T></code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromArgs-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromArgs</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory.Builder</a> fromArgs(java.lang.String... args)</pre> |
| <div class="block">Sets the command line arguments to parse when constructing the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>. |
| |
| <p>Example GNU style command line arguments: |
| |
| <pre> |
| --project=MyProject (simple property, will set the "project" property to "MyProject") |
| --readOnly=true (for boolean properties, will set the "readOnly" property to "true") |
| --readOnly (shorthand for boolean properties, will set the "readOnly" property to "true") |
| --x=1 --x=2 --x=3 (list style simple property, will set the "x" property to [1, 2, 3]) |
| --x=1,2,3 (shorthand list style simple property, will set the "x" property to [1, 2, 3]) |
| --complexObject='{"key1":"value1",...} (JSON format for all other complex types) |
| </pre> |
| |
| <p>Simple properties are able to bound to <code>String</code>, <code>Class</code>, enums and Java |
| primitives <code>boolean</code>, <code>byte</code>, <code>short</code>, <code>int</code>, <code>long</code>, <code>float</code>, <code>double</code> and their primitive wrapper classes. |
| |
| <p>Simple list style properties are able to be bound to <code>boolean[]</code>, <code>char[]</code>, |
| <code>short[]</code>, <code>int[]</code>, <code>long[]</code>, <code>float[]</code>, <code>double[]</code>, <code>Class[]</code>, enum arrays, <code>String[]</code>, and <code>List<String></code>. |
| |
| <p>JSON format is required for all other types. |
| |
| <p>By default, strict parsing is enabled and arguments must conform to be either <code>--booleanArgName</code> or <code>--argName=argValue</code>. Strict parsing can be disabled with <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html#withoutStrictParsing--"><code>PipelineOptionsFactory.Builder.withoutStrictParsing()</code></a>. Empty or null arguments will be ignored whether or not strict |
| parsing is enabled. |
| |
| <p>Help information can be output to <code>System.out</code> by specifying <code>--help</code> as an |
| argument. After help is printed, the application will exit. Specifying only <code>--help</code> will |
| print out the list of <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#getRegisteredOptions--"><code>registered options</code></a> |
| by invoking <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#printHelp-java.io.PrintStream-"><code>printHelp(PrintStream)</code></a>. Specifying <code>--help=PipelineOptionsClassName</code> will print out detailed usage information about the |
| specifically requested PipelineOptions by invoking <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#printHelp-java.io.PrintStream-java.lang.Class-"><code>printHelp(PrintStream, Class)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withValidation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withValidation</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory.Builder</a> withValidation()</pre> |
| <div class="block">After creation we will validate that <code><T></code> conforms to all the validation criteria. See |
| <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsValidator.html#validate-java.lang.Class-org.apache.beam.sdk.options.PipelineOptions-"><code>PipelineOptionsValidator.validate(Class, PipelineOptions)</code></a> for more details about |
| validation.</div> |
| </li> |
| </ul> |
| <a name="register-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>public static void register(java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>> iface)</pre> |
| <div class="block">This registers the interface with this factory. This interface must conform to the following |
| restrictions: |
| |
| <ul> |
| <li>Any property with the same name must have the same return type for all derived interfaces |
| of <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>. |
| <li>Every bean property of any interface derived from <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> must have a |
| getter and setter method. |
| <li>Every method must conform to being a getter or setter for a JavaBean. |
| <li>The derived interface of <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> must be composable with every interface |
| registered with this factory. |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>iface</code> - The interface object to manually register.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetCache</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> |
| public static void resetCache()</pre> |
| <div class="block">Resets the set of interfaces registered with this factory to the default state. |
| |
| <p>IMPORTANT: this is marked as experimental because the correct usage of this method requires |
| appropriate synchronization beyond the scope of this method.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html#register-java.lang.Class-"><code>register(Class)</code></a>, |
| <code>Cache#Cache()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegisteredOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegisteredOptions</h4> |
| <pre>public static java.util.Set<java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>>> getRegisteredOptions()</pre> |
| </li> |
| </ul> |
| <a name="printHelp-java.io.PrintStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>printHelp</h4> |
| <pre>public static void printHelp(java.io.PrintStream out)</pre> |
| <div class="block">Outputs the set of registered options with the PipelineOptionsFactory with a description for |
| each one if available to the output stream. This output is pretty printed and meant to be human |
| readable. This method will attempt to format its output to be compatible with a terminal |
| window.</div> |
| </li> |
| </ul> |
| <a name="printHelp-java.io.PrintStream-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>printHelp</h4> |
| <pre>public static void printHelp(java.io.PrintStream out, |
| java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>> iface)</pre> |
| <div class="block">Outputs the set of options available to be set for the passed in <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> |
| interface. The output is in a human readable format. The format is: |
| |
| <pre> |
| OptionGroup: |
| ... option group description ... |
| |
| --option1=<code> <type></code> or list of valid enum choices |
| Default: value (if available, see <a href="../../../../../org/apache/beam/sdk/options/Default.html" title="annotation in org.apache.beam.sdk.options"><code>Default</code></a>) |
| ... option description ... (if available, see <a href="../../../../../org/apache/beam/sdk/options/Description.html" title="annotation in org.apache.beam.sdk.options"><code>Description</code></a>) |
| Required groups (if available, see <a href="../../../../../org/apache/beam/sdk/options/Validation.Required.html" title="annotation in org.apache.beam.sdk.options"><code>Validation.Required</code></a>) |
| --option2=<code> <type></code> or list of valid enum choices |
| Default: value (if available, see <a href="../../../../../org/apache/beam/sdk/options/Default.html" title="annotation in org.apache.beam.sdk.options"><code>Default</code></a>) |
| ... option description ... (if available, see <a href="../../../../../org/apache/beam/sdk/options/Description.html" title="annotation in org.apache.beam.sdk.options"><code>Description</code></a>) |
| Required groups (if available, see <a href="../../../../../org/apache/beam/sdk/options/Validation.Required.html" title="annotation in org.apache.beam.sdk.options"><code>Validation.Required</code></a>) |
| </pre> |
| |
| This method will attempt to format its output to be compatible with a terminal window.</div> |
| </li> |
| </ul> |
| <a name="describe-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>describe</h4> |
| <pre>public static java.util.List<org.apache.beam.model.jobmanagement.v1.JobApi.PipelineOptionDescriptor> describe(java.util.Set<java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>>> ifaces)</pre> |
| <div class="block">Outputs the set of options available to be set for the passed in <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> |
| interfaces. The output for consumption of the job service client.</div> |
| </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/PipelineOptions.UserAgentFactory.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/PipelineOptionsFactory.Builder.html" title="class 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/PipelineOptionsFactory.html" target="_top">Frames</a></li> |
| <li><a href="PipelineOptionsFactory.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
