blob: d7d5196ac72732c65fda1da4cb80a35f0da56e8e [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_181-google-v7) on Mon Jan 27 16:42:33 PST 2020 -->
<title>org.apache.beam.runners.dataflow.options (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-01-27">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.beam.runners.dataflow.options (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/runners/dataflow/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/options/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.runners.dataflow.options</h1>
<div class="docSummary">
<div class="block">Provides <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> specific to Google Cloud Dataflow.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html" title="interface in org.apache.beam.runners.dataflow.options">CloudDebuggerOptions</a></td>
<td class="colLast">
<div class="block">Options for controlling Cloud Debugger.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions</a></td>
<td class="colLast">
<div class="block">Internal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a></td>
<td class="colLast">
<div class="block">Options that can be used to configure the <a href="../../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunner</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions</a></td>
<td class="colLast">
<div class="block">Options that are used to configure the Dataflow pipeline worker pool.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowProfilingOptions</a></td>
<td class="colLast">
<div class="block">Options for controlling profiling of pipeline execution.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowWorkerHarnessOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowWorkerHarnessOptions</a></td>
<td class="colLast">
<div class="block">Options that are used exclusively within the Dataflow worker harness.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowWorkerLoggingOptions</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">This interface will no longer be the source of truth for worker logging configuration
once jobs are executed using a dedicated SDK harness instead of user code being co-located
alongside Dataflow worker code.</span></div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions.DataflowClientFactory</a></td>
<td class="colLast">
<div class="block">Returns the default Dataflow client built from the passed in PipelineOptions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.StagerFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions.StagerFactory</a></td>
<td class="colLast">
<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>DataflowPipelineDebugOptions.getStagerClass()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.DefaultGcpRegionFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions.DefaultGcpRegionFactory</a></td>
<td class="colLast">
<div class="block">Factory for a default value for Google Cloud region according to
https://cloud.google.com/compute/docs/gcloud-compute/#default-properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.StagingLocationFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions.StagingLocationFactory</a></td>
<td class="colLast">
<div class="block">Returns a default staging location under <a href="../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#getGcpTempLocation--"><code>GcpOptions.getGcpTempLocation()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.WorkerHarnessContainerImageFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions.WorkerHarnessContainerImageFactory</a></td>
<td class="colLast">
<div class="block">Returns the default Docker container image that executes Dataflow worker harness, residing in
Google Container Registry.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html" title="class in org.apache.beam.runners.dataflow.options">DataflowProfilingOptions.DataflowProfilingAgentConfiguration</a></td>
<td class="colLast">
<div class="block">Configuration the for profiling agent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.WorkerLogLevelOverrides.html" title="class in org.apache.beam.runners.dataflow.options">DataflowWorkerLoggingOptions.WorkerLogLevelOverrides</a></td>
<td class="colLast">
<div class="block">Defines a log level override for a specific class, package, or name.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.FlexResourceSchedulingGoal.html" title="enum in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions.FlexResourceSchedulingGoal</a></td>
<td class="colLast">
<div class="block">Set of available Flexible Resource Scheduling goals.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.html" title="enum in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType</a></td>
<td class="colLast">
<div class="block">Type of autoscaling algorithm to use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.Level.html" title="enum in org.apache.beam.runners.dataflow.options">DataflowWorkerLoggingOptions.Level</a></td>
<td class="colLast">
<div class="block">The set of log levels that can be used on the Dataflow worker.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.runners.dataflow.options Description">Package org.apache.beam.runners.dataflow.options Description</h2>
<div class="block">Provides <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> specific to Google Cloud Dataflow.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/runners/dataflow/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/options/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>