| <!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>ResourceHints (Apache Beam 2.38.0-SNAPSHOT)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ResourceHints (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/transforms/resourcehints/ResourceHint.html" title="class in org.apache.beam.sdk.transforms.resourcehints"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHintsOptions.html" title="interface in org.apache.beam.sdk.transforms.resourcehints"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" target="_top">Frames</a></li> |
| <li><a href="ResourceHints.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.transforms.resourcehints</div> |
| <h2 title="Class ResourceHints" class="title">Class ResourceHints</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.transforms.resourcehints.ResourceHints</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ResourceHints</span> |
| extends java.lang.Object</pre> |
| <div class="block">Pipeline authors can use resource hints to provide additional information to runners about the |
| desired aspects of the execution environment. Resource hints can be specified via <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform#setResourceHints</code></a> for parts of the pipeline, |
| or globally via <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHintsOptions.html" title="interface in org.apache.beam.sdk.transforms.resourcehints"><code>resourceHints</code></a> pipeline option. |
| |
| <p>Interpretation of hints is provided by Beam runners.</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html#create--">create</a></span>()</code> |
| <div class="block">Creates a <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints"><code>ResourceHints</code></a> instance with no hints.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html#equals-java.lang.Object-">equals</a></span>(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.Object other)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html#fromOptions-org.apache.beam.sdk.options.PipelineOptions-">fromOptions</a></span>(<a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</code> |
| <div class="block">Creates a <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints"><code>ResourceHints</code></a> instance with hints supplied in options.</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/sdk/transforms/resourcehints/ResourceHints.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHint.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHint</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html#hints--">hints</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html#mergeWithOuter-org.apache.beam.sdk.transforms.resourcehints.ResourceHints-">mergeWithOuter</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a> outer)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html#withAccelerator-java.lang.String-">withAccelerator</a></span>(java.lang.String accelerator)</code> |
| <div class="block">Declares hardware accelerators that are desired to have in the execution environment.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html#withHint-java.lang.String-org.apache.beam.sdk.transforms.resourcehints.ResourceHint-">withHint</a></span>(java.lang.String urn, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHint.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHint</a> hint)</code> |
| <div class="block">Declares a custom resource hint that has a specified URN.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html#withMinRam-long-">withMinRam</a></span>(long ramBytes)</code> |
| <div class="block">Sets desired minimal available RAM size to have in transform's execution environment.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html#withMinRam-java.lang.String-">withMinRam</a></span>(java.lang.String ramBytes)</code> |
| <div class="block">Sets desired minimal available RAM size to have in transform's execution environment.</div> |
| </td> |
| </tr> |
| </table> |
| <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>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</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="create--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a> create()</pre> |
| <div class="block">Creates a <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints"><code>ResourceHints</code></a> instance with no hints.</div> |
| </li> |
| </ul> |
| <a name="fromOptions-org.apache.beam.sdk.options.PipelineOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromOptions</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a> fromOptions(<a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</pre> |
| <div class="block">Creates a <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints"><code>ResourceHints</code></a> instance with hints supplied in options.</div> |
| </li> |
| </ul> |
| <a name="withMinRam-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMinRam</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a> withMinRam(long ramBytes)</pre> |
| <div class="block">Sets desired minimal available RAM size to have in transform's execution environment.</div> |
| </li> |
| </ul> |
| <a name="withMinRam-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMinRam</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a> withMinRam(java.lang.String ramBytes)</pre> |
| <div class="block">Sets desired minimal available RAM size to have in transform's execution environment.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ramBytes</code> - specifies a human-friendly size string, for example: '10.5 GiB', '4096 MiB', |
| etc.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withAccelerator-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAccelerator</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a> withAccelerator(java.lang.String accelerator)</pre> |
| <div class="block">Declares hardware accelerators that are desired to have in the execution environment.</div> |
| </li> |
| </ul> |
| <a name="withHint-java.lang.String-org.apache.beam.sdk.transforms.resourcehints.ResourceHint-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withHint</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a> withHint(java.lang.String urn, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHint.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHint</a> hint)</pre> |
| <div class="block">Declares a custom resource hint that has a specified URN.</div> |
| </li> |
| </ul> |
| <a name="hints--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hints</h4> |
| <pre>public java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHint.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHint</a>> hints()</pre> |
| </li> |
| </ul> |
| <a name="mergeWithOuter-org.apache.beam.sdk.transforms.resourcehints.ResourceHints-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mergeWithOuter</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a> mergeWithOuter(<a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" title="class in org.apache.beam.sdk.transforms.resourcehints">ResourceHints</a> outer)</pre> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.Object other)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </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/transforms/resourcehints/ResourceHint.html" title="class in org.apache.beam.sdk.transforms.resourcehints"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/ResourceHintsOptions.html" title="interface in org.apache.beam.sdk.transforms.resourcehints"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/resourcehints/ResourceHints.html" target="_top">Frames</a></li> |
| <li><a href="ResourceHints.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
