blob: e492b66232db7dd06e31dce0c6db0a0c7c810097 [file] [log] [blame]
<!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_161-google-v7) on Thu Oct 18 16:14:31 PDT 2018 -->
<title>PipelineOptionsFactory.Builder (Apache Beam 2.8.0-SNAPSHOT)</title>
<meta name="date" content="2018-10-18">
<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.Builder (Apache Beam 2.8.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All 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/PipelineOptionsFactory.html" title="class in org.apache.beam.sdk.options"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" target="_top">Frames</a></li>
<li><a href="PipelineOptionsFactory.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.Builder" class="title">Class PipelineOptionsFactory.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.options.PipelineOptionsFactory.Builder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">PipelineOptionsFactory.Builder</span>
extends java.lang.Object</pre>
<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>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>&lt;T extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html#as-java.lang.Class-">as</a></span>(java.lang.Class&lt;T&gt;&nbsp;klass)</code>
<div class="block">Creates and returns an object that implements <code>&lt;T&gt;</code> using the values configured on this
builder during construction.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><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.Builder.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> using the values
configured on this builder during construction.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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.Builder.html#fromArgs-java.lang.String...-">fromArgs</a></span>(java.lang.String...&nbsp;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="i3" 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.Builder.html#withoutStrictParsing--">withoutStrictParsing</a></span>()</code>
<div class="block">During parsing of the arguments, we will skip over improperly formatted and unknown
arguments.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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.Builder.html#withValidation--">withValidation</a></span>()</code>
<div class="block">After creation we will validate that <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 validation
criteria from <code>&lt;T&gt;</code>.</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&nbsp;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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fromArgs-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromArgs</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory.Builder</a>&nbsp;fromArgs(java.lang.String...&nbsp;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&lt;String&gt;</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>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>PipelineOptionsFactory.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>PipelineOptionsFactory.printHelp(PrintStream, Class)</code></a>.</div>
</li>
</ul>
<a name="withValidation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withValidation</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory.Builder</a>&nbsp;withValidation()</pre>
<div class="block">After creation we will validate that <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 validation
criteria from <code>&lt;T&gt;</code>. 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="withoutStrictParsing--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withoutStrictParsing</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" title="class in org.apache.beam.sdk.options">PipelineOptionsFactory.Builder</a>&nbsp;withoutStrictParsing()</pre>
<div class="block">During parsing of the arguments, we will skip over improperly formatted and unknown
arguments.</div>
</li>
</ul>
<a name="create--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>&nbsp;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> using the values
configured on this builder during construction.</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="blockListLast">
<li class="blockList">
<h4>as</h4>
<pre>public&nbsp;&lt;T extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>&gt;&nbsp;T&nbsp;as(java.lang.Class&lt;T&gt;&nbsp;klass)</pre>
<div class="block">Creates and returns an object that implements <code>&lt;T&gt;</code> using the values configured on this
builder during construction.
<p>Note that <code>&lt;T&gt;</code> must be composable with every registered interface with this
factory. See <code>PipelineOptionsFactory.Cache.validateWellFormed(Class)</code> for more details.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An object that implements <code>&lt;T&gt;</code>.</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/PipelineOptionsFactory.html" title="class in org.apache.beam.sdk.options"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/options/PipelineOptionsFactory.Builder.html" target="_top">Frames</a></li>
<li><a href="PipelineOptionsFactory.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>