http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html new file mode 100644 index 0000000..c6aa5ef --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html @@ -0,0 +1,662 @@ +<!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_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>DataflowPipelineWorkerPoolOptions</title> +<meta name="date" content="2017-05-12"> +<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="DataflowPipelineWorkerPoolOptions"; + } + } + 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}; +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/DataflowPipelineOptions.StagingLocationFactory.html" title="class in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.html" title="enum 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/DataflowPipelineWorkerPoolOptions.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineWorkerPoolOptions.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 DataflowPipelineWorkerPoolOptions" class="title">Interface DataflowPipelineWorkerPoolOptions</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/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>public interface <span class="typeNameLabel">DataflowPipelineWorkerPoolOptions</span> +extends <a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></pre> +<div class="block">Options that are used to configure the Dataflow pipeline worker pool.</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/DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.html" title="enum in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType</a></span></code> +<div class="block">Type of autoscaling algorithm to use.</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/DataflowPipelineWorkerPoolOptions.WorkerHarnessContainerImageFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions.WorkerHarnessContainerImageFactory</a></span></code> +<div class="block">Returns the default Docker container image that executes Dataflow worker harness, residing in + Google Container Registry.</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></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><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.html" title="enum in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html#getAutoscalingAlgorithm--">getAutoscalingAlgorithm</a></span>()</code> +<div class="block">[Experimental] The autoscaling algorithm to use for the workerpool.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html#getDiskSizeGb--">getDiskSizeGb</a></span>()</code> +<div class="block">Remote worker disk size, in gigabytes, or 0 to use the default size.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html#getFilesToStage--">getFilesToStage</a></span>()</code> +<div class="block">List of local files to make available to workers.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html#getMaxNumWorkers--">getMaxNumWorkers</a></span>()</code> +<div class="block">The maximum number of workers to use for the workerpool.</div> +</td> +</tr> +<tr id="i4" 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/DataflowPipelineWorkerPoolOptions.html#getNetwork--">getNetwork</a></span>()</code> +<div class="block">GCE <a href="https://cloud.google.com/compute/docs/networking">network</a> for launching + workers.</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/DataflowPipelineWorkerPoolOptions.html#getNumWorkers--">getNumWorkers</a></span>()</code> +<div class="block">Number of workers to use when executing the Dataflow job.</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/DataflowPipelineWorkerPoolOptions.html#getSubnetwork--">getSubnetwork</a></span>()</code> +<div class="block">GCE <a href="https://cloud.google.com/compute/docs/networking">subnetwork</a> for launching + workers.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html#getUsePublicIps--">getUsePublicIps</a></span>()</code> +<div class="block">Specifies whether worker pools should be started with public IP addresses.</div> +</td> +</tr> +<tr id="i8" 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/DataflowPipelineWorkerPoolOptions.html#getWorkerDiskType--">getWorkerDiskType</a></span>()</code> +<div class="block">Specifies what type of persistent disk is used.</div> +</td> +</tr> +<tr id="i9" 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/DataflowPipelineWorkerPoolOptions.html#getWorkerHarnessContainerImage--">getWorkerHarnessContainerImage</a></span>()</code> +<div class="block">Docker container image that executes Dataflow worker harness, residing in Google Container + Registry.</div> +</td> +</tr> +<tr id="i10" 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/DataflowPipelineWorkerPoolOptions.html#getWorkerMachineType--">getWorkerMachineType</a></span>()</code> +<div class="block">Machine type to create Dataflow worker VMs as.</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/DataflowPipelineWorkerPoolOptions.html#getZone--">getZone</a></span>()</code> +<div class="block">GCE <a href="https://developers.google.com/compute/docs/zones" + >availability zone</a> for launching workers.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.html#setAutoscalingAlgorithm-org.apache.beam.runners.dataflow.options.DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType-">setAutoscalingAlgorithm</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.html" title="enum in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType</a> value)</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/DataflowPipelineWorkerPoolOptions.html#setDiskSizeGb-int-">setDiskSizeGb</a></span>(int 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/DataflowPipelineWorkerPoolOptions.html#setFilesToStage-java.util.List-">setFilesToStage</a></span>(java.util.List<java.lang.String> 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/DataflowPipelineWorkerPoolOptions.html#setMaxNumWorkers-int-">setMaxNumWorkers</a></span>(int 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/DataflowPipelineWorkerPoolOptions.html#setNetwork-java.lang.String-">setNetwork</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/DataflowPipelineWorkerPoolOptions.html#setNumWorkers-int-">setNumWorkers</a></span>(int value)</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/DataflowPipelineWorkerPoolOptions.html#setSubnetwork-java.lang.String-">setSubnetwork</a></span>(java.lang.String 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/DataflowPipelineWorkerPoolOptions.html#setUsePublicIps-java.lang.Boolean-">setUsePublicIps</a></span>(java.lang.Boolean 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/DataflowPipelineWorkerPoolOptions.html#setWorkerDiskType-java.lang.String-">setWorkerDiskType</a></span>(java.lang.String value)</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/DataflowPipelineWorkerPoolOptions.html#setWorkerHarnessContainerImage-java.lang.String-">setWorkerHarnessContainerImage</a></span>(java.lang.String value)</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/DataflowPipelineWorkerPoolOptions.html#setWorkerMachineType-java.lang.String-">setWorkerMachineType</a></span>(java.lang.String value)</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/DataflowPipelineWorkerPoolOptions.html#setZone-java.lang.String-">setZone</a></span>(java.lang.String value)</code> </td> +</tr> +</table> +<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#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></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="getNumWorkers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumWorkers</h4> +<pre>int getNumWorkers()</pre> +<div class="block">Number of workers to use when executing the Dataflow job. Note that selection of an autoscaling + algorithm other then <code>NONE</code> will affect the size of the worker pool. If left unspecified, + the Dataflow service will determine the number of workers.</div> +</li> +</ul> +<a name="setNumWorkers-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNumWorkers</h4> +<pre>void setNumWorkers(int value)</pre> +</li> +</ul> +<a name="getAutoscalingAlgorithm--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAutoscalingAlgorithm</h4> +<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#AUTOSCALING">AUTOSCALING</a>) +<a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.html" title="enum in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType</a> getAutoscalingAlgorithm()</pre> +<div class="block">[Experimental] The autoscaling algorithm to use for the workerpool. + + <ul> + <li>NONE: does not change the size of the worker pool.</li> + <li>BASIC: autoscale the worker pool size up to maxNumWorkers until the job completes.</li> + <li>THROUGHPUT_BASED: autoscale the workerpool based on throughput (up to maxNumWorkers). + </li> + </ul></div> +</li> +</ul> +<a name="setAutoscalingAlgorithm-org.apache.beam.runners.dataflow.options.DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoscalingAlgorithm</h4> +<pre>void setAutoscalingAlgorithm(<a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.html" title="enum in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType</a> value)</pre> +</li> +</ul> +<a name="getMaxNumWorkers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxNumWorkers</h4> +<pre>int getMaxNumWorkers()</pre> +<div class="block">The maximum number of workers to use for the workerpool. This options limits the size of the + workerpool for the lifetime of the job, including + <a href="https://cloud.google.com/dataflow/pipelines/updating-a-pipeline">pipeline updates</a>. + If left unspecified, the Dataflow service will compute a ceiling.</div> +</li> +</ul> +<a name="setMaxNumWorkers-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxNumWorkers</h4> +<pre>void setMaxNumWorkers(int value)</pre> +</li> +</ul> +<a name="getDiskSizeGb--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDiskSizeGb</h4> +<pre>int getDiskSizeGb()</pre> +<div class="block">Remote worker disk size, in gigabytes, or 0 to use the default size.</div> +</li> +</ul> +<a name="setDiskSizeGb-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDiskSizeGb</h4> +<pre>void setDiskSizeGb(int value)</pre> +</li> +</ul> +<a name="getWorkerHarnessContainerImage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorkerHarnessContainerImage</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/DataflowPipelineWorkerPoolOptions.WorkerHarnessContainerImageFactory.html" title="class in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions.WorkerHarnessContainerImageFactory.class</a>) + <a href="../../../../../../org/apache/beam/sdk/options/Hidden.html" title="annotation in org.apache.beam.sdk.options">@Hidden</a> +java.lang.String getWorkerHarnessContainerImage()</pre> +<div class="block">Docker container image that executes Dataflow worker harness, residing in Google Container + Registry.</div> +</li> +</ul> +<a name="setWorkerHarnessContainerImage-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWorkerHarnessContainerImage</h4> +<pre>void setWorkerHarnessContainerImage(java.lang.String value)</pre> +</li> +</ul> +<a name="getNetwork--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNetwork</h4> +<pre>java.lang.String getNetwork()</pre> +<div class="block">GCE <a href="https://cloud.google.com/compute/docs/networking">network</a> for launching + workers. + + <p>Default is up to the Dataflow service.</div> +</li> +</ul> +<a name="setNetwork-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNetwork</h4> +<pre>void setNetwork(java.lang.String value)</pre> +</li> +</ul> +<a name="getSubnetwork--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSubnetwork</h4> +<pre>java.lang.String getSubnetwork()</pre> +<div class="block">GCE <a href="https://cloud.google.com/compute/docs/networking">subnetwork</a> for launching + workers. + + <p>Default is up to the Dataflow service. Expected format is + regions/REGION/subnetworks/SUBNETWORK or the fully qualified subnetwork name, beginning with + https://..., e.g. https://www.googleapis.com/compute/alpha/projects/PROJECT/ + regions/REGION/subnetworks/SUBNETWORK</div> +</li> +</ul> +<a name="setSubnetwork-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSubnetwork</h4> +<pre>void setSubnetwork(java.lang.String value)</pre> +</li> +</ul> +<a name="getZone--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getZone</h4> +<pre>java.lang.String getZone()</pre> +<div class="block">GCE <a href="https://developers.google.com/compute/docs/zones" + >availability zone</a> for launching workers. + + <p>Default is up to the Dataflow service.</div> +</li> +</ul> +<a name="setZone-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setZone</h4> +<pre>void setZone(java.lang.String value)</pre> +</li> +</ul> +<a name="getWorkerMachineType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorkerMachineType</h4> +<pre>java.lang.String getWorkerMachineType()</pre> +<div class="block">Machine type to create Dataflow worker VMs as. + + <p>See <a href="https://cloud.google.com/compute/docs/machine-types">GCE machine types</a> + for a list of valid options. + + <p>If unset, the Dataflow service will choose a reasonable default.</div> +</li> +</ul> +<a name="setWorkerMachineType-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWorkerMachineType</h4> +<pre>void setWorkerMachineType(java.lang.String value)</pre> +</li> +</ul> +<a name="getFilesToStage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilesToStage</h4> +<pre>java.util.List<java.lang.String> getFilesToStage()</pre> +<div class="block">List of local files to make available to workers. + + <p>Files are placed on the worker's classpath. + + <p>The default value is the list of jars from the main program's classpath.</div> +</li> +</ul> +<a name="setFilesToStage-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFilesToStage</h4> +<pre>void setFilesToStage(java.util.List<java.lang.String> value)</pre> +</li> +</ul> +<a name="getWorkerDiskType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorkerDiskType</h4> +<pre>java.lang.String getWorkerDiskType()</pre> +<div class="block">Specifies what type of persistent disk is used. The value is a full disk type resource, + e.g., compute.googleapis.com/projects//zones//diskTypes/pd-ssd. For more information, + see the <a href="https://cloud.google.com/compute/docs/reference/latest/diskTypes">API + reference documentation for DiskTypes</a>.</div> +</li> +</ul> +<a name="setWorkerDiskType-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWorkerDiskType</h4> +<pre>void setWorkerDiskType(java.lang.String value)</pre> +</li> +</ul> +<a name="getUsePublicIps--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUsePublicIps</h4> +<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> + @Nullable +java.lang.Boolean getUsePublicIps()</pre> +<div class="block">Specifies whether worker pools should be started with public IP addresses. + + <p>WARNING: This feature is experimental. You must be whitelisted to use it.</div> +</li> +</ul> +<a name="setUsePublicIps-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setUsePublicIps</h4> +<pre>void setUsePublicIps(@Nullable + java.lang.Boolean value)</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/DataflowPipelineOptions.StagingLocationFactory.html" title="class in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.html" title="enum 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/DataflowPipelineWorkerPoolOptions.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineWorkerPoolOptions.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>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html new file mode 100644 index 0000000..3aabcab --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html @@ -0,0 +1,301 @@ +<!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_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>DataflowProfilingOptions.DataflowProfilingAgentConfiguration</title> +<meta name="date" content="2017-05-12"> +<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="DataflowProfilingOptions.DataflowProfilingAgentConfiguration"; + } + } + 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><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/DataflowProfilingOptions.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/DataflowWorkerHarnessOptions.html" title="interface 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/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html" target="_top">Frames</a></li> +<li><a href="DataflowProfilingOptions.DataflowProfilingAgentConfiguration.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.classes.inherited.from.class.java.util.AbstractMap">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.util.HashMap">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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="Class DataflowProfilingOptions.DataflowProfilingAgentConfiguration" class="title">Class DataflowProfilingOptions.DataflowProfilingAgentConfiguration</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.util.AbstractMap<K,V></li> +<li> +<ul class="inheritance"> +<li>java.util.HashMap<java.lang.String,java.lang.Object></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.options.DataflowProfilingOptions.DataflowProfilingAgentConfiguration</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowProfilingOptions</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">DataflowProfilingOptions.DataflowProfilingAgentConfiguration</span> +extends java.util.HashMap<java.lang.String,java.lang.Object></pre> +<div class="block">Configuration the for profiling agent.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.dataflow.options.DataflowProfilingOptions.DataflowProfilingAgentConfiguration">Serialized Form</a></dd> +</dl> +</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.java.util.AbstractMap"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class java.util.AbstractMap</h3> +<code>java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface java.util.Map</h3> +<code>java.util.Map.Entry<K,V></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html#DataflowProfilingAgentConfiguration--">DataflowProfilingAgentConfiguration</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.HashMap"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.HashMap</h3> +<code>clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.AbstractMap"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractMap</h3> +<code>equals, hashCode, toString</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Map</h3> +<code>equals, hashCode</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DataflowProfilingAgentConfiguration--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataflowProfilingAgentConfiguration</h4> +<pre>public DataflowProfilingAgentConfiguration()</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/DataflowProfilingOptions.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/DataflowWorkerHarnessOptions.html" title="interface 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/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html" target="_top">Frames</a></li> +<li><a href="DataflowProfilingOptions.DataflowProfilingAgentConfiguration.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.classes.inherited.from.class.java.util.AbstractMap">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.util.HashMap">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.html new file mode 100644 index 0000000..d763adb --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.html @@ -0,0 +1,287 @@ +<!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_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>DataflowProfilingOptions</title> +<meta name="date" content="2017-05-12"> +<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="DataflowProfilingOptions"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":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/DataflowPipelineWorkerPoolOptions.WorkerHarnessContainerImageFactory.html" title="class in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.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/DataflowProfilingOptions.html" target="_top">Frames</a></li> +<li><a href="DataflowProfilingOptions.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 DataflowProfilingOptions" class="title">Interface DataflowProfilingOptions</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<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/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> + <a href="../../../../../../org/apache/beam/sdk/options/Hidden.html" title="annotation in org.apache.beam.sdk.options">@Hidden</a> +public interface <span class="typeNameLabel">DataflowProfilingOptions</span></pre> +<div class="block">Options for controlling profiling of pipeline execution.</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/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html" title="class in org.apache.beam.runners.dataflow.options">DataflowProfilingOptions.DataflowProfilingAgentConfiguration</a></span></code> +<div class="block">Configuration the for profiling agent.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html" title="class in org.apache.beam.runners.dataflow.options">DataflowProfilingOptions.DataflowProfilingAgentConfiguration</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.html#getProfilingAgentConfiguration--">getProfilingAgentConfiguration</a></span>()</code> </td> +</tr> +<tr id="i1" 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/DataflowProfilingOptions.html#getSaveProfilesToGcs--">getSaveProfilesToGcs</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.html#setProfilingAgentConfiguration-org.apache.beam.runners.dataflow.options.DataflowProfilingOptions.DataflowProfilingAgentConfiguration-">setProfilingAgentConfiguration</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html" title="class in org.apache.beam.runners.dataflow.options">DataflowProfilingOptions.DataflowProfilingAgentConfiguration</a> configuration)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.html#setSaveProfilesToGcs-java.lang.String-">setSaveProfilesToGcs</a></span>(java.lang.String gcsPath)</code> </td> +</tr> +</table> +</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="getSaveProfilesToGcs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSaveProfilesToGcs</h4> +<pre>java.lang.String getSaveProfilesToGcs()</pre> +</li> +</ul> +<a name="setSaveProfilesToGcs-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSaveProfilesToGcs</h4> +<pre>void setSaveProfilesToGcs(java.lang.String gcsPath)</pre> +</li> +</ul> +<a name="getProfilingAgentConfiguration--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProfilingAgentConfiguration</h4> +<pre><a href="../../../../../../org/apache/beam/sdk/options/Hidden.html" title="annotation in org.apache.beam.sdk.options">@Hidden</a> +<a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html" title="class in org.apache.beam.runners.dataflow.options">DataflowProfilingOptions.DataflowProfilingAgentConfiguration</a> getProfilingAgentConfiguration()</pre> +</li> +</ul> +<a name="setProfilingAgentConfiguration-org.apache.beam.runners.dataflow.options.DataflowProfilingOptions.DataflowProfilingAgentConfiguration-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setProfilingAgentConfiguration</h4> +<pre>void setProfilingAgentConfiguration(<a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.html" title="class in org.apache.beam.runners.dataflow.options">DataflowProfilingOptions.DataflowProfilingAgentConfiguration</a> configuration)</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/DataflowPipelineWorkerPoolOptions.WorkerHarnessContainerImageFactory.html" title="class in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowProfilingOptions.DataflowProfilingAgentConfiguration.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/DataflowProfilingOptions.html" target="_top">Frames</a></li> +<li><a href="DataflowProfilingOptions.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>