Skip to content

Commit

Permalink
bigtable: updated_documentation (#3833)
Browse files Browse the repository at this point in the history
  • Loading branch information
@elisheva-qlogic @igorbernstein2
elisheva-qlogic authored and igorbernstein2 committed Oct 23, 2018
1 parent aa9bec5 commit 64c0ee6
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 44 deletions.
12 changes: 6 additions & 6 deletions ...e-admin/src/main/java/com/google/cloud/bigtable/admin/v2/BigtableInstanceAdminClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ public void deleteInstance(String instanceId) {
* <p>Sample code:
*
* <pre>{@code
* ApiFuture<Void> deleteFuture = client.deleteInstance("my-instance");
* ApiFuture<Void> deleteFuture = client.deleteInstanceAsync("my-instance");
* deleteFuture.get();
* }</pre>
*/
Expand Down Expand Up @@ -522,7 +522,7 @@ public Cluster apply(com.google.bigtable.admin.v2.Cluster proto) {
*
* <pre>{@code
* try {
* List<Cluster> clusters = cluster.listClusters("my-instance");
* List<Cluster> clusters = client.listClusters("my-instance");
* } catch (PartialListClustersException e) {
* System.out.println("The following zones are unavailable: " + e.getUnavailableZones());
* System.out.println("But the following clusters are reachable: " + e.getClusters())
Expand Down Expand Up @@ -610,7 +610,7 @@ public List<Cluster> apply(com.google.bigtable.admin.v2.ListClustersResponse pro
* <p>Sample code:
*
* <pre>{@code
* Cluster cluster = cluster.resizeCluster("my-instance", "my-cluster", 30);
* Cluster cluster = client.resizeCluster("my-instance", "my-cluster", 30);
* }</pre>
*/
@SuppressWarnings("WeakerAccess")
Expand All @@ -623,7 +623,7 @@ public Cluster resizeCluster(String instanceId, String clusterId, int numServeNo
* a PRODUCTION instance can be resized.
*
* <pre>{@code
* ApiFuture<Cluster> clusterFuture = cluster.resizeCluster("my-instance", "my-cluster", 30);
* ApiFuture<Cluster> clusterFuture = client.resizeCluster("my-instance", "my-cluster", 30);
* Cluster cluster = clusterFuture.get();
* }</pre>
*/
Expand Down Expand Up @@ -1165,7 +1165,7 @@ public List<String> testIamPermission(String instanceId, String... permissions)
* <p>Sample code:
*
* <pre>{@code
* ApiFuture<List<String>> grantedPermissionsFuture = client.testIamPermission("my-instance",
* ApiFuture<List<String>> grantedPermissionsFuture = client.testIamPermissionAsync("my-instance",
* "bigtable.tables.readRows", "bigtable.tables.mutateRows");
*
* ApiFutures.addCallback(grantedPermissionsFuture,
Expand Down Expand Up @@ -1222,7 +1222,7 @@ public List<String> testIamPermission(ResourceName resourceName, String... permi
* <p>Sample code:
*
* <pre>{@code
* ApiFuture<List<String>> grantedPermissionsFuture = client.testIamPermission(
* ApiFuture<List<String>> grantedPermissionsFuture = client.testIamPermissionAsync(
* TableName.of("my-project", "my-instance", "my-table"),
* "bigtable.tables.readRows", "bigtable.tables.mutateRows");
*
Expand Down
2 changes: 1 addition & 1 deletion ...able-admin/src/main/java/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ public List<TableName> listTables() {
* <p>Sample code:
*
* <pre>{@code
* ApiFuture<List<TableName>> listFuture = client.listTables();
* ApiFuture<List<TableName>> listFuture = client.listTablesAsync();
*
* ApiFutures.addCallback(
* listFuture,
Expand Down
74 changes: 37 additions & 37 deletions ...le-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/BigtableDataClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public class BigtableDataClient implements AutoCloseable {
private final EnhancedBigtableStub stub;

/**
* Constructs an instance of BigtableClient with default settings.
* Constructs an instance of BigtableDataClient with default settings.
*
* @param instanceName The instance to connect to.
* @return A new client.
Expand Down Expand Up @@ -136,10 +136,10 @@ public static BigtableDataClient create(BigtableDataSettings settings) throws IO
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* String tableId = "[TABLE]";
*
* ApiFuture<Row> result = bigtableClient.readRow(tableId, "key");
* ApiFuture<Row> result = bigtableDataClient.readRowAsync(tableId, "key");
* }
* }</pre>
*/
Expand All @@ -155,10 +155,10 @@ public ApiFuture<Row> readRowAsync(String tableId, String rowKey) {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* String tableId = "[TABLE]";
*
* ApiFuture<Row> result = bigtableClient.readRow(tableId, ByteString.copyFromUtf8("key"));
* ApiFuture<Row> result = bigtableDataClient.readRowAsync(tableId, ByteString.copyFromUtf8("key"));
* }
* }</pre>
*/
Expand All @@ -176,15 +176,15 @@ public ApiFuture<Row> readRowAsync(String tableId, ByteString rowKey) {
* import static com.google.cloud.bigtable.data.v2.models.Filters.FILTERS;
*
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* String tableId = "[TABLE]";
*
* Query query = Query.create(tableId)
* .range("[START KEY]", "[END KEY]")
* .filter(FILTERS.qualifier().regex("[COLUMN PREFIX].*"));
*
* // Iterator style
* for(Row row : bigtableClient.readRows(query)) {
* for(Row row : bigtableDataClient.readRows(query)) {
* // Do something with row
* }
* }
Expand All @@ -205,14 +205,14 @@ public ServerStream<Row> readRows(Query query) {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* String tableId = "[TABLE]";
*
* Query query = Query.create(tableId)
* .range("[START KEY]", "[END KEY]")
* .filter(FILTERS.qualifier().regex("[COLUMN PREFIX].*"));
*
* client.readRowsAsync(query, new ResponseObserver<Row>() {
* bigtableDataClient.readRowsAsync(query, new ResponseObserver<Row>() {
* public void onStart(StreamController controller) { }
* public void onResponse(Row response) {
* // Do something with Row
Expand All @@ -239,20 +239,20 @@ public void readRowsAsync(Query query, ResponseObserver<Row> observer) {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* String tableId = "[TABLE]";
*
* Query query = Query.create(tableId)
* .range("[START KEY]", "[END KEY]")
* .filter(FILTERS.qualifier().regex("[COLUMN PREFIX].*"));
*
* // Iterator style
* for(Row row : bigtableClient.readRowsCallable().call(query)) {
* for(Row row : bigtableDataClient.readRowsCallable().call(query)) {
* // Do something with row
* }
*
* // Point look up
* ApiFuture<Row> rowFuture = bigtableClient.readRowsCallable().first().futureCall(query);
* ApiFuture<Row> rowFuture = bigtableDataClient.readRowsCallable().first().futureCall(query);
*
* // etc
* }
Expand All @@ -274,15 +274,15 @@ public ServerStreamingCallable<Query, Row> readRowsCallable() {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* String tableId = "[TABLE]";
*
* Query query = Query.create(tableId)
* .range("[START KEY]", "[END KEY]")
* .filter(FILTERS.qualifier().regex("[COLUMN PREFIX].*"));
*
* // Iterator style
* for(CustomRow row : bigtableClient.readRowsCallable(new CustomRowAdapter()).call(query)) {
* for(CustomRow row : bigtableDataClient.readRowsCallable(new CustomRowAdapter()).call(query)) {
* // Do something with row
* }
* }
Expand All @@ -305,8 +305,8 @@ public <RowT> ServerStreamingCallable<Query, RowT> readRowsCallable(RowAdapter<R
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* ApiFuture<List<KeyOffset>> keyOffsets = bigtableClient.sampleRowKeysAsync("[TABLE]");
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* ApiFuture<List<KeyOffset>> keyOffsets = bigtableDataClient.sampleRowKeysAsync("[TABLE]");
* }
* }</pre>
*/
Expand All @@ -324,12 +324,12 @@ public ApiFuture<List<KeyOffset>> sampleRowKeysAsync(String tableId) {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* // Synchronous invocation
* List<KeyOffset> keyOffsets = bigtableClient.sampleRowKeysCallable().call("[TABLE]");
* List<KeyOffset> keyOffsets = bigtableDataClient.sampleRowKeysCallable().call("[TABLE]");
*
* // Asynchronous invocation
* ApiFuture<List<KeyOffset>> keyOffsets = bigtableClient.sampleRowKeysCallable().futureCall("[TABLE]");
* ApiFuture<List<KeyOffset>> keyOffsets = bigtableDataClient.sampleRowKeysCallable().futureCall("[TABLE]");
* }
* }</pre>
*/
Expand All @@ -345,11 +345,11 @@ public UnaryCallable<String, List<KeyOffset>> sampleRowKeysCallable() {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* RowMutation mutation = RowMutation.create("[TABLE]", "[ROW KEY]")
* .setCell("[FAMILY NAME]", "[QUALIFIER]", "[VALUE]");
*
* ApitFuture<Void> future = bigtableClient.mutateRowAsync(mutation);
* ApitFuture<Void> future = bigtableDataClient.mutateRowAsync(mutation);
* }
* }</pre>
*/
Expand All @@ -365,11 +365,11 @@ public ApiFuture<Void> mutateRowAsync(RowMutation rowMutation) {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* RowMutation mutation = RowMutation.create("[TABLE]", "[ROW KEY]")
* .setCell("[FAMILY NAME]", "[QUALIFIER]", "[VALUE]");
*
* bigtableClient.mutateRowCallable().call(mutation);
* bigtableDataClient.mutateRowCallable().call(mutation);
* }
* }</pre>
*/
Expand All @@ -385,8 +385,8 @@ public UnaryCallable<RowMutation, Void> mutateRowCallable() {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BulkMutationBatcher batcher = bigtableClient.newBulkMutationBatcher()) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* try (BulkMutationBatcher batcher = bigtableDataClient.newBulkMutationBatcher()) {
* for (String someValue : someCollection) {
* RowMutation mutation = RowMutation.create("[TABLE]", "[ROW KEY]")
* .setCell("[FAMILY NAME]", "[QUALIFIER]", "[VALUE]");
Expand Down Expand Up @@ -414,12 +414,12 @@ public BulkMutationBatcher newBulkMutationBatcher() {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* BulkMutation batch = BulkMutation.create("[TABLE]");
* for (String someValue : someCollection) {
* batch.add("[ROW KEY]", Mutation.create().setCell("[FAMILY NAME]", "[QUALIFIER]", "[VALUE]");
* }
* ApiFuture<Void> result = bigtableClient.bulkMutateRowsAsync(batch);
* ApiFuture<Void> result = bigtableDataClient.bulkMutateRowsAsync(batch);
* }
* }</pre>
*/
Expand All @@ -436,12 +436,12 @@ public ApiFuture<Void> bulkMutateRowsAsync(BulkMutation mutation) {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* BulkMutation batch = BulkMutation.create("[TABLE]");
* for (String someValue : someCollection) {
* batch.add("[ROW KEY]", Mutation.create().setCell("[FAMILY NAME]", "[QUALIFIER]", "[VALUE]");
* }
* bigtableClient.bulkMutateRowsCallable().call(batch);
* bigtableDataClient.bulkMutationCallable().call(batch);
* }
* }</pre>
*/
Expand All @@ -456,15 +456,15 @@ public UnaryCallable<BulkMutation, Void> bulkMutationCallable() {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* ConditionalRowMutation mutation = ConditionalRowMutation.create("[TABLE]", "[KEY]")
* .condition(FILTERS.value().regex("old-value"))
* .then(
* Mutation.create()
* .setCell("[FAMILY]", "[QUALIFIER]", "[VALUE]")
* );
*
* ApiFuture<Boolean> future = bigtableClient.checkAndMutateRowAsync(mutation);
* ApiFuture<Boolean> future = bigtableDataClient.checkAndMutateRowAsync(mutation);
* }
* }</pre>
*/
Expand All @@ -479,15 +479,15 @@ public ApiFuture<Boolean> checkAndMutateRowAsync(ConditionalRowMutation mutation
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* ConditionalRowMutation mutation = ConditionalRowMutation.create("[TABLE]", "[KEY]")
* .condition(FILTERS.value().regex("old-value"))
* .then(
* Mutation.create()
* .setCell("[FAMILY]", "[QUALIFIER]", "[VALUE]")
* );
*
* boolean success = bigtableClient.checkAndMutateRowCallable().call(mutation);
* boolean success = bigtableDataClient.checkAndMutateRowCallable().call(mutation);
* }
* }</pre>
*/
Expand All @@ -505,12 +505,12 @@ public UnaryCallable<ConditionalRowMutation, Boolean> checkAndMutateRowCallable(
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* ReadModifyWriteRow mutation = ReadModifyWriteRow.create("[TABLE]", "[KEY]")
* .increment("[FAMILY]", "[QUALIFIER]", 1)
* .append("[FAMILY2]", "[QUALIFIER2]", "suffix");
*
* ApiFuture<Row> success = bigtableClient.readModifyWriteRowAsync(mutation);
* ApiFuture<Row> success = bigtableDataClient.readModifyWriteRowAsync(mutation);
* }
* }</pre>
*/
Expand All @@ -528,12 +528,12 @@ public ApiFuture<Row> readModifyWriteRowAsync(ReadModifyWriteRow mutation) {
*
* <pre>{@code
* InstanceName instanceName = InstanceName.of("[PROJECT]", "[INSTANCE]");
* try (BigtableClient bigtableClient = BigtableClient.create(instanceName)) {
* try (BigtableDataClient bigtableDataClient = BigtableDataClient.create(instanceName)) {
* ReadModifyWriteRow mutation = ReadModifyWriteRow.create("[TABLE]", "[KEY]")
* .increment("[FAMILY]", "[QUALIFIER]", 1)
* .append("[FAMILY2]", "[QUALIFIER2]", "suffix");
*
* Row row = bigtableClient.readModifyWriteRowCallable().call(mutation);
* Row row = bigtableDataClient.readModifyWriteRowCallable().call(mutation);
* }
* }</pre>
*/
Expand Down

0 comments on commit 64c0ee6

Please sign in to comment.