Skip to content

Commit

Permalink
update handwritten layer
Browse files Browse the repository at this point in the history
  • Loading branch information
igorbernstein2 committed Aug 8, 2018
1 parent 8d4b96a commit 1d28d24
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 60 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
* <p>Sample code to get started:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* CreateTable createTableReq =
* TableAdminRequests.createTable("tableId")
* .addFamily("cf1")
Expand All @@ -69,51 +69,51 @@
* <p>Note: close() needs to be called on the client object to clean up resources such as threads.
* In the example above, try-with-resources is used, which automatically calls close().
*
* <p>This class can be customized by passing in a custom instance of TableAdminSettings to
* <p>This class can be customized by passing in a custom instance of BigtableTableAdminSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* TableAdminSettings tableAdminSettings = TableAdminSettings.newBuilder()
* BigtableTableAdminSettings tableAdminSettings = BigtableTableAdminSettings.newBuilder()
* .setInstanceName(InstanceName.of("[PROJECT]", "[INSTANCE]"))
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
*
* TableAdminClient client =
* TableAdminClient.create(tableAdminSettings);
* BigtableTableAdminClient client =
* BigtableTableAdminClient.create(tableAdminSettings);
* }</pre>
*
* To customize the endpoint:
*
* <pre>{@code
* TableAdminSettings tableAdminSettings = TableAdminSettings.newBuilder()
* BigtableTableAdminSettings tableAdminSettings = BigtableTableAdminSettings.newBuilder()
* .setInstanceName(InstanceName.of("[PROJECT]", "[INSTANCE]"))
* .setEndpoint(myEndpoint).build();
*
* TableAdminClient client = TableAdminClient.create(tableAdminSettings);
* BigtableTableAdminClient client = BigtableTableAdminClient.create(tableAdminSettings);
* }</pre>
*/
public class TableAdminClient implements AutoCloseable {
public class BigtableTableAdminClient implements AutoCloseable {
private final BigtableTableAdminStub stub;
private final InstanceName instanceName;

/** Constructs an instance of TableAdminClient with the given instanceName. */
public static TableAdminClient create(@Nonnull InstanceName instanceName) throws IOException {
return create(TableAdminSettings.newBuilder().setInstanceName(instanceName).build());
/** Constructs an instance of BigtableTableAdminClient with the given instanceName. */
public static BigtableTableAdminClient create(@Nonnull InstanceName instanceName) throws IOException {
return create(BigtableTableAdminSettings.newBuilder().setInstanceName(instanceName).build());
}

/** Constructs an instance of TableAdminClient with the given settings. */
public static TableAdminClient create(@Nonnull TableAdminSettings settings) throws IOException {
/** Constructs an instance of BigtableTableAdminClient with the given settings. */
public static BigtableTableAdminClient create(@Nonnull BigtableTableAdminSettings settings) throws IOException {
return create(settings.getInstanceName(), settings.getStubSettings().createStub());
}

/** Constructs an instance of TableAdminClient with the given instanceName and stub. */
public static TableAdminClient create(@Nonnull InstanceName instanceName, @Nonnull BigtableTableAdminStub stub) {
return new TableAdminClient(instanceName, stub);
/** Constructs an instance of BigtableTableAdminClient with the given instanceName and stub. */
public static BigtableTableAdminClient create(@Nonnull InstanceName instanceName, @Nonnull BigtableTableAdminStub stub) {
return new BigtableTableAdminClient(instanceName, stub);
}

private TableAdminClient(@Nonnull InstanceName instanceName, @Nonnull BigtableTableAdminStub stub) {
private BigtableTableAdminClient(@Nonnull InstanceName instanceName, @Nonnull BigtableTableAdminStub stub) {
Preconditions.checkNotNull(instanceName);
Preconditions.checkNotNull(stub);
this.instanceName = instanceName;
Expand All @@ -136,7 +136,7 @@ public void close() {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* CreateTable createTableReq =
* TableAdminRequests.createTable("tableId")
* .addFamily("cf2", GCRULES.maxVersions(10))
Expand All @@ -160,7 +160,7 @@ public Table createTable(CreateTable createTable) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* CreateTable createTableReq =
* TableAdminRequests.createTable("tableId")
* .addFamily("cf2", GCRULES.maxVersions(10))
Expand All @@ -183,7 +183,7 @@ public ApiFuture<Table> createTableAsync(CreateTable createTable) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* ModifyFamilies modifyFamiliesReq = TableAdminRequests.modifyFamilies(tableId)
* .addFamily("mf1")
* .addFamily(
Expand Down Expand Up @@ -222,7 +222,7 @@ public Table modifyFamilies(ModifyFamilies modifyFamily) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* ModifyFamilies modifyFamiliesReq = TableAdminRequests.modifyFamilies(tableId)
* .addFamily("mf1")
* .addFamily(
Expand Down Expand Up @@ -259,7 +259,7 @@ public ApiFuture<Table> modifyFamiliesAsync(ModifyFamilies modifyFamily) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.deleteTable("tableId");
* }
* }</pre>
Expand All @@ -276,7 +276,7 @@ public void deleteTable(String tableId) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.deleteTableAsync("tableId");
* }
* }</pre>
Expand All @@ -294,7 +294,7 @@ public ApiFuture<Void> deleteTableAsync(String tableId) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.getTable("tableId");
* }
* }</pre>
Expand All @@ -313,7 +313,7 @@ public Table getTable(String tableId) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.getTableAsync("tableId");
* }
* }</pre>
Expand All @@ -331,7 +331,7 @@ public ApiFuture<Table> getTableAsync(String tableId) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.listTables();
* }
* }</pre>
Expand All @@ -347,7 +347,7 @@ public List<TableName> listTables() {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.listTablesAsync();
* }
* }</pre>
Expand All @@ -372,7 +372,7 @@ public List<TableName> apply(ListTablesResponse input) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.dropRowRange("tableId");
* }
* }</pre>
Expand All @@ -390,7 +390,7 @@ public void dropRowRange(String tableId, String rowKeyPrefix) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.dropRowRangeAsync("tableId");
* }
* }</pre>
Expand All @@ -408,7 +408,7 @@ public ApiFuture<Void> dropRowRangeAsync(String tableId, String rowKeyPrefix) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.dropRowRange("tableId");
* }
* }</pre>
Expand All @@ -426,7 +426,7 @@ public void dropRowRange(String tableId, ByteString rowKeyPrefix) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.dropRowRangeAsync("tableId");
* }
* }</pre>
Expand All @@ -447,7 +447,7 @@ public ApiFuture<Void> dropRowRangeAsync(String tableId, ByteString rowKeyPrefix
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.dropAllRows("tableId");
* }
* }</pre>
Expand All @@ -464,7 +464,7 @@ public void dropAllRows(String tableId) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* client.dropAllRowsAsync("tableId");
* }
* }</pre>
Expand All @@ -485,7 +485,7 @@ public ApiFuture<Void> dropAllRowsAsync(String tableId) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* ConsistencyToken consistencyToken = client.generateConsistencyToken("tableId");
* }
* }</pre>
Expand All @@ -506,7 +506,7 @@ public ConsistencyToken generateConsistencyToken(String tableId) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* ConsistencyToken consistencyToken = client.generateConsistencyToken("tableId");
* }
* }</pre>
Expand Down Expand Up @@ -535,7 +535,7 @@ public ConsistencyToken apply(GenerateConsistencyTokenResponse input) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* boolean consistent = client.isConsistent("tableId", token);
* }
* }</pre>
Expand All @@ -555,7 +555,7 @@ public boolean isConsistent(String tableId, ConsistencyToken token) {
* <p>Sample code:
*
* <pre>{@code
* try(TableAdminClient client = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* try(BigtableTableAdminClient client = BigtableTableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"))) {
* boolean consistent = client.isConsistentAsync("tableId", token);
* }
* }</pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@
import javax.annotation.Nullable;

/**
* Settings class to configure an instance of {@link TableAdminClient}.
* Settings class to configure an instance of {@link BigtableTableAdminClient}.
*
* <p>It must be configured with an {@link InstanceName} and be used to change default RPC settings.
*
* <p>Example usage:
*
* <pre>{@code
* TableAdminSettings.Builder tableAdminSettingsBuilder = TableAdminSettings.newBuilder()
* BigtableTableAdminSettings.Builder tableAdminSettingsBuilder = BigtableTableAdminSettings.newBuilder()
* .setInstanceName(InstanceName.of("my-project", "my-instance");
*
* tableAdminSettingsBuilder.stubSettings().createTableSettings()
Expand All @@ -43,11 +43,11 @@
* BigtableTableAdminSettings tableAdminSettings = tableAdminSettingsBuilder.build();
* }</pre>
*/
public final class TableAdminSettings {
public final class BigtableTableAdminSettings {
private final InstanceName instanceName;
private final BigtableTableAdminStubSettings stubSettings;

private TableAdminSettings(Builder builder) throws IOException {
private BigtableTableAdminSettings(Builder builder) throws IOException {
this.instanceName = Preconditions.checkNotNull(builder.instanceName, "InstanceName must be set");
this.stubSettings = Verify.verifyNotNull(builder.stubSettings, "stubSettings should never be null").build();
}
Expand All @@ -73,7 +73,7 @@ public static Builder newBuilder() {
return new Builder();
}

/** Builder for TableAdminSettings. */
/** Builder for BigtableTableAdminSettings. */
public static final class Builder {
@Nullable
private InstanceName instanceName;
Expand All @@ -83,7 +83,7 @@ private Builder() {
stubSettings = BigtableTableAdminStubSettings.newBuilder();
}

private Builder(TableAdminSettings settings) {
private Builder(BigtableTableAdminSettings settings) {
this.instanceName = settings.instanceName;
this.stubSettings = settings.stubSettings.toBuilder();
}
Expand Down Expand Up @@ -112,8 +112,8 @@ public BigtableTableAdminStubSettings.Builder stubSettings() {
}

/** Builds an instance of the settings. */
public TableAdminSettings build() throws IOException {
return new TableAdminSettings(this);
public BigtableTableAdminSettings build() throws IOException {
return new BigtableTableAdminSettings(this);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse;
import com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState;
import com.google.bigtable.admin.v2.TableName;
import com.google.cloud.bigtable.admin.v2.TableAdminClient;
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClient;
import com.google.cloud.bigtable.admin.v2.models.GCRules.GCRule;
import com.google.cloud.bigtable.admin.v2.models.GCRules.IntersectionRule;
import com.google.cloud.bigtable.admin.v2.models.GCRules.UnionRule;
Expand Down Expand Up @@ -269,7 +269,7 @@ private GCRule convertGcRule(GcRule source) {
* Wrapper for {@link GenerateConsistencyTokenResponse#getConsistencyToken()}
*
* <p>Cannot be created. They are obtained by invoking {@link
* TableAdminClient#generateConsistencyToken(String)}
* BigtableTableAdminClient#generateConsistencyToken(String)}
*/
public static final class ConsistencyToken {
private final String token;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@
import com.google.protobuf.Empty;

@RunWith(MockitoJUnitRunner.class)
public class TableAdminClientTest {
private TableAdminClient adminClient;
public class BigtableTableAdminClientTest {
private BigtableTableAdminClient adminClient;
@Mock private BigtableTableAdminStub mockStub;

@Mock private UnaryCallable<CreateTableRequest, Table> mockCreateTableCallable;
Expand All @@ -73,7 +73,8 @@ public class TableAdminClientTest {

@Before
public void setUp() throws Exception {
adminClient = TableAdminClient.create(InstanceName.of("[PROJECT]", "[INSTANCE]"), mockStub);
adminClient = BigtableTableAdminClient
.create(InstanceName.of("[PROJECT]", "[INSTANCE]"), mockStub);

Mockito.when(mockStub.createTableCallable()).thenReturn(mockCreateTableCallable);
Mockito.when(mockStub.modifyColumnFamiliesCallable()).thenReturn(mockModifyTableCallable);
Expand Down Expand Up @@ -293,12 +294,12 @@ public void convertToTableNames() {
.addTables(Table.newBuilder().setName("projects/p/instances/i/tables/t2"))
.build();

List<TableName> tableNames = TableAdminClient.convertToTableNames(listTablesResponse);
List<TableName> tableNames = BigtableTableAdminClient.convertToTableNames(listTablesResponse);
assertEquals(2, tableNames.size());
assertEquals("projects/p/instances/i/tables/t1", tableNames.get(0).toString());
assertEquals("projects/p/instances/i/tables/t2", tableNames.get(1).toString());

listTablesResponse = ListTablesResponse.newBuilder().build();
assertEquals(0, TableAdminClient.convertToTableNames(listTablesResponse).size());
assertEquals(0, BigtableTableAdminClient.convertToTableNames(listTablesResponse).size());
}
}
Loading

0 comments on commit 1d28d24

Please sign in to comment.