5555 * <p>Sample code to get started:
5656 *
5757 * <pre>{@code
58- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
58+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
5959 * CreateTable createTableReq =
6060 * TableAdminRequests.createTable("tableId")
6161 * .addFamily("cf1")
6969 * <p>Note: close() needs to be called on the client object to clean up resources such as threads.
7070 * In the example above, try-with-resources is used, which automatically calls close().
7171 *
72- * <p>This class can be customized by passing in a custom instance of TableAdminSettings to
72+ * <p>This class can be customized by passing in a custom instance of BigtableTableAdminSettings to
7373 * create(). For example:
7474 *
7575 * <p>To customize credentials:
7676 *
7777 * <pre>{@code
78- * TableAdminSettings tableAdminSettings = TableAdminSettings .newBuilder()
78+ * BigtableTableAdminSettings tableAdminSettings = BigtableTableAdminSettings .newBuilder()
7979 * .setInstanceName(InstanceName.of("[PROJECT]", "[INSTANCE]"))
8080 * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
8181 * .build();
8282 *
83- * TableAdminClient client =
84- * TableAdminClient .create(tableAdminSettings);
83+ * BigtableTableAdminClient client =
84+ * BigtableTableAdminClient .create(tableAdminSettings);
8585 * }</pre>
8686 *
8787 * To customize the endpoint:
8888 *
8989 * <pre>{@code
90- * TableAdminSettings tableAdminSettings = TableAdminSettings .newBuilder()
90+ * BigtableTableAdminSettings tableAdminSettings = BigtableTableAdminSettings .newBuilder()
9191 * .setInstanceName(InstanceName.of("[PROJECT]", "[INSTANCE]"))
9292 * .setEndpoint(myEndpoint).build();
9393 *
94- * TableAdminClient client = TableAdminClient .create(tableAdminSettings);
94+ * BigtableTableAdminClient client = BigtableTableAdminClient .create(tableAdminSettings);
9595 * }</pre>
9696 */
97- public class TableAdminClient implements AutoCloseable {
97+ public class BigtableTableAdminClient implements AutoCloseable {
9898 private final BigtableTableAdminStub stub ;
9999 private final InstanceName instanceName ;
100100
101- /** Constructs an instance of TableAdminClient with the given instanceName. */
102- public static TableAdminClient create (@ Nonnull InstanceName instanceName ) throws IOException {
103- return create (TableAdminSettings .newBuilder ().setInstanceName (instanceName ).build ());
101+ /** Constructs an instance of BigtableTableAdminClient with the given instanceName. */
102+ public static BigtableTableAdminClient create (@ Nonnull InstanceName instanceName ) throws IOException {
103+ return create (BigtableTableAdminSettings .newBuilder ().setInstanceName (instanceName ).build ());
104104 }
105105
106- /** Constructs an instance of TableAdminClient with the given settings. */
107- public static TableAdminClient create (@ Nonnull TableAdminSettings settings ) throws IOException {
106+ /** Constructs an instance of BigtableTableAdminClient with the given settings. */
107+ public static BigtableTableAdminClient create (@ Nonnull BigtableTableAdminSettings settings ) throws IOException {
108108 return create (settings .getInstanceName (), settings .getStubSettings ().createStub ());
109109 }
110110
111- /** Constructs an instance of TableAdminClient with the given instanceName and stub. */
112- public static TableAdminClient create (@ Nonnull InstanceName instanceName , @ Nonnull BigtableTableAdminStub stub ) {
113- return new TableAdminClient (instanceName , stub );
111+ /** Constructs an instance of BigtableTableAdminClient with the given instanceName and stub. */
112+ public static BigtableTableAdminClient create (@ Nonnull InstanceName instanceName , @ Nonnull BigtableTableAdminStub stub ) {
113+ return new BigtableTableAdminClient (instanceName , stub );
114114 }
115115
116- private TableAdminClient (@ Nonnull InstanceName instanceName , @ Nonnull BigtableTableAdminStub stub ) {
116+ private BigtableTableAdminClient (@ Nonnull InstanceName instanceName , @ Nonnull BigtableTableAdminStub stub ) {
117117 Preconditions .checkNotNull (instanceName );
118118 Preconditions .checkNotNull (stub );
119119 this .instanceName = instanceName ;
@@ -136,7 +136,7 @@ public void close() {
136136 * <p>Sample code:
137137 *
138138 * <pre>{@code
139- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
139+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
140140 * CreateTable createTableReq =
141141 * TableAdminRequests.createTable("tableId")
142142 * .addFamily("cf2", GCRULES.maxVersions(10))
@@ -160,7 +160,7 @@ public Table createTable(CreateTable createTable) {
160160 * <p>Sample code:
161161 *
162162 * <pre>{@code
163- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
163+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
164164 * CreateTable createTableReq =
165165 * TableAdminRequests.createTable("tableId")
166166 * .addFamily("cf2", GCRULES.maxVersions(10))
@@ -183,7 +183,7 @@ public ApiFuture<Table> createTableAsync(CreateTable createTable) {
183183 * <p>Sample code:
184184 *
185185 * <pre>{@code
186- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
186+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
187187 * ModifyFamilies modifyFamiliesReq = TableAdminRequests.modifyFamilies(tableId)
188188 * .addFamily("mf1")
189189 * .addFamily(
@@ -222,7 +222,7 @@ public Table modifyFamilies(ModifyFamilies modifyFamily) {
222222 * <p>Sample code:
223223 *
224224 * <pre>{@code
225- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
225+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
226226 * ModifyFamilies modifyFamiliesReq = TableAdminRequests.modifyFamilies(tableId)
227227 * .addFamily("mf1")
228228 * .addFamily(
@@ -259,7 +259,7 @@ public ApiFuture<Table> modifyFamiliesAsync(ModifyFamilies modifyFamily) {
259259 * <p>Sample code:
260260 *
261261 * <pre>{@code
262- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
262+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
263263 * client.deleteTable("tableId");
264264 * }
265265 * }</pre>
@@ -276,7 +276,7 @@ public void deleteTable(String tableId) {
276276 * <p>Sample code:
277277 *
278278 * <pre>{@code
279- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
279+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
280280 * client.deleteTableAsync("tableId");
281281 * }
282282 * }</pre>
@@ -294,7 +294,7 @@ public ApiFuture<Void> deleteTableAsync(String tableId) {
294294 * <p>Sample code:
295295 *
296296 * <pre>{@code
297- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
297+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
298298 * client.getTable("tableId");
299299 * }
300300 * }</pre>
@@ -313,7 +313,7 @@ public Table getTable(String tableId) {
313313 * <p>Sample code:
314314 *
315315 * <pre>{@code
316- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
316+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
317317 * client.getTableAsync("tableId");
318318 * }
319319 * }</pre>
@@ -331,7 +331,7 @@ public ApiFuture<Table> getTableAsync(String tableId) {
331331 * <p>Sample code:
332332 *
333333 * <pre>{@code
334- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
334+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
335335 * client.listTables();
336336 * }
337337 * }</pre>
@@ -347,7 +347,7 @@ public List<TableName> listTables() {
347347 * <p>Sample code:
348348 *
349349 * <pre>{@code
350- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
350+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
351351 * client.listTablesAsync();
352352 * }
353353 * }</pre>
@@ -372,7 +372,7 @@ public List<TableName> apply(ListTablesResponse input) {
372372 * <p>Sample code:
373373 *
374374 * <pre>{@code
375- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
375+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
376376 * client.dropRowRange("tableId");
377377 * }
378378 * }</pre>
@@ -390,7 +390,7 @@ public void dropRowRange(String tableId, String rowKeyPrefix) {
390390 * <p>Sample code:
391391 *
392392 * <pre>{@code
393- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
393+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
394394 * client.dropRowRangeAsync("tableId");
395395 * }
396396 * }</pre>
@@ -408,7 +408,7 @@ public ApiFuture<Void> dropRowRangeAsync(String tableId, String rowKeyPrefix) {
408408 * <p>Sample code:
409409 *
410410 * <pre>{@code
411- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
411+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
412412 * client.dropRowRange("tableId");
413413 * }
414414 * }</pre>
@@ -426,7 +426,7 @@ public void dropRowRange(String tableId, ByteString rowKeyPrefix) {
426426 * <p>Sample code:
427427 *
428428 * <pre>{@code
429- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
429+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
430430 * client.dropRowRangeAsync("tableId");
431431 * }
432432 * }</pre>
@@ -447,7 +447,7 @@ public ApiFuture<Void> dropRowRangeAsync(String tableId, ByteString rowKeyPrefix
447447 * <p>Sample code:
448448 *
449449 * <pre>{@code
450- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
450+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
451451 * client.dropAllRows("tableId");
452452 * }
453453 * }</pre>
@@ -464,7 +464,7 @@ public void dropAllRows(String tableId) {
464464 * <p>Sample code:
465465 *
466466 * <pre>{@code
467- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
467+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
468468 * client.dropAllRowsAsync("tableId");
469469 * }
470470 * }</pre>
@@ -485,7 +485,7 @@ public ApiFuture<Void> dropAllRowsAsync(String tableId) {
485485 * <p>Sample code:
486486 *
487487 * <pre>{@code
488- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
488+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
489489 * ConsistencyToken consistencyToken = client.generateConsistencyToken("tableId");
490490 * }
491491 * }</pre>
@@ -506,7 +506,7 @@ public ConsistencyToken generateConsistencyToken(String tableId) {
506506 * <p>Sample code:
507507 *
508508 * <pre>{@code
509- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
509+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
510510 * ConsistencyToken consistencyToken = client.generateConsistencyToken("tableId");
511511 * }
512512 * }</pre>
@@ -535,7 +535,7 @@ public ConsistencyToken apply(GenerateConsistencyTokenResponse input) {
535535 * <p>Sample code:
536536 *
537537 * <pre>{@code
538- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
538+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
539539 * boolean consistent = client.isConsistent("tableId", token);
540540 * }
541541 * }</pre>
@@ -555,7 +555,7 @@ public boolean isConsistent(String tableId, ConsistencyToken token) {
555555 * <p>Sample code:
556556 *
557557 * <pre>{@code
558- * try(TableAdminClient client = TableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
558+ * try(BigtableTableAdminClient client = BigtableTableAdminClient .create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
559559 * boolean consistent = client.isConsistentAsync("tableId", token);
560560 * }
561561 * }</pre>
0 commit comments