Google Git
Sign in
apache / beam-site / refs/heads/revert-643-revert-642-updates_release_2.47.0 / . / javadoc / 2.47.0 / org / apache / beam / runners / dataflow / util / Stager.html
blob: 2f12b9b664d84058f703e6859eed8ce832f64556 [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 -->
<title>Stager (Apache Beam 2.47.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Stager (Apache Beam 2.47.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/SchemaCoderCloudObjectTranslator.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/Structs.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/Stager.html" target="_top">Frames</a></li>
<li><a href="Stager.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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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.runners.dataflow.util</div>
<h2 title="Interface Stager" class="title">Interface Stager</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/beam/runners/dataflow/util/GcsStager.html" title="class in org.apache.beam.runners.dataflow.util">GcsStager</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Stager</span></pre>
<div class="block">Interface for staging files needed for running a Dataflow pipeline.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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.util.List&lt;<a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20220920-2.0.0/com/google/api/services/dataflow/model/DataflowPackage.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model">DataflowPackage</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html#stageFiles-java.util.List-">stageFiles</a></span>(java.util.List&lt;<a href="../../../../../../org/apache/beam/runners/dataflow/util/PackageUtil.StagedFile.html" title="class in org.apache.beam.runners.dataflow.util">PackageUtil.StagedFile</a>&gt;&nbsp;filesToStage)</code>
<div class="block">Stage files and return a list of packages <a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20220920-2.0.0/com/google/api/services/dataflow/model/DataflowPackage.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model"><code>DataflowPackage</code></a> objects describing th actual
location at which each file was staged.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20220920-2.0.0/com/google/api/services/dataflow/model/DataflowPackage.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model">DataflowPackage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html#stageToFile-byte:A-java.lang.String-">stageToFile</a></span>(byte[]&nbsp;bytes,
java.lang.String&nbsp;baseName)</code>
<div class="block">Stage bytes to a target file name wherever this stager stages things.</div>
</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="stageFiles-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stageFiles</h4>
<pre>java.util.List&lt;<a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20220920-2.0.0/com/google/api/services/dataflow/model/DataflowPackage.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model">DataflowPackage</a>&gt;&nbsp;stageFiles(java.util.List&lt;<a href="../../../../../../org/apache/beam/runners/dataflow/util/PackageUtil.StagedFile.html" title="class in org.apache.beam.runners.dataflow.util">PackageUtil.StagedFile</a>&gt;&nbsp;filesToStage)</pre>
<div class="block">Stage files and return a list of packages <a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20220920-2.0.0/com/google/api/services/dataflow/model/DataflowPackage.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model"><code>DataflowPackage</code></a> objects describing th actual
location at which each file was staged.
<p>The mechanism for staging is owned by the implementation. The only requirement is that the
location specified in the returned <a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20220920-2.0.0/com/google/api/services/dataflow/model/DataflowPackage.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model"><code>DataflowPackage</code></a> should, in fact, contain the
contents of the staged file.</div>
</li>
</ul>
<a name="stageToFile-byte:A-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stageToFile</h4>
<pre><a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20220920-2.0.0/com/google/api/services/dataflow/model/DataflowPackage.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model">DataflowPackage</a>&nbsp;stageToFile(byte[]&nbsp;bytes,
java.lang.String&nbsp;baseName)</pre>
<div class="block">Stage bytes to a target file name wherever this stager stages things.</div>
</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/util/SchemaCoderCloudObjectTranslator.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/Structs.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/Stager.html" target="_top">Frames</a></li>
<li><a href="Stager.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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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>