feat: implement listLogs API and provide sample snippet

[minherz]

Implements listLogs interface for com.google.cloud.logging.Logging interface.
Implements unit testing for the listLogs interface.
Adds sample snippet for listLogs interface.
Refactors com.example.logging.ListLogs to incorporate listLogs snippet into the class.

Fixes #593
Fixes #358

[snippet-bot]

Here is the summary of changes.

You are about to add 3 region tags.

• samples/snippets/src/main/java/com/example/logging/ListLogEntries.java:19, tag logging_list_log_entries
• samples/snippets/src/main/java/com/example/logging/ListLogs.java:19, tag logging_list_logs
• samples/snippets/src/main/java/com/example/logging/ListLogs.java:46, tag logging_list_log_entries

You are about to delete 1 region tag.

• samples/snippets/src/main/java/com/example/logging/ListLogs.java:33, tag logging_list_log_entries

---

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

• Refresh this comment

The XML file was modified to narrow the opted out scope. The default method implementations were provided.

[chingor13]

Feature looks fine to me (aside from the method name on the Rpc interface/implementation).

New samples need to follow the rubric/format set by the Java samples working group: https://github.com/GoogleCloudPlatform/java-docs-samples/blob/master/SAMPLE_FORMAT.md. If that is significant work, consider breaking apart the feature PR and the sample PR

[simonz130]

Great work!

[minherz]

@chingor13 i did not find the reason why the snippet-bot fails. the region tags in ListLogs.java and ListLogEntries.java match and I am unaware of other tests that the bot may perform. maybe it is due to the split of the snippets.
i tried to restart the check from the Checks console, but it either does not work or has no effect.

[chingor13]

@chingor13 i did not find the reason why the snippet-bot fails. the region tags in ListLogs.java and ListLogEntries.java match and I am unaware of other tests that the bot may perform. maybe it is due to the split of the snippets.
i tried to restart the check from the Checks console, but it either does not work or has no effect.

The way snippets work on Cloudsite is the reference the snippet by GitHub repo, file path, and snippet name. By moving the snippet to a different file, it will break the sample usage. Moving a snippet to a new file or repo involves 3 steps:

1. Duplicate the snippet to the new file
2. Fix references to that snippet to the new location
3. Remove the original snippet.

[chingor13]

nit on license header in new file

Otherwise make sure we're not breaking the snippets

[lesv]

We do not bump copyrights.
Please ping me if you want details.

[minherz]

@lesv the copyright year change for existing files are rolled back. the copyright year is adjusted for a new file only.

stale, will defer to other reviewers

[lesv]

+// [START logging_list_log_entries]
+
+
+// [END logging_list_log_entries]

Jeff, it is a problem of the chicken and egg. Your review request was to have one snippet per file (by guidelines). Snippet management team requires the migration to be done by first introducing the code and then moving the region tag (spoke with Takashi). It is impossible to do both at once. This PR is stuck for a week just because we discuss this subject. Please, release it. I will issue the fixing PR within an hour that will clean up the duplicated region tag.
The guidelines allow a short period of time when the particular sample will be empty. I just need the help to take the work forward.

Woa - this seems wrong. Where are you hearing about this process -- I'd like to fix it.

[lesv]

Note - my LGTM was only for the copyrights. Let me take another look.

[lesv]

In thinking about it, they are trying to create an interface with default methods here. (a Java 8 feature). Since *logging* will never be created directly, you'll never execute this code. I believe I closed the comment before I LGTM'd the review. Sorry it was sent.

…

On Thu, Aug 12, 2021 at 8:00 AM minherz ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In google-cloud-logging/src/main/java/com/google/cloud/logging/Logging.java <#602 (comment)> : > + * <p>Example of listing log names, specifying the page size. + * + * ***@***.*** + * Page<Log> logNames = logging.listLogs(ListOption.pageSize(100)); + * Iterator<Log> logIterator = logNames.iterateAll().iterator(); + * while (logIterator.hasNext()) { + * String logName = logIterator.next(); + * // do something with the log name + * } + * }</pre> + * + * @throws LoggingException upon failure + */ + default Page<String> listLogs(ListOption... options) { + throw new UnsupportedOperationException( + "method listLogs() does not have default implementation"); + } @lesv <https://github.com/lesv> can you ref me to guideline about providing (or not) examples in javadoc? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#602 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIVLDSSDHYK5MZZ5EZR44TT4QD3VANCNFSM5BIKN6MA> .