IBigtableDataClient (Cloud Bigtable HBase Client for Java 1.12.0 API)

com.google.cloud.bigtable.core

Interface IBigtableDataClient

• All Known Implementing Classes:

  BigtableDataClientWrapper, BigtableDataGCJClient

  ---

  
  

  public interface IBigtableDataClient

  Interface to wrap BigtableDataClient with Google-Cloud-java's models.

• • Method Summary

    All Methods Instance Methods Abstract Methods 

    Modifier and Type	Method and Description
    Boolean	checkAndMutateRow(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation) Mutate a row atomically dependent on a precondition.
    com.google.api.core.ApiFuture<Boolean>	checkAndMutateRowAsync(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation) Mutate a row atomically dependent on a precondition.
    IBulkMutation	createBulkMutationBatcher() Creates IBulkMutation batcher.
    void	mutateRow(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation) Mutate a row atomically.
    com.google.api.core.ApiFuture<Void>	mutateRowAsync(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation) Mutate a row atomically.
    ResultScanner<FlatRow>	readFlatRows(com.google.cloud.bigtable.data.v2.models.Query request) Perform a scan over FlatRows, in key order.
    com.google.api.core.ApiFuture<List<FlatRow>>	readFlatRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request) Read multiple FlatRows into an in-memory list, in key order.
    void	readFlatRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request, io.grpc.stub.StreamObserver<FlatRow> observer) Read FlatRow asynchronously, and pass them to a stream observer to be processed.
    List<FlatRow>	readFlatRowsList(com.google.cloud.bigtable.data.v2.models.Query request) Returns a list of FlatRows, in key order.
    com.google.cloud.bigtable.data.v2.models.Row	readModifyWriteRow(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow) Perform an atomic read-modify-write operation on a row.
    com.google.api.core.ApiFuture<com.google.cloud.bigtable.data.v2.models.Row>	readModifyWriteRowAsync(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow) Perform an atomic read-modify-write operation on a row.
    ResultScanner<com.google.cloud.bigtable.data.v2.models.Row>	readRows(com.google.cloud.bigtable.data.v2.models.Query request) Perform a scan over Rows, in key order.
    com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.Row>>	readRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request) Read multiple Rows into an in-memory list, in key order.
    List<com.google.cloud.bigtable.data.v2.models.KeyOffset>	sampleRowKeys(String tableId) Sample row keys from a table.
    com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.KeyOffset>>	sampleRowKeysAsync(String tableId) Sample row keys from a table, returning a Future that will complete when the sampling has completed.

• • Method Detail

    • mutateRow

      void mutateRow(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation)

      Mutate a row atomically.

      Parameters:

      rowMutation - a RowMutation model object.

    • mutateRowAsync

      com.google.api.core.ApiFuture<Void> mutateRowAsync(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation)

      Mutate a row atomically.

      Parameters:

      rowMutation - a RowMutation model object.

      Returns:

      a ApiFuture of type Void will be set when request is successful otherwise exception will be thrown.

    • readModifyWriteRow

      com.google.cloud.bigtable.data.v2.models.Row readModifyWriteRow(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow)

      Perform an atomic read-modify-write operation on a row.

      Parameters:

      readModifyWriteRow - a ReadModifyWriteRow model object.

      Returns:

      Row a modified row.

    • readModifyWriteRowAsync

      com.google.api.core.ApiFuture<com.google.cloud.bigtable.data.v2.models.Row> readModifyWriteRowAsync(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow)

      Perform an atomic read-modify-write operation on a row.

      Parameters:

      readModifyWriteRow - a ReadModifyWriteRow model object.

      Returns:

      a ApiFuture of type Row will be set when request is successful otherwise exception will be thrown.

    • createBulkMutationBatcher

      IBulkMutation createBulkMutationBatcher()

      Creates IBulkMutation batcher.

    • checkAndMutateRowAsync

      com.google.api.core.ApiFuture<Boolean> checkAndMutateRowAsync(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation)

      Mutate a row atomically dependent on a precondition.

      Parameters:

      conditionalRowMutation - a ConditionalRowMutation model object.

      Returns:

      a ApiFuture of type Boolean will be set when request is successful otherwise exception will be thrown.

    • checkAndMutateRow

      Boolean checkAndMutateRow(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation)

      Mutate a row atomically dependent on a precondition.

      Parameters:

      conditionalRowMutation - a ConditionalRowMutation model object.

      Returns:

      returns true if predicate returns any result.

    • sampleRowKeys

      List<com.google.cloud.bigtable.data.v2.models.KeyOffset> sampleRowKeys(String tableId)

      Sample row keys from a table.

      Parameters:

      tableId - a String object.

      Returns:

      an immutable List object.

    • sampleRowKeysAsync

      com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.KeyOffset>> sampleRowKeysAsync(String tableId)

      Sample row keys from a table, returning a Future that will complete when the sampling has completed.

      Parameters:

      tableId - a String object.

      Returns:

      a ApiFuture object.

    • readRows

      ResultScanner<com.google.cloud.bigtable.data.v2.models.Row> readRows(com.google.cloud.bigtable.data.v2.models.Query request)

      Perform a scan over Rows, in key order.

      Parameters:

      request - a Query object.

      Returns:

      a Row object.

    • readRowsAsync

      com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.Row>> readRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request)

      Read multiple Rows into an in-memory list, in key order.

      Parameters:

      request - a Query object.

      Returns:

      a ApiFuture that will finish when all reads have completed.

    • readFlatRowsList

      List<FlatRow> readFlatRowsList(com.google.cloud.bigtable.data.v2.models.Query request)

      Returns a list of FlatRows, in key order.

      Parameters:

      request - a Query object.

      Returns:

      a List with FlatRows.

    • readFlatRows

      ResultScanner<FlatRow> readFlatRows(com.google.cloud.bigtable.data.v2.models.Query request)

      Perform a scan over FlatRows, in key order.

      Parameters:

      request - a Query object.

      Returns:

      a ResultScanner object.

    • readFlatRowsAsync

      com.google.api.core.ApiFuture<List<FlatRow>> readFlatRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request)

      Read multiple FlatRows into an in-memory list, in key order.

      Parameters:

      request - a Query object.

      Returns:

      a ApiFuture that will finish when all reads have completed.

    • readFlatRowsAsync

      void readFlatRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request,
                             io.grpc.stub.StreamObserver<FlatRow> observer)

      Read FlatRow asynchronously, and pass them to a stream observer to be processed.

      Parameters:

      request - a Query object.

      observer - a StreamObserver object.