Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: java doc update to for returned data instances #165

Merged
merged 3 commits into from Feb 24, 2020
+11 −4
Merged

chore: java doc update to for returned data instances #165

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7fbb0d
chore: java doc update to for returned data instances
rahulKQL Jan 21, 2020
7a5f8d5
chore: addressing feedback comments
rahulKQL Jan 23, 2020
e481b50
Adding comments for BigtableDataClient#readRows()
rahulKQL Jan 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 9 additions & 3 deletions ...le-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/BigtableDataClient.java
View file
Open in desktop
Expand Up @@ -64,6 +64,9 @@
* an application. However, close() needs to be called on the client object to clean up resources
* such as threads during application shutdown.
*
* <p>This client can be safely shared across multiple threads except for the Batcher instances
* returned from bulk operations, eg. `newBulkMutationBatcher()`, `newBulkReadRowsBatcher()`.
*
rahulKQL marked this conversation as resolved.
Show resolved Hide resolved
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
Expand Down Expand Up @@ -911,7 +914,8 @@ public void bulkMutateRows(BulkMutation mutation) {

/**
* Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow,
* but the entire batch is not executed atomically.
* but the entire batch is not executed atomically. The returned Batcher instance is not
* threadsafe, it can only be used from single thread.
*
* <p>Sample Code:
*
Expand Down Expand Up @@ -939,7 +943,8 @@ public Batcher<RowMutationEntry, Void> newBulkMutationBatcher(@Nonnull String ta

/**
* Reads rows for given tableId in a batch. If the row does not exist, the value will be null.
* This operation should be called with in a single thread.
* This operation should be called with in a single thread. The returned Batcher instance is not
* threadsafe, it can only be used from single thread.
*
* <p>Sample Code:
*
Expand Down Expand Up @@ -973,7 +978,8 @@ public Batcher<ByteString, Row> newBulkReadRowsBatcher(String tableId) {

/**
* Reads rows for given tableId and filter criteria in a batch. If the row does not exist, the
* value will be null. This operation should be called with in a single thread.
* value will be null. This operation should be called with in a single thread. The returned
* Batcher instance is not threadsafe, it can only be used from single thread.
*
* <p>Sample Code:
*
Expand Down