Package com.google.bigtable.v2
Class BigtableGrpc.BigtableStub
java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractAsyncStub<BigtableGrpc.BigtableStub>
com.google.bigtable.v2.BigtableGrpc.BigtableStub
- Enclosing class:
- BigtableGrpc
public static final class BigtableGrpc.BigtableStub
extends io.grpc.stub.AbstractAsyncStub<BigtableGrpc.BigtableStub>
A stub to allow clients to do asynchronous rpc calls to service Bigtable.
Service for reading from and writing to existing Bigtable tables.
-
Nested Class Summary
Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub
io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>> -
Method Summary
Modifier and TypeMethodDescriptionprotected BigtableGrpc.BigtableStubbuild(io.grpc.Channel channel, io.grpc.CallOptions callOptions) voidcheckAndMutateRow(CheckAndMutateRowRequest request, io.grpc.stub.StreamObserver<CheckAndMutateRowResponse> responseObserver) Mutates a row atomically based on the output of a predicate Reader filter.voidgenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request, io.grpc.stub.StreamObserver<GenerateInitialChangeStreamPartitionsResponse> responseObserver) NOTE: This API is intended to be used by Apache Beam BigtableIO.voidmutateRow(MutateRowRequest request, io.grpc.stub.StreamObserver<MutateRowResponse> responseObserver) Mutates a row atomically.voidmutateRows(MutateRowsRequest request, io.grpc.stub.StreamObserver<MutateRowsResponse> responseObserver) Mutates multiple rows in a batch.voidpingAndWarm(PingAndWarmRequest request, io.grpc.stub.StreamObserver<PingAndWarmResponse> responseObserver) Warm up associated instance metadata for this connection.voidreadChangeStream(ReadChangeStreamRequest request, io.grpc.stub.StreamObserver<ReadChangeStreamResponse> responseObserver) NOTE: This API is intended to be used by Apache Beam BigtableIO.voidreadModifyWriteRow(ReadModifyWriteRowRequest request, io.grpc.stub.StreamObserver<ReadModifyWriteRowResponse> responseObserver) Modifies a row atomically on the server.voidreadRows(ReadRowsRequest request, io.grpc.stub.StreamObserver<ReadRowsResponse> responseObserver) Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each.voidsampleRowKeys(SampleRowKeysRequest request, io.grpc.stub.StreamObserver<SampleRowKeysResponse> responseObserver) Returns a sample of row keys in the table.Methods inherited from class io.grpc.stub.AbstractAsyncStub
newStub, newStubMethods inherited from class io.grpc.stub.AbstractStub
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady
-
Method Details
-
build
- Specified by:
buildin classio.grpc.stub.AbstractStub<BigtableGrpc.BigtableStub>
-
readRows
public void readRows(ReadRowsRequest request, io.grpc.stub.StreamObserver<ReadRowsResponse> responseObserver) 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.
-
sampleRowKeys
public void sampleRowKeys(SampleRowKeysRequest request, io.grpc.stub.StreamObserver<SampleRowKeysResponse> responseObserver) 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.
-
mutateRow
public void mutateRow(MutateRowRequest request, io.grpc.stub.StreamObserver<MutateRowResponse> responseObserver) Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by `mutation`.
-
mutateRows
public void mutateRows(MutateRowsRequest request, io.grpc.stub.StreamObserver<MutateRowsResponse> responseObserver) Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.
-
checkAndMutateRow
public void checkAndMutateRow(CheckAndMutateRowRequest request, io.grpc.stub.StreamObserver<CheckAndMutateRowResponse> responseObserver) Mutates a row atomically based on the output of a predicate Reader filter.
-
pingAndWarm
public void pingAndWarm(PingAndWarmRequest request, io.grpc.stub.StreamObserver<PingAndWarmResponse> responseObserver) Warm up associated instance metadata for this connection. This call is not required but may be useful for connection keep-alive.
-
readModifyWriteRow
public void readModifyWriteRow(ReadModifyWriteRowRequest request, io.grpc.stub.StreamObserver<ReadModifyWriteRowResponse> responseObserver) Modifies a row atomically on the server. 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.
-
generateInitialChangeStreamPartitions
public void generateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request, io.grpc.stub.StreamObserver<GenerateInitialChangeStreamPartitionsResponse> responseObserver) NOTE: This API is intended to be used by Apache Beam BigtableIO. Returns the current list of partitions that make up the table's change stream. The union of partitions will cover the entire keyspace. Partitions can be read with `ReadChangeStream`.
-
readChangeStream
public void readChangeStream(ReadChangeStreamRequest request, io.grpc.stub.StreamObserver<ReadChangeStreamResponse> responseObserver) NOTE: This API is intended to be used by Apache Beam BigtableIO. Reads changes from a table's change stream. Changes will reflect both user-initiated mutations and mutations that are caused by garbage collection.
-