com.google.cloud.bigtable.v2

Class BigtableClient

java.lang.Object

com.google.cloud.bigtable.v2.BigtableClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by GAPIC v0.0.5")
 @BetaApi
public class BigtableClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for reading from and writing to existing Bigtable tables.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   List<Mutation> mutations = new ArrayList<>();
   MutateRowResponse response = bigtableClient.mutateRow(tableName, rowKey, mutations);
 }
 
 

Note: close() needs to be called on the bigtableClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of BigtableSettings to create(). For example:

To customize credentials:

 
 BigtableSettings bigtableSettings =
     BigtableSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BigtableClient bigtableClient =
     BigtableClient.create(bigtableSettings);
 
 

To customize the endpoint:

 
 BigtableSettings bigtableSettings =
     BigtableSettings.newBuilder().setEndpoint(myEndpoint).build();
 BigtableClient bigtableClient =
     BigtableClient.create(bigtableSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BigtableClient(BigtableSettings settings) Constructs an instance of BigtableClient, using the given settings.
protected	BigtableClient(BigtableStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
com.google.bigtable.v2.CheckAndMutateRowResponse	checkAndMutateRow(com.google.bigtable.v2.CheckAndMutateRowRequest request) Mutates a row atomically based on the output of a predicate Reader filter.
com.google.bigtable.v2.CheckAndMutateRowResponse	checkAndMutateRow(com.google.bigtable.v2.TableName tableName, com.google.protobuf.ByteString rowKey, com.google.bigtable.v2.RowFilter predicateFilter, List<com.google.bigtable.v2.Mutation> trueMutations, List<com.google.bigtable.v2.Mutation> falseMutations) Mutates a row atomically based on the output of a predicate Reader filter.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.v2.CheckAndMutateRowRequest,com.google.bigtable.v2.CheckAndMutateRowResponse>	checkAndMutateRowCallable() Mutates a row atomically based on the output of a predicate Reader filter.
void	close()
static BigtableClient	create() Constructs an instance of BigtableClient with default settings.
static BigtableClient	create(BigtableSettings settings) Constructs an instance of BigtableClient, using the given settings.
static BigtableClient	create(BigtableStub stub) Constructs an instance of BigtableClient, using the given stub for making calls.
BigtableSettings	getSettings()
BigtableStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
com.google.bigtable.v2.MutateRowResponse	mutateRow(com.google.bigtable.v2.MutateRowRequest request) Mutates a row atomically.
com.google.bigtable.v2.MutateRowResponse	mutateRow(com.google.bigtable.v2.TableName tableName, com.google.protobuf.ByteString rowKey, List<com.google.bigtable.v2.Mutation> mutations) Mutates a row atomically.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.v2.MutateRowRequest,com.google.bigtable.v2.MutateRowResponse>	mutateRowCallable() Mutates a row atomically.
com.google.api.gax.rpc.ServerStreamingCallable<com.google.bigtable.v2.MutateRowsRequest,com.google.bigtable.v2.MutateRowsResponse>	mutateRowsCallable() Mutates multiple rows in a batch.
com.google.bigtable.v2.ReadModifyWriteRowResponse	readModifyWriteRow(com.google.bigtable.v2.ReadModifyWriteRowRequest request) Modifies a row atomically.
com.google.bigtable.v2.ReadModifyWriteRowResponse	readModifyWriteRow(com.google.bigtable.v2.TableName tableName, com.google.protobuf.ByteString rowKey, List<com.google.bigtable.v2.ReadModifyWriteRule> rules) Modifies a row atomically.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.v2.ReadModifyWriteRowRequest,com.google.bigtable.v2.ReadModifyWriteRowResponse>	readModifyWriteRowCallable() Modifies a row atomically.
com.google.api.gax.rpc.ServerStreamingCallable<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse>	readRowsCallable() Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each.
com.google.api.gax.rpc.ServerStreamingCallable<com.google.bigtable.v2.SampleRowKeysRequest,com.google.bigtable.v2.SampleRowKeysResponse>	sampleRowKeysCallable() Returns a sample of row keys in the table.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BigtableClient

protected BigtableClient(BigtableSettings settings)
                  throws IOException

Constructs an instance of BigtableClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

BigtableClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected BigtableClient(BigtableStub stub)

Method Detail

create

public static final BigtableClient create()
                                   throws IOException

Constructs an instance of BigtableClient with default settings.

Throws:

IOException

create

public static final BigtableClient create(BigtableSettings settings)
                                   throws IOException

Constructs an instance of BigtableClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final BigtableClient create(BigtableStub stub)

Constructs an instance of BigtableClient, using the given stub for making calls. This is for advanced usage - prefer to use BigtableSettings}.

getSettings

public final BigtableSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public BigtableStub getStub()

readRowsCallable

public final com.google.api.gax.rpc.ServerStreamingCallable<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse> readRowsCallable()

Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each. Depending on their size, rows and cells may be broken up across multiple responses, but atomicity of each row will still be preserved. See the ReadRowsResponse documentation for details.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   ApiStreamObserver<ReadRowsResponse> responseObserver =
       new ApiStreamObserver<ReadRowsResponse>() {
          @Override
         public void onNext(ReadRowsResponse response) {
           // Do something when receive a response
         }

          @Override
         public void onError(Throwable t) {
           // Add error-handling
         }

          @Override
         public void onCompleted() {
           // Do something when complete.
         }
       };

   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ReadRowsRequest request = ReadRowsRequest.newBuilder()
     .setTableNameWithTableName(tableName)
     .build();

   bigtableClient.readRowsCallable().serverStreamingCall(request, responseObserver));
 }
 

sampleRowKeysCallable

public final com.google.api.gax.rpc.ServerStreamingCallable<com.google.bigtable.v2.SampleRowKeysRequest,com.google.bigtable.v2.SampleRowKeysResponse> sampleRowKeysCallable()

Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   ApiStreamObserver<SampleRowKeysResponse> responseObserver =
       new ApiStreamObserver<SampleRowKeysResponse>() {
          @Override
         public void onNext(SampleRowKeysResponse response) {
           // Do something when receive a response
         }

          @Override
         public void onError(Throwable t) {
           // Add error-handling
         }

          @Override
         public void onCompleted() {
           // Do something when complete.
         }
       };

   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   SampleRowKeysRequest request = SampleRowKeysRequest.newBuilder()
     .setTableNameWithTableName(tableName)
     .build();

   bigtableClient.sampleRowKeysCallable().serverStreamingCall(request, responseObserver));
 }
 

mutateRow

public final com.google.bigtable.v2.MutateRowResponse mutateRow(com.google.bigtable.v2.TableName tableName,
                                                                com.google.protobuf.ByteString rowKey,
                                                                List<com.google.bigtable.v2.Mutation> mutations)

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by `mutation`.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   List<Mutation> mutations = new ArrayList<>();
   MutateRowResponse response = bigtableClient.mutateRow(tableName, rowKey, mutations);
 }
 

Parameters:

tableName - The unique name of the table to which the mutation should be applied. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.

rowKey - The key of the row to which the mutation should be applied.

mutations - Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

mutateRow

public final com.google.bigtable.v2.MutateRowResponse mutateRow(com.google.bigtable.v2.MutateRowRequest request)

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by `mutation`.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   List<Mutation> mutations = new ArrayList<>();
   MutateRowRequest request = MutateRowRequest.newBuilder()
     .setTableNameWithTableName(tableName)
     .setRowKey(rowKey)
     .addAllMutations(mutations)
     .build();
   MutateRowResponse response = bigtableClient.mutateRow(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

mutateRowCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.v2.MutateRowRequest,com.google.bigtable.v2.MutateRowResponse> mutateRowCallable()

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by `mutation`.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   List<Mutation> mutations = new ArrayList<>();
   MutateRowRequest request = MutateRowRequest.newBuilder()
     .setTableNameWithTableName(tableName)
     .setRowKey(rowKey)
     .addAllMutations(mutations)
     .build();
   ApiFuture<MutateRowResponse> future = bigtableClient.mutateRowCallable().futureCall(request);
   // Do something
   MutateRowResponse response = future.get();
 }
 

mutateRowsCallable

public final com.google.api.gax.rpc.ServerStreamingCallable<com.google.bigtable.v2.MutateRowsRequest,com.google.bigtable.v2.MutateRowsResponse> mutateRowsCallable()

Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   ApiStreamObserver<MutateRowsResponse> responseObserver =
       new ApiStreamObserver<MutateRowsResponse>() {
          @Override
         public void onNext(MutateRowsResponse response) {
           // Do something when receive a response
         }

          @Override
         public void onError(Throwable t) {
           // Add error-handling
         }

          @Override
         public void onCompleted() {
           // Do something when complete.
         }
       };

   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   List<MutateRowsRequest.Entry> entries = new ArrayList<>();
   MutateRowsRequest request = MutateRowsRequest.newBuilder()
     .setTableNameWithTableName(tableName)
     .addAllEntries(entries)
     .build();

   bigtableClient.mutateRowsCallable().serverStreamingCall(request, responseObserver));
 }
 

checkAndMutateRow

public final com.google.bigtable.v2.CheckAndMutateRowResponse checkAndMutateRow(com.google.bigtable.v2.TableName tableName,
                                                                                com.google.protobuf.ByteString rowKey,
                                                                                com.google.bigtable.v2.RowFilter predicateFilter,
                                                                                List<com.google.bigtable.v2.Mutation> trueMutations,
                                                                                List<com.google.bigtable.v2.Mutation> falseMutations)

Mutates a row atomically based on the output of a predicate Reader filter.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   RowFilter predicateFilter = RowFilter.newBuilder().build();
   List<Mutation> trueMutations = new ArrayList<>();
   List<Mutation> falseMutations = new ArrayList<>();
   CheckAndMutateRowResponse response = bigtableClient.checkAndMutateRow(tableName, rowKey, predicateFilter, trueMutations, falseMutations);
 }
 

Parameters:

tableName - The unique name of the table to which the conditional mutation should be applied. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.

rowKey - The key of the row to which the conditional mutation should be applied.

predicateFilter - The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either `true_mutations` or `false_mutations` will be executed. If unset, checks that the row contains any values at all.

trueMutations - Changes to be atomically applied to the specified row if `predicate_filter` yields at least one cell when applied to `row_key`. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if `false_mutations` is empty, and at most 100000.

falseMutations - Changes to be atomically applied to the specified row if `predicate_filter` does not yield any cells when applied to `row_key`. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if `true_mutations` is empty, and at most 100000.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

checkAndMutateRow

public final com.google.bigtable.v2.CheckAndMutateRowResponse checkAndMutateRow(com.google.bigtable.v2.CheckAndMutateRowRequest request)

Mutates a row atomically based on the output of a predicate Reader filter.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   CheckAndMutateRowRequest request = CheckAndMutateRowRequest.newBuilder()
     .setTableNameWithTableName(tableName)
     .setRowKey(rowKey)
     .build();
   CheckAndMutateRowResponse response = bigtableClient.checkAndMutateRow(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

checkAndMutateRowCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.v2.CheckAndMutateRowRequest,com.google.bigtable.v2.CheckAndMutateRowResponse> checkAndMutateRowCallable()

Mutates a row atomically based on the output of a predicate Reader filter.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   CheckAndMutateRowRequest request = CheckAndMutateRowRequest.newBuilder()
     .setTableNameWithTableName(tableName)
     .setRowKey(rowKey)
     .build();
   ApiFuture<CheckAndMutateRowResponse> future = bigtableClient.checkAndMutateRowCallable().futureCall(request);
   // Do something
   CheckAndMutateRowResponse response = future.get();
 }
 

readModifyWriteRow

public final com.google.bigtable.v2.ReadModifyWriteRowResponse readModifyWriteRow(com.google.bigtable.v2.TableName tableName,
                                                                                  com.google.protobuf.ByteString rowKey,
                                                                                  List<com.google.bigtable.v2.ReadModifyWriteRule> rules)

Modifies a row atomically. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   List<ReadModifyWriteRule> rules = new ArrayList<>();
   ReadModifyWriteRowResponse response = bigtableClient.readModifyWriteRow(tableName, rowKey, rules);
 }
 

Parameters:

tableName - The unique name of the table to which the read/modify/write rules should be applied. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.

rowKey - The key of the row to which the read/modify/write rules should be applied.

rules - Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

readModifyWriteRow

public final com.google.bigtable.v2.ReadModifyWriteRowResponse readModifyWriteRow(com.google.bigtable.v2.ReadModifyWriteRowRequest request)

Modifies a row atomically. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   List<ReadModifyWriteRule> rules = new ArrayList<>();
   ReadModifyWriteRowRequest request = ReadModifyWriteRowRequest.newBuilder()
     .setTableNameWithTableName(tableName)
     .setRowKey(rowKey)
     .addAllRules(rules)
     .build();
   ReadModifyWriteRowResponse response = bigtableClient.readModifyWriteRow(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

readModifyWriteRowCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.v2.ReadModifyWriteRowRequest,com.google.bigtable.v2.ReadModifyWriteRowResponse> readModifyWriteRowCallable()

Modifies a row atomically. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Sample code:

 try (BigtableClient bigtableClient = BigtableClient.create()) {
   TableName tableName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ByteString rowKey = ByteString.copyFromUtf8("");
   List<ReadModifyWriteRule> rules = new ArrayList<>();
   ReadModifyWriteRowRequest request = ReadModifyWriteRowRequest.newBuilder()
     .setTableNameWithTableName(tableName)
     .setRowKey(rowKey)
     .addAllRules(rules)
     .build();
   ApiFuture<ReadModifyWriteRowResponse> future = bigtableClient.readModifyWriteRowCallable().futureCall(request);
   // Do something
   ReadModifyWriteRowResponse response = future.get();
 }
 

close

public final void close()
                 throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException