| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- GitHub action javadoc-cleanup --> |
| <link rel="canonical" href="https://beam.apache.org/releases/javadoc/current/org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <!-- End javadoc-cleanup block --> |
| <!-- Generated by javadoc --> |
| <title>BigtableResourceManager (Apache Beam 2.53.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="BigtableResourceManager (Apache Beam 2.53.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.Builder.html" title="class in org.apache.beam.it.gcp.bigtable"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html" target="_top">Frames</a></li> |
| <li><a href="BigtableResourceManager.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.it.gcp.bigtable</div> |
| <h2 title="Class BigtableResourceManager" class="title">Class BigtableResourceManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.it.gcp.bigtable.BigtableResourceManager</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.beam.it.common.ResourceManager</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">BigtableResourceManager</span> |
| extends java.lang.Object |
| implements org.apache.beam.it.common.ResourceManager</pre> |
| <div class="block">Client for managing Bigtable resources. |
| |
| <p>The class supports one instance, and multiple tables per manager object. An instance is |
| created when the first table is created if one has not been created already. |
| |
| <p>The instance id is formed using testId. The instance id will be "{testId}-{ISO8601 time, |
| microsecond precision}", with additional formatting. Note: If testId is more than 30 characters, |
| a new testId will be formed for naming: {first 21 chars of long testId} + “-” + {8 char hash of |
| testId}. |
| |
| <p>The class is thread-safe.</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">Class 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/it/gcp/bigtable/BigtableResourceManager.Builder.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManager.Builder</a></span></code> |
| <div class="block">Builder for <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html" title="class in org.apache.beam.it.gcp.bigtable"><code>BigtableResourceManager</code></a>.</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="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/it/gcp/bigtable/BigtableResourceManager.Builder.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManager.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#builder-java.lang.String-java.lang.String-com.google.api.gax.core.CredentialsProvider-">builder</a></span>(java.lang.String testId, |
| java.lang.String projectId, |
| com.google.api.gax.core.CredentialsProvider credentialsProvider)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#cleanupAll--">cleanupAll</a></span>()</code> |
| <div class="block">Deletes all created resources (instance and tables) and cleans up all Bigtable clients, making |
| the manager object unusable.</div> |
| </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/it/gcp/bigtable/BigtableResourceManager.html#createAppProfile-java.lang.String-boolean-java.util.List-">createAppProfile</a></span>(java.lang.String appProfileId, |
| boolean allowTransactionWrites, |
| java.util.List<java.lang.String> clusters)</code> |
| <div class="block">Creates an application profile within the current instance</div> |
| </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/it/gcp/bigtable/BigtableResourceManager.html#createInstance-java.util.List-">createInstance</a></span>(java.util.List<<a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerCluster.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerCluster</a>> clusters)</code> |
| <div class="block">Creates a Bigtable instance in which all clusters, nodes and tables will exist.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#createTable-java.lang.String-org.apache.beam.it.gcp.bigtable.BigtableTableSpec-">createTable</a></span>(java.lang.String tableId, |
| <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableTableSpec.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableTableSpec</a> bigtableTableSpec)</code> |
| <div class="block">Creates a table within the current instance given a table ID and a collection of column family |
| names.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#createTable-java.lang.String-java.lang.Iterable-">createTable</a></span>(java.lang.String tableId, |
| java.lang.Iterable<java.lang.String> columnFamilies)</code> |
| <div class="block">Creates a table within the current instance given a table ID and a collection of column family |
| names.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#createTable-java.lang.String-java.lang.Iterable-org.threeten.bp.Duration-">createTable</a></span>(java.lang.String tableId, |
| java.lang.Iterable<java.lang.String> columnFamilies, |
| org.threeten.bp.Duration maxAge)</code> |
| <div class="block">Creates a table within the current instance given a table ID and a collection of column family |
| names.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#getClusterNames--">getClusterNames</a></span>()</code> |
| <div class="block">Get all the cluster names of the current instance.</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/it/gcp/bigtable/BigtableResourceManager.html#getInstanceId--">getInstanceId</a></span>()</code> |
| <div class="block">Return the instance ID this Resource Manager uses to create and manage tables in.</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/it/gcp/bigtable/BigtableResourceManager.html#getProjectId--">getProjectId</a></span>()</code> |
| <div class="block">Returns the project ID this Resource Manager is configured to operate on.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>com.google.common.collect.ImmutableList<com.google.cloud.bigtable.data.v2.models.Row></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#readTable-java.lang.String-">readTable</a></span>(java.lang.String tableId)</code> |
| <div class="block">Reads all the rows in a table.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.collect.ImmutableList<com.google.cloud.bigtable.data.v2.models.Row></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#readTable-java.lang.String-java.lang.Long-">readTable</a></span>(java.lang.String tableId, |
| java.lang.Long limit)</code> |
| <div class="block">Reads all the rows in a table.</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/it/gcp/bigtable/BigtableResourceManager.html#write-java.lang.Iterable-">write</a></span>(java.lang.Iterable<com.google.cloud.bigtable.data.v2.models.RowMutation> tableRows)</code> |
| <div class="block">Writes a collection of table rows into one or more tables.</div> |
| </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/it/gcp/bigtable/BigtableResourceManager.html#write-com.google.cloud.bigtable.data.v2.models.RowMutation-">write</a></span>(com.google.cloud.bigtable.data.v2.models.RowMutation tableRow)</code> |
| <div class="block">Writes a given row into a table.</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, equals, finalize, getClass, hashCode, 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="builder-java.lang.String-java.lang.String-com.google.api.gax.core.CredentialsProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.Builder.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManager.Builder</a> builder(java.lang.String testId, |
| java.lang.String projectId, |
| com.google.api.gax.core.CredentialsProvider credentialsProvider)</pre> |
| </li> |
| </ul> |
| <a name="getProjectId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProjectId</h4> |
| <pre>public java.lang.String getProjectId()</pre> |
| <div class="block">Returns the project ID this Resource Manager is configured to operate on.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the project ID.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInstanceId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstanceId</h4> |
| <pre>public java.lang.String getInstanceId()</pre> |
| <div class="block">Return the instance ID this Resource Manager uses to create and manage tables in.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the instance ID.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createInstance-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createInstance</h4> |
| <pre>public void createInstance(java.util.List<<a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerCluster.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerCluster</a>> clusters) |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Creates a Bigtable instance in which all clusters, nodes and tables will exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clusters</code> - List of BigtableResourceManagerCluster objects to associate with the given |
| Bigtable instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if there is an error creating the instance in |
| Bigtable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTable-java.lang.String-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>public void createTable(java.lang.String tableId, |
| java.lang.Iterable<java.lang.String> columnFamilies) |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Creates a table within the current instance given a table ID and a collection of column family |
| names. |
| |
| <p>Bigtable has the capability to store multiple versions of data in a single cell, which are |
| indexed using timestamp values. The timestamp can be set by Bigtable, with the default |
| timestamp value being 1970-01-01, or can be set explicitly. The columns in the created table |
| will be automatically garbage collected once they reach an age of 1-hour after the set |
| timestamp. |
| |
| <p>Note: Implementations may do instance creation here, if one does not already exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableId</code> - The id of the table.</dd> |
| <dd><code>columnFamilies</code> - A collection of column family names for the table.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if there is an error creating the table in Bigtable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTable-java.lang.String-java.lang.Iterable-org.threeten.bp.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>public void createTable(java.lang.String tableId, |
| java.lang.Iterable<java.lang.String> columnFamilies, |
| org.threeten.bp.Duration maxAge) |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Creates a table within the current instance given a table ID and a collection of column family |
| names. |
| |
| <p>Bigtable has the capability to store multiple versions of data in a single cell, which are |
| indexed using timestamp values. The timestamp can be set by Bigtable, with the default |
| timestamp value being 1970-01-01, or can be set explicitly. The columns in the created table |
| will be automatically garbage collected once they reach an age of <code>maxAge</code> after the set |
| timestamp. |
| |
| <p>Note: Implementations may do instance creation here, if one does not already exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableId</code> - The id of the table.</dd> |
| <dd><code>columnFamilies</code> - A collection of column family names for the table.</dd> |
| <dd><code>maxAge</code> - Sets the maximum age the columns can persist before being garbage collected.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if there is an error creating the table in Bigtable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTable-java.lang.String-org.apache.beam.it.gcp.bigtable.BigtableTableSpec-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>public void createTable(java.lang.String tableId, |
| <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableTableSpec.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableTableSpec</a> bigtableTableSpec) |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Creates a table within the current instance given a table ID and a collection of column family |
| names. |
| |
| <p>Bigtable has the capability to store multiple versions of data in a single cell, which are |
| indexed using timestamp values. The timestamp can be set by Bigtable, with the default |
| timestamp value being 1970-01-01, or can be set explicitly. The columns in the created table |
| will be automatically garbage collected once they reach an age of <code>maxAge</code> after the set |
| timestamp. |
| |
| <p>Note: Implementations may do instance creation here, if one does not already exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableId</code> - The id of the table.</dd> |
| <dd><code>bigtableTableSpec</code> - Other table configurations</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if there is an error creating the table in Bigtable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createAppProfile-java.lang.String-boolean-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAppProfile</h4> |
| <pre>public void createAppProfile(java.lang.String appProfileId, |
| boolean allowTransactionWrites, |
| java.util.List<java.lang.String> clusters) |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Creates an application profile within the current instance |
| |
| <p>Note: Implementations may do instance creation here, if one does not already exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appProfileId</code> - The id of the app profile.</dd> |
| <dd><code>allowTransactionWrites</code> - Allows transactional writes when single cluster routing is |
| enabled</dd> |
| <dd><code>clusters</code> - Clusters where traffic is going to be routed. If more than one cluster is |
| specified, a multi-cluster routing is used. A single-cluster routing is used when a single |
| cluster is specified.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if there is an error creating the application profile |
| in Bigtable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write-com.google.cloud.bigtable.data.v2.models.RowMutation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public void write(com.google.cloud.bigtable.data.v2.models.RowMutation tableRow) |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Writes a given row into a table. This method requires <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#createTable-java.lang.String-java.lang.Iterable-"><code>createTable(String, Iterable)</code></a> to be called for the target table |
| beforehand.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableRow</code> - A mutation object representing the table row.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if method is called after resources have been cleaned |
| up, if the manager object has no instance, if the table does not exist or if there is an |
| IOException when attempting to retrieve the bigtable data client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public void write(java.lang.Iterable<com.google.cloud.bigtable.data.v2.models.RowMutation> tableRows) |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Writes a collection of table rows into one or more tables. This method requires <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#createTable-java.lang.String-java.lang.Iterable-"><code>createTable(String, Iterable)</code></a> to be called for the target table |
| beforehand.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableRows</code> - A collection of mutation objects representing table rows.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if method is called after resources have been cleaned |
| up, if the manager object has no instance, if the table does not exist or if there is an |
| IOException when attempting to retrieve the bigtable data client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readTable-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readTable</h4> |
| <pre>public com.google.common.collect.ImmutableList<com.google.cloud.bigtable.data.v2.models.Row> readTable(java.lang.String tableId) |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Reads all the rows in a table. This method requires <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#createTable-java.lang.String-java.lang.Iterable-"><code>createTable(String, Iterable)</code></a> to be called for the target table |
| beforehand.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableId</code> - The id of table to read rows from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A List object containing all the rows in the table.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if method is called after resources have been cleaned |
| up, if the manager object has no instance, if the table does not exist or if there is an |
| IOException when attempting to retrieve the bigtable data client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readTable-java.lang.String-java.lang.Long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readTable</h4> |
| <pre>public com.google.common.collect.ImmutableList<com.google.cloud.bigtable.data.v2.models.Row> readTable(java.lang.String tableId, |
| <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.Long limit) |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Reads all the rows in a table. This method requires <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html#createTable-java.lang.String-java.lang.Iterable-"><code>createTable(String, Iterable)</code></a> to be called for the target table |
| beforehand.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableId</code> - The id of table to read rows from.</dd> |
| <dd><code>limit</code> - Limits the number of rows that can be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A List object containing all the rows in the table.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if method is called after resources have been cleaned |
| up, if the manager object has no instance, if the table does not exist or if there is an |
| IOException when attempting to retrieve the bigtable data client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClusterNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterNames</h4> |
| <pre>public java.util.List<java.lang.String> getClusterNames()</pre> |
| <div class="block">Get all the cluster names of the current instance.</div> |
| </li> |
| </ul> |
| <a name="cleanupAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cleanupAll</h4> |
| <pre>public void cleanupAll() |
| throws <a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></pre> |
| <div class="block">Deletes all created resources (instance and tables) and cleans up all Bigtable clients, making |
| the manager object unusable. |
| |
| <p>If this Resource Manager was configured to use a static instance, the instance will not be |
| cleaned up, but any created tables will be deleted.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>cleanupAll</code> in interface <code>org.apache.beam.it.common.ResourceManager</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManagerException.html" title="class in org.apache.beam.it.gcp.bigtable">BigtableResourceManagerException</a></code> - if there is an error deleting the instance or tables |
| in Bigtable.</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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/it/gcp/bigtable/BigtableResourceManager.Builder.html" title="class in org.apache.beam.it.gcp.bigtable"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/it/gcp/bigtable/BigtableResourceManager.html" target="_top">Frames</a></li> |
| <li><a href="BigtableResourceManager.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> |
