BigtableDataClient (Cloud Bigtable HBase Client for Java 1.3.0 API)

com.google.cloud.bigtable.grpc

Interface BigtableDataClient

  • All Known Implementing Classes:
    BigtableDataGrpcClient


    public interface BigtableDataClient
    Interface to access v2 Bigtable data service methods.
    Version:
    $Id: $Id
    Author:
    sduskis
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      com.google.bigtable.v2.CheckAndMutateRowResponse checkAndMutateRow(com.google.bigtable.v2.CheckAndMutateRowRequest request)
      Mutate a row atomically dependent on a precondition.
      ListenableFuture<com.google.bigtable.v2.CheckAndMutateRowResponse> checkAndMutateRowAsync(com.google.bigtable.v2.CheckAndMutateRowRequest request)
      Mutate a row atomically dependent on a precondition.
      com.google.bigtable.v2.MutateRowResponse mutateRow(com.google.bigtable.v2.MutateRowRequest request)
      Mutate a row atomically.
      ListenableFuture<com.google.bigtable.v2.MutateRowResponse> mutateRowAsync(com.google.bigtable.v2.MutateRowRequest request)
      Mutate a row atomically.
      List<com.google.bigtable.v2.MutateRowsResponse> mutateRows(com.google.bigtable.v2.MutateRowsRequest request)
      Mutates multiple rows in a batch.
      ListenableFuture<List<com.google.bigtable.v2.MutateRowsResponse>> mutateRowsAsync(com.google.bigtable.v2.MutateRowsRequest request)
      Mutates multiple rows in a batch.
      ResultScanner<FlatRow> readFlatRows(com.google.bigtable.v2.ReadRowsRequest request)
      Perform a scan over FlatRows, in key order.
      ScanHandler readFlatRows(com.google.bigtable.v2.ReadRowsRequest request, io.grpc.stub.StreamObserver<FlatRow> observer)
      Perform a streaming read of FlatRows in key order.
      ListenableFuture<List<FlatRow>> readFlatRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)
      Read multiple FlatRows into an in-memory list, in key order.
      List<FlatRow> readFlatRowsList(com.google.bigtable.v2.ReadRowsRequest request)
      Returns a list of FlatRows, in key order.
      com.google.bigtable.v2.ReadModifyWriteRowResponse readModifyWriteRow(com.google.bigtable.v2.ReadModifyWriteRowRequest request)
      Perform an atomic read-modify-write operation on a row.
      ListenableFuture<com.google.bigtable.v2.ReadModifyWriteRowResponse> readModifyWriteRowAsync(com.google.bigtable.v2.ReadModifyWriteRowRequest request)
      Perform an atomic read-modify-write operation on a row,
      ResultScanner<com.google.bigtable.v2.Row> readRows(com.google.bigtable.v2.ReadRowsRequest request)
      Perform a scan over Rows, in key order.
      ListenableFuture<List<com.google.bigtable.v2.Row>> readRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)
      Read multiple Rows into an in-memory list, in key order.
      List<com.google.bigtable.v2.SampleRowKeysResponse> sampleRowKeys(com.google.bigtable.v2.SampleRowKeysRequest request)
      Sample row keys from a table.
      ListenableFuture<List<com.google.bigtable.v2.SampleRowKeysResponse>> sampleRowKeysAsync(com.google.bigtable.v2.SampleRowKeysRequest request)
      Sample row keys from a table, returning a Future that will complete when the sampling has completed.
      void setCallOptionsFactory(CallOptionsFactory callOptionsFactory)
      Sets a CallOptionsFactory which creates CallOptions
    • Method Detail

      • mutateRow

        com.google.bigtable.v2.MutateRowResponse mutateRow(com.google.bigtable.v2.MutateRowRequest request)
        Mutate a row atomically.
        Parameters:
        request - a MutateRowRequest object.
        Returns:
        a MutateRowResponse object.
      • mutateRowAsync

        ListenableFuture<com.google.bigtable.v2.MutateRowResponse> mutateRowAsync(com.google.bigtable.v2.MutateRowRequest request)
        Mutate a row atomically.
        Parameters:
        request - a MutateRowRequest object.
        Returns:
        a ListenableFuture that will finish when the mutation has completed.
      • mutateRows

        List<com.google.bigtable.v2.MutateRowsResponse> mutateRows(com.google.bigtable.v2.MutateRowsRequest request)
        Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.
        Parameters:
        request - a MutateRowsRequest object.
        Returns:
        a List object.
      • mutateRowsAsync

        ListenableFuture<List<com.google.bigtable.v2.MutateRowsResponse>> mutateRowsAsync(com.google.bigtable.v2.MutateRowsRequest request)
        Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.
        Parameters:
        request - a MutateRowsRequest object.
        Returns:
        a ListenableFuture that will finish when the mutations have all been completed.
      • checkAndMutateRow

        com.google.bigtable.v2.CheckAndMutateRowResponse checkAndMutateRow(com.google.bigtable.v2.CheckAndMutateRowRequest request)
        Mutate a row atomically dependent on a precondition.
        Parameters:
        request - a CheckAndMutateRowRequest object.
        Returns:
        a CheckAndMutateRowResponse object.
      • checkAndMutateRowAsync

        ListenableFuture<com.google.bigtable.v2.CheckAndMutateRowResponse> checkAndMutateRowAsync(com.google.bigtable.v2.CheckAndMutateRowRequest request)
        Mutate a row atomically dependent on a precondition.
        Parameters:
        request - a CheckAndMutateRowRequest object.
        Returns:
        a ListenableFuture that will finish when the mutation has completed.
      • readModifyWriteRow

        com.google.bigtable.v2.ReadModifyWriteRowResponse readModifyWriteRow(com.google.bigtable.v2.ReadModifyWriteRowRequest request)
        Perform an atomic read-modify-write operation on a row.
        Parameters:
        request - a ReadModifyWriteRowRequest object.
        Returns:
        a ReadModifyWriteRowResponse object.
      • readModifyWriteRowAsync

        ListenableFuture<com.google.bigtable.v2.ReadModifyWriteRowResponse> readModifyWriteRowAsync(com.google.bigtable.v2.ReadModifyWriteRowRequest request)
        Perform an atomic read-modify-write operation on a row,
        Parameters:
        request - a ReadModifyWriteRowRequest object.
        Returns:
        a ListenableFuture that will finish when the mutation has completed.
      • sampleRowKeys

        List<com.google.bigtable.v2.SampleRowKeysResponse> sampleRowKeys(com.google.bigtable.v2.SampleRowKeysRequest request)
        Sample row keys from a table.
        Parameters:
        request - a SampleRowKeysRequest object.
        Returns:
        an immutable List object.
      • sampleRowKeysAsync

        ListenableFuture<List<com.google.bigtable.v2.SampleRowKeysResponse>> sampleRowKeysAsync(com.google.bigtable.v2.SampleRowKeysRequest request)
        Sample row keys from a table, returning a Future that will complete when the sampling has completed.
        Parameters:
        request - a SampleRowKeysRequest object.
        Returns:
        a ListenableFuture object.
      • readRows

        ResultScanner<com.google.bigtable.v2.Row> readRows(com.google.bigtable.v2.ReadRowsRequest request)
        Perform a scan over Rows, in key order.
        Parameters:
        request - a ReadRowsRequest object.
        Returns:
        a ResultScanner object.
      • readRowsAsync

        ListenableFuture<List<com.google.bigtable.v2.Row>> readRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)
        Read multiple Rows into an in-memory list, in key order.
        Parameters:
        request - a ReadRowsRequest object.
        Returns:
        a ListenableFuture that will finish when all reads have completed.
      • readFlatRowsList

        List<FlatRow> readFlatRowsList(com.google.bigtable.v2.ReadRowsRequest request)
        Returns a list of FlatRows, in key order.
        Parameters:
        request - a ReadRowsRequest object.
        Returns:
        a List with FlatRows.
      • readFlatRows

        ResultScanner<FlatRow> readFlatRows(com.google.bigtable.v2.ReadRowsRequest request)
        Perform a scan over FlatRows, in key order.
        Parameters:
        request - a ReadRowsRequest object.
        Returns:
        a ResultScanner object.
      • readFlatRows

        ScanHandler readFlatRows(com.google.bigtable.v2.ReadRowsRequest request,
                                 io.grpc.stub.StreamObserver<FlatRow> observer)
        Perform a streaming read of FlatRows in key order. It would be a good idea to turn on client side timeouts via CallOptionsConfig.Builder.setUseTimeout(boolean).
        Parameters:
        request - a ReadRowsRequest object.
        observer - a StreamObserver object
        Returns:
        a ScanHandler which can be used to either cancel or timeout the request.
      • readFlatRowsAsync

        ListenableFuture<List<FlatRow>> readFlatRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)
        Read multiple FlatRows into an in-memory list, in key order.
        Parameters:
        request - a ReadRowsRequest object.
        Returns:
        a ListenableFuture that will finish when all reads have completed.


Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Bigtable Documentation