[Bigtable] Updated javaDoc for callable being wrapper around read & write by rahulKQL · Pull Request #6431 · googleapis/google-cloud-java · GitHub
Skip to content

[Bigtable] Updated javaDoc for callable being wrapper around read & write#6431

Merged
igorbernstein2 merged 3 commits into
googleapis:masterfrom
rahulKQL:callable_docs
Oct 10, 2019
Merged

[Bigtable] Updated javaDoc for callable being wrapper around read & write#6431
igorbernstein2 merged 3 commits into
googleapis:masterfrom
rahulKQL:callable_docs

Conversation

@rahulKQL

@rahulKQL rahulKQL commented Oct 3, 2019

Copy link
Copy Markdown
Contributor

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

codecov Bot commented Oct 3, 2019

Copy link
Copy Markdown

@igorbernstein2 igorbernstein2 left a comment

Copy link
Copy Markdown
Contributor

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please provide an example

Copy link
Copy Markdown
Contributor

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); 

@igorbernstein2 igorbernstein2 left a comment

Copy link
Copy Markdown
Contributor

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