| <!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>SparkStructuredStreamingPipelineOptions (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="SparkStructuredStreamingPipelineOptions (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":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/spark/structuredstreaming/Constants.html" title="class in org.apache.beam.runners.spark.structuredstreaming"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/spark/structuredstreaming/SparkStructuredStreamingPipelineResult.html" title="class in org.apache.beam.runners.spark.structuredstreaming"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/spark/structuredstreaming/SparkStructuredStreamingPipelineOptions.html" target="_top">Frames</a></li> |
| <li><a href="SparkStructuredStreamingPipelineOptions.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.runners.spark.structuredstreaming</div> |
| <h2 title="Interface SparkStructuredStreamingPipelineOptions" class="title">Interface SparkStructuredStreamingPipelineOptions</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/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a>, <a href="../../../../../../org/apache/beam/sdk/options/FileStagingOptions.html" title="interface in org.apache.beam.sdk.options">FileStagingOptions</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>, <a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html" title="interface in org.apache.beam.runners.spark">SparkCommonPipelineOptions</a>, <a href="../../../../../../org/apache/beam/sdk/options/StreamingOptions.html" title="interface in org.apache.beam.sdk.options">StreamingOptions</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SparkStructuredStreamingPipelineOptions</span> |
| extends <a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html" title="interface in org.apache.beam.runners.spark">SparkCommonPipelineOptions</a></pre> |
| <div class="block">Spark runner <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> handles Spark execution-related configurations, such as the |
| master address, and other user-related knobs.</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.runners.spark.SparkCommonPipelineOptions"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.beam.runners.spark.<a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html" title="interface in org.apache.beam.runners.spark">SparkCommonPipelineOptions</a></h3> |
| <code><a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.TmpCheckpointDirFactory.html" title="class in org.apache.beam.runners.spark">SparkCommonPipelineOptions.TmpCheckpointDirFactory</a></code></li> |
| </ul> |
| <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.UserAgentFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.UserAgentFactory</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.runners.spark.SparkCommonPipelineOptions"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.beam.runners.spark.<a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html" title="interface in org.apache.beam.runners.spark">SparkCommonPipelineOptions</a></h3> |
| <code><a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html#DEFAULT_MASTER_URL">DEFAULT_MASTER_URL</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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/structuredstreaming/SparkStructuredStreamingPipelineOptions.html#getTestMode--">getTestMode</a></span>()</code> |
| <div class="block">Set to true to run the job in test mode.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/structuredstreaming/SparkStructuredStreamingPipelineOptions.html#setTestMode-boolean-">setTestMode</a></span>(boolean testMode)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.spark.SparkCommonPipelineOptions"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.runners.spark.<a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html" title="interface in org.apache.beam.runners.spark">SparkCommonPipelineOptions</a></h3> |
| <code><a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html#getCheckpointDir--">getCheckpointDir</a>, <a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html#getEnableSparkMetricSinks--">getEnableSparkMetricSinks</a>, <a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html#getSparkMaster--">getSparkMaster</a>, <a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html#prepareFilesToStage-org.apache.beam.runners.spark.SparkCommonPipelineOptions-">prepareFilesToStage</a>, <a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html#setCheckpointDir-java.lang.String-">setCheckpointDir</a>, <a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html#setEnableSparkMetricSinks-java.lang.Boolean-">setEnableSparkMetricSinks</a>, <a href="../../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html#setSparkMaster-java.lang.String-">setSparkMaster</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.StreamingOptions"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../../org/apache/beam/sdk/options/StreamingOptions.html" title="interface in org.apache.beam.sdk.options">StreamingOptions</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/options/StreamingOptions.html#isStreaming--">isStreaming</a>, <a href="../../../../../../org/apache/beam/sdk/options/StreamingOptions.html#setStreaming-boolean-">setStreaming</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.ApplicationNameOptions"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html#getAppName--">getAppName</a>, <a href="../../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html#setAppName-java.lang.String-">setAppName</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#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#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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.FileStagingOptions"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../../org/apache/beam/sdk/options/FileStagingOptions.html" title="interface in org.apache.beam.sdk.options">FileStagingOptions</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/options/FileStagingOptions.html#getFilesToStage--">getFilesToStage</a>, <a href="../../../../../../org/apache/beam/sdk/options/FileStagingOptions.html#setFilesToStage-java.util.List-">setFilesToStage</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="getTestMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTestMode</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/options/Default.Boolean.html" title="annotation in org.apache.beam.sdk.options">@Default.Boolean</a>(<a href="../../../../../../org/apache/beam/sdk/options/Default.Boolean.html#value--">value</a>=false) |
| boolean getTestMode()</pre> |
| <div class="block">Set to true to run the job in test mode.</div> |
| </li> |
| </ul> |
| <a name="setTestMode-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setTestMode</h4> |
| <pre>void setTestMode(boolean testMode)</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/spark/structuredstreaming/Constants.html" title="class in org.apache.beam.runners.spark.structuredstreaming"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/spark/structuredstreaming/SparkStructuredStreamingPipelineResult.html" title="class in org.apache.beam.runners.spark.structuredstreaming"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/spark/structuredstreaming/SparkStructuredStreamingPipelineOptions.html" target="_top">Frames</a></li> |
| <li><a href="SparkStructuredStreamingPipelineOptions.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
