| <!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_131-google-v7) on Thu Apr 19 15:01:50 PDT 2018 --> |
| <title>ClusterOrBuilder (java API)</title> |
| <meta name="date" content="2018-04-19"> |
| <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="ClusterOrBuilder (java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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="../../../../../com/google/bigtable/admin/v2/ClusterName.Builder.html" title="class in com.google.bigtable.admin.v2"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../com/google/bigtable/admin/v2/ColumnFamily.html" title="class in com.google.bigtable.admin.v2"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?com/google/bigtable/admin/v2/ClusterOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="ClusterOrBuilder.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">com.google.bigtable.admin.v2</div> |
| <h2 title="Interface ClusterOrBuilder" class="title">Interface ClusterOrBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../com/google/bigtable/admin/v2/Cluster.html" title="class in com.google.bigtable.admin.v2">Cluster</a>, <a href="../../../../../com/google/bigtable/admin/v2/Cluster.Builder.html" title="class in com.google.bigtable.admin.v2">Cluster.Builder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ClusterOrBuilder</span> |
| extends <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></pre> |
| </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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/bigtable/admin/v2/StorageType.html" title="enum in com.google.bigtable.admin.v2">StorageType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/bigtable/admin/v2/ClusterOrBuilder.html#getDefaultStorageType--">getDefaultStorageType</a></span>()</code> |
| <div class="block"> |
| (`CreationOnly`) |
| The type of storage used by this cluster to serve its |
| parent instance's tables, unless explicitly overridden.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/bigtable/admin/v2/ClusterOrBuilder.html#getDefaultStorageTypeValue--">getDefaultStorageTypeValue</a></span>()</code> |
| <div class="block"> |
| (`CreationOnly`) |
| The type of storage used by this cluster to serve its |
| parent instance's tables, unless explicitly overridden.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/bigtable/admin/v2/ClusterOrBuilder.html#getLocation--">getLocation</a></span>()</code> |
| <div class="block"> |
| (`CreationOnly`) |
| The location where this cluster's nodes and storage reside.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/bigtable/admin/v2/ClusterOrBuilder.html#getLocationBytes--">getLocationBytes</a></span>()</code> |
| <div class="block"> |
| (`CreationOnly`) |
| The location where this cluster's nodes and storage reside.</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="../../../../../com/google/bigtable/admin/v2/ClusterOrBuilder.html#getName--">getName</a></span>()</code> |
| <div class="block"> |
| (`OutputOnly`) |
| The unique name of the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/bigtable/admin/v2/ClusterOrBuilder.html#getNameBytes--">getNameBytes</a></span>()</code> |
| <div class="block"> |
| (`OutputOnly`) |
| The unique name of the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/bigtable/admin/v2/ClusterOrBuilder.html#getServeNodes--">getServeNodes</a></span>()</code> |
| <div class="block"> |
| The number of nodes allocated to this cluster.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/bigtable/admin/v2/Cluster.State.html" title="enum in com.google.bigtable.admin.v2">Cluster.State</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/bigtable/admin/v2/ClusterOrBuilder.html#getState--">getState</a></span>()</code> |
| <div class="block"> |
| (`OutputOnly`) |
| The current state of the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/bigtable/admin/v2/ClusterOrBuilder.html#getStateValue--">getStateValue</a></span>()</code> |
| <div class="block"> |
| (`OutputOnly`) |
| The current state of the cluster.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#findInitializationErrors--" title="class or interface in com.google.protobuf">findInitializationErrors</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getAllFields--" title="class or interface in com.google.protobuf">getAllFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDefaultInstanceForType--" title="class or interface in com.google.protobuf">getDefaultInstanceForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDescriptorForType--" title="class or interface in com.google.protobuf">getDescriptorForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getInitializationErrorString--" title="class or interface in com.google.protobuf">getInitializationErrorString</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getOneofFieldDescriptor-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">getOneofFieldDescriptor</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedField-com.google.protobuf.Descriptors.FieldDescriptor-int-" title="class or interface in com.google.protobuf">getRepeatedField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedFieldCount-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getRepeatedFieldCount</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getUnknownFields--" title="class or interface in com.google.protobuf">getUnknownFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">hasField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasOneof-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">hasOneof</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true#isInitialized--" title="class or interface in com.google.protobuf">isInitialized</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>java.lang.String getName()</pre> |
| <div class="block"><pre> |
| (`OutputOnly`) |
| The unique name of the cluster. Values are of the form |
| `projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*`. |
| </pre> |
| |
| <code>string name = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getNameBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNameBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getNameBytes()</pre> |
| <div class="block"><pre> |
| (`OutputOnly`) |
| The unique name of the cluster. Values are of the form |
| `projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*`. |
| </pre> |
| |
| <code>string name = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocation</h4> |
| <pre>java.lang.String getLocation()</pre> |
| <div class="block"><pre> |
| (`CreationOnly`) |
| The location where this cluster's nodes and storage reside. For best |
| performance, clients should be located as close as possible to this |
| cluster. Currently only zones are supported, so values should be of the |
| form `projects/<project>/locations/<zone>`. |
| </pre> |
| |
| <code>string location = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getLocationBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocationBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getLocationBytes()</pre> |
| <div class="block"><pre> |
| (`CreationOnly`) |
| The location where this cluster's nodes and storage reside. For best |
| performance, clients should be located as close as possible to this |
| cluster. Currently only zones are supported, so values should be of the |
| form `projects/<project>/locations/<zone>`. |
| </pre> |
| |
| <code>string location = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getStateValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStateValue</h4> |
| <pre>int getStateValue()</pre> |
| <div class="block"><pre> |
| (`OutputOnly`) |
| The current state of the cluster. |
| </pre> |
| |
| <code>.google.bigtable.admin.v2.Cluster.State state = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre><a href="../../../../../com/google/bigtable/admin/v2/Cluster.State.html" title="enum in com.google.bigtable.admin.v2">Cluster.State</a> getState()</pre> |
| <div class="block"><pre> |
| (`OutputOnly`) |
| The current state of the cluster. |
| </pre> |
| |
| <code>.google.bigtable.admin.v2.Cluster.State state = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getServeNodes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServeNodes</h4> |
| <pre>int getServeNodes()</pre> |
| <div class="block"><pre> |
| The number of nodes allocated to this cluster. More nodes enable higher |
| throughput and more consistent performance. |
| </pre> |
| |
| <code>int32 serve_nodes = 4;</code></div> |
| </li> |
| </ul> |
| <a name="getDefaultStorageTypeValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultStorageTypeValue</h4> |
| <pre>int getDefaultStorageTypeValue()</pre> |
| <div class="block"><pre> |
| (`CreationOnly`) |
| The type of storage used by this cluster to serve its |
| parent instance's tables, unless explicitly overridden. |
| </pre> |
| |
| <code>.google.bigtable.admin.v2.StorageType default_storage_type = 5;</code></div> |
| </li> |
| </ul> |
| <a name="getDefaultStorageType--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDefaultStorageType</h4> |
| <pre><a href="../../../../../com/google/bigtable/admin/v2/StorageType.html" title="enum in com.google.bigtable.admin.v2">StorageType</a> getDefaultStorageType()</pre> |
| <div class="block"><pre> |
| (`CreationOnly`) |
| The type of storage used by this cluster to serve its |
| parent instance's tables, unless explicitly overridden. |
| </pre> |
| |
| <code>.google.bigtable.admin.v2.StorageType default_storage_type = 5;</code></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="../../../../../com/google/bigtable/admin/v2/ClusterName.Builder.html" title="class in com.google.bigtable.admin.v2"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../com/google/bigtable/admin/v2/ColumnFamily.html" title="class in com.google.bigtable.admin.v2"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?com/google/bigtable/admin/v2/ClusterOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="ClusterOrBuilder.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> |
