8000 [Bigtable] Updated javaDoc for callable being wrapper around read & write by rahulKQL · Pull Request #6431 · googleapis/google-cloud-java · GitHub 10000
[go: up one dir, main page]

Skip to content

Conversation

@rahulKQL
Copy link
@rahulKQL rahulKQL commented Oct 3, 2019

Fixes #4054

Updated JavaDoc for callable being wrapper around read & write Operation.

@rahulKQL rahulKQL added the api: bigtable Issues related to the Bigtable API. label Oct 3, 2019
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 3, 2019
@codecov
Copy link
codecov bot commented Oct 3, 2019

Codecov Report

Merging #6431 into master will increase coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #6431      +/-   ##
============================================
+ Coverage     45.98%   46.06%   +0.07%     
- Complexity    26480    27968    +1488     
============================================
  Files          2613     2613              
  Lines        282539   287796    +5257     
  Branches      33559    32895     -664     
============================================
+ Hits         129926   132571    +2645     
- Misses       143357   144181     +824     
- Partials       9256    11044    +1788
Impacted Files Coverage Δ Complexity Δ
...gle/cloud/bigtable/data/v2/BigtableDataClient.java 89.58% <ø> (-1.91%) 32 <0> (ø)
...va/com/google/cloud/compute/v1/InstanceClient.java 48.65% <0%> (-14.23%) 147% <0%> (+36%)
...ava/com/google/cloud/compute/v1/ProjectClient.java 51.14% <0%> (-12.93%) 55% <0%> (+13%)
.../com/google/cloud/compute/v1/TargetPoolClient.java 52.06% <0%> (-12.65%) 47% <0%> (+11%)
.../com/google/cloud/compute/v1/RegionDiskClient.java 47.9% <0%> (-12.65%) 43% <0%> (+10%)
...va/com/google/cloud/compute/v1/SnapshotClient.java 50% <0%> (-12.62%) 31% <0%> (+7%)
...d/compute/v1/RegionInstanceGroupManagerClient.java 48.81% <0%> (-12.48%) 51% <0%> (+12%)
...ava/com/google/cloud/compute/v1/NetworkClient.java 49.01% <0%> (-12.47%) 39% <0%> (+9%)
...onitoring/v3/NotificationChannelServiceClient.java 59.17% <0%> (-12.46%) 43% <0%> (+10%)
.../google/cloud/compute/v1/TargetSslProxyClient.java 48.57% <0%> (-12.41%) 35% <0%> (+8%)
... and 664 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cd38245...3f1e804. Read the comment docs.

Copy link
@igorbernstein2 igorbernstein2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs to be worked in to the existing doc better.

* service.
* <li>Each read or write operation in this client is built around the callables in the form of
* synchronized or asynchronized operation. These operation can also be achieved by directly
* using callables.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please provide an example

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually looking at the docs, it seems like the callables info is already there:

*   <li>A "callable" method, like `readRowsCallable()`. This type of method takes no parameters and
 *       returns an immutable API callable object, which can be used to initiate calls to the	 *       returns an immutable API callable object, which can be used to initiate calls to the
 *       service.	 *       service.

I think all this needs is just an example:

Taking ReadRows as an example:

// These two invocation are equivalent
ServerStream<Row> stream1 = client.readRows(query);
ServerStream<Row> stream2 = client.readRowsCallable().call(query);

// These two invocation are also equivalent
client.readRowsAsync(query, observer);
client.readRowsCallable().call(query, observer); 

Copy link
@igorbernstein2 igorbernstein2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@igorbernstein2 igorbernstein2 merged commit b219b52 into googleapis:master Oct 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigtable Issues related to the Bigtable API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bigtable: Improve docs to make it clear that all methods are wrappers around callables

3 participants

0