| <!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:34 PDT 2018 --> |
| <title>DataflowPipelineDebugOptions (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="DataflowPipelineDebugOptions (Apache Beam 2.8.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":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/runners/dataflow/options/CloudDebuggerOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html" title="class in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html" target="_top">Frames</a></li> |
| <li><a href="DataflowPipelineDebugOptions.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>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.runners.dataflow.options</div> |
| <h2 title="Interface DataflowPipelineDebugOptions" class="title">Interface DataflowPipelineDebugOptions</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/options/ExperimentalOptions.html" title="interface in org.apache.beam.sdk.options">ExperimentalOptions</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a>, <a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowWorkerHarnessOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowWorkerHarnessOptions</a>, <a href="../../../../../../org/apache/beam/runners/dataflow/TestDataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow">TestDataflowPipelineOptions</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../org/apache/beam/sdk/options/Hidden.html" title="annotation in org.apache.beam.sdk.options">@Hidden</a> |
| public interface <span class="typeNameLabel">DataflowPipelineDebugOptions</span> |
| extends <a href="../../../../../../org/apache/beam/sdk/options/ExperimentalOptions.html" title="interface in org.apache.beam.sdk.options">ExperimentalOptions</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></pre> |
| <div class="block">Internal. Options used to control execution of the Dataflow SDK for debugging and testing |
| purposes.</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">Interface 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/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions.DataflowClientFactory</a></span></code> |
| <div class="block">Returns the default Dataflow client built from the passed in PipelineOptions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.StagerFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions.StagerFactory</a></span></code> |
| <div class="block">Creates a <a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util"><code>Stager</code></a> object using the class specified in <a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getStagerClass--"><code>getStagerClass()</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.options.PipelineOptions"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.<a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></h3> |
| <code><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.CheckEnabled.html" title="enum in org.apache.beam.sdk.options">PipelineOptions.CheckEnabled</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.NoOpMetricsSink.html" title="class in org.apache.beam.sdk.options">PipelineOptions.NoOpMetricsSink</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.UserAgentFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.UserAgentFactory</a></code></li> |
| </ul> |
| </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="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>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getApiRootUrl--">getApiRootUrl</a></span>()</code> |
| <div class="block">The root URL for the Dataflow API.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>com.google.api.services.dataflow.Dataflow</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getDataflowClient--">getDataflowClient</a></span>()</code> |
| <div class="block">An instance of the Dataflow client.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getDataflowEndpoint--">getDataflowEndpoint</a></span>()</code> |
| <div class="block">Dataflow endpoint to use.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getDataflowJobFile--">getDataflowJobFile</a></span>()</code> |
| <div class="block">The path to write the translated Dataflow job specification out to at job submission time.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getDumpHeapOnOOM--">getDumpHeapOnOOM</a></span>()</code> |
| <div class="block">If true, save a heap dump before killing a thread or process which is GC thrashing |
| or out of memory.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getNumberOfWorkerHarnessThreads--">getNumberOfWorkerHarnessThreads</a></span>()</code> |
| <div class="block">Number of threads to use on the Dataflow worker harness.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getOverrideWindmillBinary--">getOverrideWindmillBinary</a></span>()</code> |
| <div class="block">Custom windmill_main binary to use with the streaming runner.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getSaveHeapDumpsToGcsPath--">getSaveHeapDumpsToGcsPath</a></span>()</code> |
| <div class="block">CAUTION: This option implies dumpHeapOnOOM, and has similar caveats.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util">Stager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getStager--">getStager</a></span>()</code> |
| <div class="block">The resource stager instance that should be used to stage resources.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util">Stager</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getStagerClass--">getStagerClass</a></span>()</code> |
| <div class="block">The class responsible for staging resources to be accessible by workers during job execution.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getTransformNameMapping--">getTransformNameMapping</a></span>()</code> |
| <div class="block">Mapping of old PTranform names to new ones, specified as JSON <code>{"oldName":"newName",...} |
| </code>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getWindmillServiceEndpoint--">getWindmillServiceEndpoint</a></span>()</code> |
| <div class="block">Custom windmill service endpoint.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getWindmillServicePort--">getWindmillServicePort</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setApiRootUrl-java.lang.String-">setApiRootUrl</a></span>(java.lang.String value)</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setDataflowClient-com.google.api.services.dataflow.Dataflow-">setDataflowClient</a></span>(com.google.api.services.dataflow.Dataflow value)</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setDataflowEndpoint-java.lang.String-">setDataflowEndpoint</a></span>(java.lang.String value)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setDataflowJobFile-java.lang.String-">setDataflowJobFile</a></span>(java.lang.String value)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setDumpHeapOnOOM-boolean-">setDumpHeapOnOOM</a></span>(boolean dumpHeapBeforeExit)</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setNumberOfWorkerHarnessThreads-int-">setNumberOfWorkerHarnessThreads</a></span>(int value)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setOverrideWindmillBinary-java.lang.String-">setOverrideWindmillBinary</a></span>(java.lang.String value)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setSaveHeapDumpsToGcsPath-java.lang.String-">setSaveHeapDumpsToGcsPath</a></span>(java.lang.String gcsPath)</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setStager-org.apache.beam.runners.dataflow.util.Stager-">setStager</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util">Stager</a> stager)</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setStagerClass-java.lang.Class-">setStagerClass</a></span>(java.lang.Class<? extends <a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util">Stager</a>> stagerClass)</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setTransformNameMapping-java.util.Map-">setTransformNameMapping</a></span>(java.util.Map<java.lang.String,java.lang.String> value)</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setWindmillServiceEndpoint-java.lang.String-">setWindmillServiceEndpoint</a></span>(java.lang.String value)</code> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#setWindmillServicePort-int-">setWindmillServicePort</a></span>(int value)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.ExperimentalOptions"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../../org/apache/beam/sdk/options/ExperimentalOptions.html" title="interface in org.apache.beam.sdk.options">ExperimentalOptions</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/options/ExperimentalOptions.html#getExperiments--">getExperiments</a>, <a href="../../../../../../org/apache/beam/sdk/options/ExperimentalOptions.html#hasExperiment-org.apache.beam.sdk.options.PipelineOptions-java.lang.String-">hasExperiment</a>, <a href="../../../../../../org/apache/beam/sdk/options/ExperimentalOptions.html#setExperiments-java.util.List-">setExperiments</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.PipelineOptions"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#as-java.lang.Class-">as</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getJobName--">getJobName</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getMetricsHttpSinkUrl--">getMetricsHttpSinkUrl</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getMetricsPushPeriod--">getMetricsPushPeriod</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getMetricsSink--">getMetricsSink</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getOptionsId--">getOptionsId</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getRunner--">getRunner</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getStableUniqueNames--">getStableUniqueNames</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getTempLocation--">getTempLocation</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getUserAgent--">getUserAgent</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#outputRuntimeOptions--">outputRuntimeOptions</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setJobName-java.lang.String-">setJobName</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setMetricsHttpSinkUrl-java.lang.String-">setMetricsHttpSinkUrl</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setMetricsPushPeriod-java.lang.Long-">setMetricsPushPeriod</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setMetricsSink-java.lang.Class-">setMetricsSink</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setOptionsId-long-">setOptionsId</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setRunner-java.lang.Class-">setRunner</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setStableUniqueNames-org.apache.beam.sdk.options.PipelineOptions.CheckEnabled-">setStableUniqueNames</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setTempLocation-java.lang.String-">setTempLocation</a>, <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setUserAgent-java.lang.String-">setUserAgent</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.display.HasDisplayData"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.transforms.display.<a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></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="getApiRootUrl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApiRootUrl</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/options/Default.String.html" title="annotation in org.apache.beam.sdk.options">@Default.String</a>(<a href="../../../../../../org/apache/beam/sdk/options/Default.String.html#value--">value</a>="https://dataflow.googleapis.com/") |
| java.lang.String getApiRootUrl()</pre> |
| <div class="block">The root URL for the Dataflow API. <code>dataflowEndpoint</code> can override this value if it |
| contains an absolute URL, otherwise <code>apiRootUrl</code> will be combined with <code>dataflowEndpoint</code> to generate the full URL to communicate with the Dataflow API.</div> |
| </li> |
| </ul> |
| <a name="setApiRootUrl-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setApiRootUrl</h4> |
| <pre>void setApiRootUrl(java.lang.String value)</pre> |
| </li> |
| </ul> |
| <a name="getDataflowEndpoint--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataflowEndpoint</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/options/Default.String.html" title="annotation in org.apache.beam.sdk.options">@Default.String</a>(<a href="../../../../../../org/apache/beam/sdk/options/Default.String.html#value--">value</a>="") |
| java.lang.String getDataflowEndpoint()</pre> |
| <div class="block">Dataflow endpoint to use. |
| |
| <p>Defaults to the current version of the Google Cloud Dataflow API, at the time the current |
| SDK version was released. |
| |
| <p>If the string contains "://", then this is treated as a URL, otherwise <a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html#getApiRootUrl--"><code>getApiRootUrl()</code></a> is used as the root URL.</div> |
| </li> |
| </ul> |
| <a name="setDataflowEndpoint-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataflowEndpoint</h4> |
| <pre>void setDataflowEndpoint(java.lang.String value)</pre> |
| </li> |
| </ul> |
| <a name="getDataflowJobFile--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataflowJobFile</h4> |
| <pre>java.lang.String getDataflowJobFile()</pre> |
| <div class="block">The path to write the translated Dataflow job specification out to at job submission time. The |
| Dataflow job specification will be represented in JSON format.</div> |
| </li> |
| </ul> |
| <a name="setDataflowJobFile-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataflowJobFile</h4> |
| <pre>void setDataflowJobFile(java.lang.String value)</pre> |
| </li> |
| </ul> |
| <a name="getStagerClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStagerClass</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/options/Default.Class.html" title="annotation in org.apache.beam.sdk.options">@Default.Class</a>(<a href="../../../../../../org/apache/beam/sdk/options/Default.Class.html#value--">value</a>=<a href="../../../../../../org/apache/beam/runners/dataflow/util/GcsStager.html" title="class in org.apache.beam.runners.dataflow.util">GcsStager.class</a>) |
| java.lang.Class<? extends <a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util">Stager</a>> getStagerClass()</pre> |
| <div class="block">The class responsible for staging resources to be accessible by workers during job execution. |
| If stager has not been set explicitly, an instance of this class will be created and used as |
| the resource stager.</div> |
| </li> |
| </ul> |
| <a name="setStagerClass-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStagerClass</h4> |
| <pre>void setStagerClass(java.lang.Class<? extends <a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util">Stager</a>> stagerClass)</pre> |
| </li> |
| </ul> |
| <a name="getStager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStager</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options">@Default.InstanceFactory</a>(<a href="../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html#value--">value</a>=<a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.StagerFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions.StagerFactory.class</a>) |
| <a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util">Stager</a> getStager()</pre> |
| <div class="block">The resource stager instance that should be used to stage resources. If no stager has been set |
| explicitly, the default is to use the instance factory that constructs a resource stager based |
| upon the currently set stagerClass.</div> |
| </li> |
| </ul> |
| <a name="setStager-org.apache.beam.runners.dataflow.util.Stager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStager</h4> |
| <pre>void setStager(<a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util">Stager</a> stager)</pre> |
| </li> |
| </ul> |
| <a name="getDataflowClient--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataflowClient</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options">@Default.InstanceFactory</a>(<a href="../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html#value--">value</a>=<a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions.DataflowClientFactory.class</a>) |
| com.google.api.services.dataflow.Dataflow getDataflowClient()</pre> |
| <div class="block">An instance of the Dataflow client. Defaults to creating a Dataflow client using the current |
| set of options.</div> |
| </li> |
| </ul> |
| <a name="setDataflowClient-com.google.api.services.dataflow.Dataflow-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataflowClient</h4> |
| <pre>void setDataflowClient(com.google.api.services.dataflow.Dataflow value)</pre> |
| </li> |
| </ul> |
| <a name="getTransformNameMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransformNameMapping</h4> |
| <pre>java.util.Map<java.lang.String,java.lang.String> getTransformNameMapping()</pre> |
| <div class="block">Mapping of old PTranform names to new ones, specified as JSON <code>{"oldName":"newName",...} |
| </code>. To mark a transform as deleted, make newName the empty string.</div> |
| </li> |
| </ul> |
| <a name="setTransformNameMapping-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTransformNameMapping</h4> |
| <pre>void setTransformNameMapping(java.util.Map<java.lang.String,java.lang.String> value)</pre> |
| </li> |
| </ul> |
| <a name="getOverrideWindmillBinary--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOverrideWindmillBinary</h4> |
| <pre>java.lang.String getOverrideWindmillBinary()</pre> |
| <div class="block">Custom windmill_main binary to use with the streaming runner.</div> |
| </li> |
| </ul> |
| <a name="setOverrideWindmillBinary-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOverrideWindmillBinary</h4> |
| <pre>void setOverrideWindmillBinary(java.lang.String value)</pre> |
| </li> |
| </ul> |
| <a name="getWindmillServiceEndpoint--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWindmillServiceEndpoint</h4> |
| <pre>java.lang.String getWindmillServiceEndpoint()</pre> |
| <div class="block">Custom windmill service endpoint.</div> |
| </li> |
| </ul> |
| <a name="setWindmillServiceEndpoint-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWindmillServiceEndpoint</h4> |
| <pre>void setWindmillServiceEndpoint(java.lang.String value)</pre> |
| </li> |
| </ul> |
| <a name="getWindmillServicePort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWindmillServicePort</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/options/Default.Integer.html" title="annotation in org.apache.beam.sdk.options">@Default.Integer</a>(<a href="../../../../../../org/apache/beam/sdk/options/Default.Integer.html#value--">value</a>=443) |
| int getWindmillServicePort()</pre> |
| </li> |
| </ul> |
| <a name="setWindmillServicePort-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWindmillServicePort</h4> |
| <pre>void setWindmillServicePort(int value)</pre> |
| </li> |
| </ul> |
| <a name="getNumberOfWorkerHarnessThreads--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumberOfWorkerHarnessThreads</h4> |
| <pre>int getNumberOfWorkerHarnessThreads()</pre> |
| <div class="block">Number of threads to use on the Dataflow worker harness. If left unspecified, the Dataflow |
| service will compute an appropriate number of threads to use.</div> |
| </li> |
| </ul> |
| <a name="setNumberOfWorkerHarnessThreads-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNumberOfWorkerHarnessThreads</h4> |
| <pre>void setNumberOfWorkerHarnessThreads(int value)</pre> |
| </li> |
| </ul> |
| <a name="getDumpHeapOnOOM--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDumpHeapOnOOM</h4> |
| <pre>boolean getDumpHeapOnOOM()</pre> |
| <div class="block">If true, save a heap dump before killing a thread or process which is GC thrashing |
| or out of memory. The location of the heap file will either be echoed back to the user, or the |
| user will be given the opportunity to download the heap file. |
| |
| <p>CAUTION: Heap dumps can of comparable size to the default boot disk. Consider increasing the |
| boot disk size before setting this flag to true.</div> |
| </li> |
| </ul> |
| <a name="setDumpHeapOnOOM-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDumpHeapOnOOM</h4> |
| <pre>void setDumpHeapOnOOM(boolean dumpHeapBeforeExit)</pre> |
| </li> |
| </ul> |
| <a name="getSaveHeapDumpsToGcsPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSaveHeapDumpsToGcsPath</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> |
| java.lang.String getSaveHeapDumpsToGcsPath()</pre> |
| <div class="block">CAUTION: This option implies dumpHeapOnOOM, and has similar caveats. Specifically, heap dumps |
| can of comparable size to the default boot disk. Consider increasing the boot disk size before |
| setting this flag to true.</div> |
| </li> |
| </ul> |
| <a name="setSaveHeapDumpsToGcsPath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setSaveHeapDumpsToGcsPath</h4> |
| <pre>void setSaveHeapDumpsToGcsPath(java.lang.String gcsPath)</pre> |
| </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/runners/dataflow/options/CloudDebuggerOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html" title="class in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html" target="_top">Frames</a></li> |
| <li><a href="DataflowPipelineDebugOptions.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>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> |