Implement ack and nack methods, add javadoc and tests by mziccard · Pull Request #1027 · googleapis/google-cloud-java · GitHub

This PR implements ack and nack methods, adds javadoc and unit tests. System tests will come as soon as pull methods are implemented.

Coverage increased (+0.08%) to 84.374% when pulling 264755c on mziccard:pubsub-ack-nack into b872399 on GoogleCloudPlatform:pubsub-alpha.

Once I understand (or get feedback from JJ or Arie) the javadoc story for the repo, I expect to give quite a bit of feedback.

The code and the testing look ok, but I want to spend a few minutes at an earlier time of day re-reviewing to make sure that I believe your tests actually cover things and are helpful.

I think so far we were careful to follow the correct Javadoc guidlines for structure (spaces, tag ordering) and rules (punctuation, case,..). As for the descriptions, I think the focus was on clarity which in some
cases made it less concise. You can find in both the JDK and Guava examples to match either style.
I don't have strong opinion about it, however if you think clarity is not effected or even improved by making it shorter than I think you should go for it.

BTW, Looking at the generated Javadoc it looks like @param descriptions are not enabled.

BTW, Looking at the generated Javadoc it looks like @PARAM descriptions are not enabled.

Arie, what do you mean with this?

Arie, what do you mean with this?

I was wrong. I sampled few places (just to see how things look like per earlier discussion) and unfortunately each of these did not specify @param...
E.g. this and this and this and more...

Our internal guidelines specify that it should be a fragment, not a sentence and that it's ok to not use @param if you mention the value in the paragraph. It also specifies fewer words (ie. fragments) are better as long as it's clear.

So, I'm going to suggest a few re-wordings to be simpler - we won't go through and change existing stuff, but I think being concise is better for our users.

Not to be picky but let me clarify. Fragments are sequences of words that look like a sentence but are not. The difference from a sentence is that fragments are allowed to contain no independent clauses. An independent clause is a sequence of words that contains a subject and a verb and makes sense by itself (extrapolated from the context).

Acknowledges the given messages for the provided subscription. is already a fragment (it's missing the subject). @lesv suggestion (Acknowledges given messages for provided subscription.) simply removes the articles but does not affect its fragment nature.

For what concerns @param descriptions, according to Oracle's guide, they should start with a noun (hence the suggested @param subscription whose messages are being acknowledged is wrong), possibly preceded by an article.

I don't mind applying changes (even project-wide) if that improve docs readability I just doubt that removing some articles or conjunctions would help users.

Yep - I agree - It's what I've been pondering. I do dislike several mentions of the same thing for the future. LGTM

Thanks for the pass @lesv

…thon 3.6 (#1588)" (#1027) Reverts googleapis/java-video-intelligence#1000

…#1027)

🤖 I have created a release *beep* *boop* --- ### Updating meta-information for bleeding-edge SNAPSHOT release. --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).

🤖 I have created a release *beep* *boop* --- ### Updating meta-information for bleeding-edge SNAPSHOT release. --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).

…s#1687) (googleapis#1027) * chore(java): add a note in README for migrated split repos Disable renovate bot and flaky bot for split repositories that have moved to the Java monorepo. The Java monorepo will pass the "monorepo=True" parameter to java.common_templates method in its owlbot.py files so that the migration note will not appear in the README in the monorepo. Co-authored-by: Jeff Ching <chingor@google.com> Source-Link: https://togithub.com/googleapis/synthtool/commit/d4b291604f148cde065838c498bc8aa79b8dc10e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:edae91ccdd2dded2f572ec341a768ad180305a3e8fbfd93064b28e237d35920a

Source-Link: googleapis/synthtool@fbc8bfe Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:e76136cc48f90aa19ba29cdfbd4002111467e44a1c9d905867d98dafafbd03bb Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Co-authored-by: Ben Creech <bpcreech@google.com>

…logback to v0.130.6-alpha (#1027) * chore(deps): update dependency com.google.cloud:google-cloud-logging-logback to v0.130.6-alpha * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

…e to v2.14.1 (#1027) * chore(deps): update dependency com.google.cloud:google-cloud-datastore to v2.14.1 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Co-authored-by: Ben Creech <bpcreech@google.com>

🤖 I have created a release *beep* *boop* --- ## [2.7.12](https://togithub.com/googleapis/java-spanner-jdbc/compare/v2.7.11...v2.7.12) (2022-10-27) ### Bug Fixes * **java:** Initialize classes at build-time to address native image 22.2.0 issues ([googleapis#1026](https://togithub.com/googleapis/java-spanner-jdbc/issues/1026)) ([d5e4cb6](https://togithub.com/googleapis/java-spanner-jdbc/commit/d5e4cb6c2feea59cbc568e67193eb31b17e98873)) --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).

🤖 I have created a release *beep* *boop* --- ### Updating meta-information for bleeding-edge SNAPSHOT release. --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).

…pis#1027)

Implement ack and nack methods, add javadoc and tests

264755c

mziccard added the api: pubsub Issues related to the Pub/Sub API. label May 26, 2016

googlebot added the cla: yes This human has signed the Contributor License Agreement. label May 26, 2016

lesv reviewed May 27, 2016
View reviewed changes

mziccard merged commit 6df07ba into googleapis:pubsub-alpha Jun 1, 2016

mziccard added a commit to mziccard/gcloud-java that referenced this pull request Jun 27, 2016

Implement ack and nack methods, add javadoc and tests (googleapis#1027 )

47046e6

github-actions Bot pushed a commit that referenced this pull request Sep 30, 2022

Revert "chore: pin versions of dependencies for compatibility with Py…

da77564

…thon 3.6 (#1588)" (#1027) Reverts googleapis/java-video-intelligence#1000

github-actions Bot pushed a commit that referenced this pull request Oct 4, 2022

deps: update dependency com.google.cloud:google-cloud-core to v2.8.18 (…

d3f4be6

…#1027)

cloud-java-bot mentioned this pull request May 9, 2025

chore: Update generation configuration at Wed May 14 02:31:18 UTC 2025 #11568

Merged

This was referenced May 12, 2025

chore(main): release 1.57.0 #11577

Closed

chore(main): release 1.57.0 #11589

Merged

meltsufin pushed a commit that referenced this pull request Dec 22, 2025

feat: Add support for JSON logging to stderr (#1027 )

b202f5c

Co-authored-by: Ben Creech <bpcreech@google.com>

suztomo pushed a commit to suztomo/google-cloud-java that referenced this pull request Mar 11, 2026

feat: Add support for JSON logging to stderr (googleapis#1027 )

9da8aa7

Co-authored-by: Ben Creech <bpcreech@google.com>

benjaminp pushed a commit to benjaminp/google-cloud-java that referenced this pull request Jul 13, 2026

chore: change branch master to main in github configurations (googlea…

cce0f00

…pis#1027)

Implement ack and nack methods, add javadoc and tests by mziccard · Pull Request #1027 · googleapis/google-cloud-java · GitHub

Uh oh!

Implement ack and nack methods, add javadoc and tests - #1027

Implement ack and nack methods, add javadoc and tests#1027
mziccard merged 1 commit into
googleapis:pubsub-alphafrom
mziccard:pubsub-ack-nack

mziccard commented May 26, 2016

Uh oh!

coveralls commented May 26, 2016

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

lesv commented May 27, 2016

Uh oh!

aozarov commented May 27, 2016

Uh oh!

mziccard commented May 27, 2016

Uh oh!

aozarov commented May 27, 2016

Uh oh!

lesv commented May 28, 2016

Uh oh!

mziccard commented May 28, 2016

Uh oh!

lesv commented May 31, 2016

Uh oh!

mziccard commented Jun 1, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

+                 * acknowledge, as returned in {@link ReceivedMessage#ackId()} by {@link #pull(String, int)} and
+                 * {@link #pullAsync(String, int)}.
+                 *
+                 * @param subscription the subscription whose messages must be acknowledged

Implement ack and nack methods, add javadoc and tests by mziccard · Pull Request #1027 · googleapis/google-cloud-java · GitHub

Uh oh!

Implement ack and nack methods, add javadoc and tests - #1027

Implement ack and nack methods, add javadoc and tests#1027mziccard merged 1 commit intogoogleapis:pubsub-alphagoogleapis/google-cloud-java:pubsub-alphafrom mziccard:pubsub-ack-nackmziccard/gcloud-java:pubsub-ack-nackCopy head branch name to clipboard

Conversation

mziccard commented May 26, 2016

Uh oh!

coveralls commented May 26, 2016

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

lesv commented May 27, 2016

Uh oh!

aozarov commented May 27, 2016

Uh oh!

mziccard commented May 27, 2016

Uh oh!

aozarov commented May 27, 2016

Uh oh!

lesv commented May 28, 2016

Uh oh!

mziccard commented May 28, 2016

Uh oh!

lesv commented May 31, 2016

Uh oh!

mziccard commented Jun 1, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Implement ack and nack methods, add javadoc and tests#1027
mziccard merged 1 commit into
googleapis:pubsub-alphafrom
mziccard:pubsub-ack-nack