Google Git
Sign in
apache / beam-site / 8066db78465c0d76bfe854be06941aea4657c8d5 / . / javadoc / javadoc / org / apache / beam / sdk / extensions / gcp / options / GcpOptions.html
blob: f462173479b1a508e4604d5897204baf1f31925b [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:29 PST 2020 -->
<title>GcpOptions (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="GcpOptions (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6};
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/sdk/extensions/gcp/options/CloudResourceManagerOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.DefaultProjectFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html" target="_top">Frames</a></li>
<li><a href="GcpOptions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.extensions.gcp.options</div>
<h2 title="Interface GcpOptions" class="title">Interface GcpOptions</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/extensions/gcp/options/GoogleApiDebugOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options">GoogleApiDebugOptions</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/BigQueryOptions.html" title="interface in org.apache.beam.sdk.io.gcp.bigquery">BigQueryOptions</a>, <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/CloudResourceManagerOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options">CloudResourceManagerOptions</a>, <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/DataflowPipelineWorkerPoolOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineWorkerPoolOptions</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/sdk/extensions/gcp/options/GcsOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options">GcsOptions</a>, <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubOptions.html" title="interface in org.apache.beam.sdk.io.gcp.pubsub">PubsubOptions</a>, <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/TestBigQueryOptions.html" title="interface in org.apache.beam.sdk.io.gcp.bigquery">TestBigQueryOptions</a>, <a href="../../../../../../../org/apache/beam/runners/dataflow/TestDataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow">TestDataflowPipelineOptions</a>, <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/TestPubsubOptions.html" title="interface in org.apache.beam.sdk.io.gcp.pubsub">TestPubsubOptions</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">GcpOptions</span>
extends <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GoogleApiDebugOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options">GoogleApiDebugOptions</a>, <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></pre>
<div class="block">Options used to configure Google Cloud Platform specific options such as the project and
credentials.
<p>These options defer to the <a
href="https://developers.google.com/accounts/docs/application-default-credentials">application
default credentials</a> for authentication. See the <a
href="https://github.com/google/google-auth-library-java">Google Auth Library</a> for alternative
mechanisms for creating credentials.</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">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.DefaultProjectFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.DefaultProjectFactory</a></span></code>
<div class="block">Attempts to infer the default project based upon the environment this application is executing
within.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.EnableStreamingEngineFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.EnableStreamingEngineFactory</a></span></code>
<div class="block">EneableStreamingEngine defaults to false unless one of the two experiments is set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.GcpTempLocationFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.GcpTempLocationFactory</a></span></code>
<div class="block">Returns <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getTempLocation--"><code>PipelineOptions.getTempLocation()</code></a> as the default GCP temp location.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.GcpUserCredentialsFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.GcpUserCredentialsFactory</a></span></code>
<div class="block">Attempts to load the GCP credentials.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.extensions.gcp.options.GoogleApiDebugOptions">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.beam.sdk.extensions.gcp.options.<a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GoogleApiDebugOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options">GoogleApiDebugOptions</a></h3>
<code><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GoogleApiDebugOptions.GoogleApiTracer.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GoogleApiDebugOptions.GoogleApiTracer</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&nbsp;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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#STREAMING_ENGINE_EXPERIMENT">STREAMING_ENGINE_EXPERIMENT</a></span></code>
<div class="block">Experiment to turn on the Streaming Engine experiment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#WINDMILL_SERVICE_EXPERIMENT">WINDMILL_SERVICE_EXPERIMENT</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use STREAMING_ENGINE_EXPERIMENT instead.</span></div>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/auth/CredentialFactory.html" title="interface in org.apache.beam.sdk.extensions.gcp.auth">CredentialFactory</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#getCredentialFactoryClass--">getCredentialFactoryClass</a></span>()</code>
<div class="block">The class of the credential factory that should be created and used to create credentials.</div>
</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/sdk/extensions/gcp/options/GcpOptions.html#getDataflowKmsKey--">getDataflowKmsKey</a></span>()</code>
<div class="block">GCP <a href="https://cloud.google.com/kms/">Cloud KMS</a> key for Dataflow pipelines and
buckets created by GcpTempLocationFactory.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/com.google.auth/google-auth-library-credentials/0.19.0/com/google/auth/Credentials.html?is-external=true" title="class or interface in com.google.auth">Credentials</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#getGcpCredential--">getGcpCredential</a></span>()</code>
<div class="block">The credential instance that should be used to authenticate against GCP services.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#getGcpTempLocation--">getGcpTempLocation</a></span>()</code>
<div class="block">A GCS path for storing temporary files in GCP.</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/sdk/extensions/gcp/options/GcpOptions.html#getProject--">getProject</a></span>()</code>
<div class="block">Project id to use when launching jobs.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#getWorkerRegion--">getWorkerRegion</a></span>()</code>
<div class="block">The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones)
in which worker processing should occur, e.g.</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/sdk/extensions/gcp/options/GcpOptions.html#getWorkerZone--">getWorkerZone</a></span>()</code>
<div class="block">The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in
which worker processing should occur, e.g.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#getZone--">getZone</a></span>()</code>
<div class="block">GCP <a href="https://developers.google.com/compute/docs/zones" >availability zone</a> for
operations.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#isEnableStreamingEngine--">isEnableStreamingEngine</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#setCredentialFactoryClass-java.lang.Class-">setCredentialFactoryClass</a></span>(java.lang.Class&lt;? extends <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/auth/CredentialFactory.html" title="interface in org.apache.beam.sdk.extensions.gcp.auth">CredentialFactory</a>&gt;&nbsp;credentialFactoryClass)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#setDataflowKmsKey-java.lang.String-">setDataflowKmsKey</a></span>(java.lang.String&nbsp;dataflowKmsKey)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#setEnableStreamingEngine-boolean-">setEnableStreamingEngine</a></span>(boolean&nbsp;value)</code>&nbsp;</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/sdk/extensions/gcp/options/GcpOptions.html#setGcpCredential-com.google.auth.Credentials-">setGcpCredential</a></span>(<a href="https://static.javadoc.io/com.google.auth/google-auth-library-credentials/0.19.0/com/google/auth/Credentials.html?is-external=true" title="class or interface in com.google.auth">Credentials</a>&nbsp;value)</code>&nbsp;</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/sdk/extensions/gcp/options/GcpOptions.html#setGcpTempLocation-java.lang.String-">setGcpTempLocation</a></span>(java.lang.String&nbsp;value)</code>&nbsp;</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/sdk/extensions/gcp/options/GcpOptions.html#setProject-java.lang.String-">setProject</a></span>(java.lang.String&nbsp;value)</code>&nbsp;</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/sdk/extensions/gcp/options/GcpOptions.html#setWorkerRegion-java.lang.String-">setWorkerRegion</a></span>(java.lang.String&nbsp;workerRegion)</code>&nbsp;</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/sdk/extensions/gcp/options/GcpOptions.html#setWorkerZone-java.lang.String-">setWorkerZone</a></span>(java.lang.String&nbsp;workerZone)</code>&nbsp;</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/sdk/extensions/gcp/options/GcpOptions.html#setZone-java.lang.String-">setZone</a></span>(java.lang.String&nbsp;value)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.extensions.gcp.options.GoogleApiDebugOptions">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.beam.sdk.extensions.gcp.options.<a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GoogleApiDebugOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options">GoogleApiDebugOptions</a></h3>
<code><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GoogleApiDebugOptions.html#getGoogleApiTrace--">getGoogleApiTrace</a>, <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GoogleApiDebugOptions.html#setGoogleApiTrace-org.apache.beam.sdk.extensions.gcp.options.GoogleApiDebugOptions.GoogleApiTracer-">setGoogleApiTrace</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&nbsp;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&nbsp;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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="STREAMING_ENGINE_EXPERIMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STREAMING_ENGINE_EXPERIMENT</h4>
<pre>static final&nbsp;java.lang.String STREAMING_ENGINE_EXPERIMENT</pre>
<div class="block">Experiment to turn on the Streaming Engine experiment.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.beam.sdk.extensions.gcp.options.GcpOptions.STREAMING_ENGINE_EXPERIMENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WINDMILL_SERVICE_EXPERIMENT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WINDMILL_SERVICE_EXPERIMENT</h4>
<pre>@Deprecated
static final&nbsp;java.lang.String WINDMILL_SERVICE_EXPERIMENT</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use STREAMING_ENGINE_EXPERIMENT instead.</span></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.apache.beam.sdk.extensions.gcp.options.GcpOptions.WINDMILL_SERVICE_EXPERIMENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getProject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProject</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/sdk/extensions/gcp/options/GcpOptions.DefaultProjectFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.DefaultProjectFactory.class</a>)
java.lang.String&nbsp;getProject()</pre>
<div class="block">Project id to use when launching jobs.</div>
</li>
</ul>
<a name="setProject-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProject</h4>
<pre>void&nbsp;setProject(java.lang.String&nbsp;value)</pre>
</li>
</ul>
<a name="getZone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZone</h4>
<pre>java.lang.String&nbsp;getZone()</pre>
<div class="block">GCP <a href="https://developers.google.com/compute/docs/zones" >availability zone</a> for
operations.
<p>Default is set on a per-service basis.</div>
</li>
</ul>
<a name="setZone-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setZone</h4>
<pre>void&nbsp;setZone(java.lang.String&nbsp;value)</pre>
</li>
</ul>
<a name="getWorkerRegion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkerRegion</h4>
<pre>java.lang.String&nbsp;getWorkerRegion()</pre>
<div class="block">The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones)
in which worker processing should occur, e.g. "us-west1". Mutually exclusive with <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#getWorkerZone--"><code>getWorkerZone()</code></a>. If neither workerRegion nor workerZone is specified, default to same value
as region.</div>
</li>
</ul>
<a name="setWorkerRegion-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWorkerRegion</h4>
<pre>void&nbsp;setWorkerRegion(java.lang.String&nbsp;workerRegion)</pre>
</li>
</ul>
<a name="getWorkerZone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkerZone</h4>
<pre>java.lang.String&nbsp;getWorkerZone()</pre>
<div class="block">The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in
which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html#getWorkerRegion--"><code>getWorkerRegion()</code></a>. If neither workerRegion nor workerZone is specified, the Dataflow service
will choose a zone in region based on available capacity.</div>
</li>
</ul>
<a name="setWorkerZone-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWorkerZone</h4>
<pre>void&nbsp;setWorkerZone(java.lang.String&nbsp;workerZone)</pre>
</li>
</ul>
<a name="getCredentialFactoryClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCredentialFactoryClass</h4>
<pre><a href="../../../../../../../org/apache/beam/sdk/options/Default.Class.html" title="annotation in org.apache.beam.sdk.options">@Default.Class</a>(<a href="../../../../../../../org/apache/beam/sdk/options/Default.Class.html#value--">value</a>=<a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/auth/GcpCredentialFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.auth">GcpCredentialFactory.class</a>)
java.lang.Class&lt;? extends <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/auth/CredentialFactory.html" title="interface in org.apache.beam.sdk.extensions.gcp.auth">CredentialFactory</a>&gt;&nbsp;getCredentialFactoryClass()</pre>
<div class="block">The class of the credential factory that should be created and used to create credentials. If
gcpCredential has not been set explicitly, an instance of this class will be constructed and
used as a credential factory.</div>
</li>
</ul>
<a name="setCredentialFactoryClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCredentialFactoryClass</h4>
<pre>void&nbsp;setCredentialFactoryClass(java.lang.Class&lt;? extends <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/auth/CredentialFactory.html" title="interface in org.apache.beam.sdk.extensions.gcp.auth">CredentialFactory</a>&gt;&nbsp;credentialFactoryClass)</pre>
</li>
</ul>
<a name="getGcpCredential--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGcpCredential</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/sdk/extensions/gcp/options/GcpOptions.GcpUserCredentialsFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.GcpUserCredentialsFactory.class</a>)
<a href="https://static.javadoc.io/com.google.auth/google-auth-library-credentials/0.19.0/com/google/auth/Credentials.html?is-external=true" title="class or interface in com.google.auth">Credentials</a>&nbsp;getGcpCredential()</pre>
<div class="block">The credential instance that should be used to authenticate against GCP services. If no
credential has been set explicitly, the default is to use the instance factory that constructs
a credential based upon the currently set credentialFactoryClass.</div>
</li>
</ul>
<a name="setGcpCredential-com.google.auth.Credentials-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGcpCredential</h4>
<pre>void&nbsp;setGcpCredential(<a href="https://static.javadoc.io/com.google.auth/google-auth-library-credentials/0.19.0/com/google/auth/Credentials.html?is-external=true" title="class or interface in com.google.auth">Credentials</a>&nbsp;value)</pre>
</li>
</ul>
<a name="isEnableStreamingEngine--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnableStreamingEngine</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/sdk/extensions/gcp/options/GcpOptions.EnableStreamingEngineFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.EnableStreamingEngineFactory.class</a>)
boolean&nbsp;isEnableStreamingEngine()</pre>
</li>
</ul>
<a name="setEnableStreamingEngine-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnableStreamingEngine</h4>
<pre>void&nbsp;setEnableStreamingEngine(boolean&nbsp;value)</pre>
</li>
</ul>
<a name="getGcpTempLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGcpTempLocation</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/sdk/extensions/gcp/options/GcpOptions.GcpTempLocationFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options">GcpOptions.GcpTempLocationFactory.class</a>)
<a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
java.lang.String&nbsp;getGcpTempLocation()</pre>
<div class="block">A GCS path for storing temporary files in GCP.
<p>Its default to <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getTempLocation--"><code>PipelineOptions.getTempLocation()</code></a>.</div>
</li>
</ul>
<a name="setGcpTempLocation-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGcpTempLocation</h4>
<pre>void&nbsp;setGcpTempLocation(java.lang.String&nbsp;value)</pre>
</li>
</ul>
<a name="getDataflowKmsKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataflowKmsKey</h4>
<pre><a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>
<a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
java.lang.String&nbsp;getDataflowKmsKey()</pre>
<div class="block">GCP <a href="https://cloud.google.com/kms/">Cloud KMS</a> key for Dataflow pipelines and
buckets created by GcpTempLocationFactory.</div>
</li>
</ul>
<a name="setDataflowKmsKey-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setDataflowKmsKey</h4>
<pre>void&nbsp;setDataflowKmsKey(java.lang.String&nbsp;dataflowKmsKey)</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/sdk/extensions/gcp/options/CloudResourceManagerOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.DefaultProjectFactory.html" title="class in org.apache.beam.sdk.extensions.gcp.options"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html" target="_top">Frames</a></li>
<li><a href="GcpOptions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>