googleapis / googleapis/google-cloud-java

[sdk-platform-java] Update the generated samples to reflect client lifecycle best practices

未关闭
#12,376 3 条评论 0 个 reaction 已指派 1 人 已被 @lqiu96 认领 在 GitHub 查看
priority: p3 samples type: docs
主要语言
Java
星标
2.1k
派生
1.2k
平均合并
1 天 23 小时
30 天内合并 PR
154

描述

The generated samples in each GAPIC client library show use cases of try-with resources. Example: https://github.com/googleapis/google-cloud-java/blob/7346a852311cdcb958ef57066eaab8679f02a64c/java-admanager/ad-manager/src/main/java/com/google/ads/admanager/v1/NetworkServiceClient.java#L325

While this is a good example as a sample to show how a client is created and closed without incurring memory leaks, it may provide our users with an incorrect idea of how to create clients. We expect client libraries to be long-lived and not to be re-created/ closed repeatedly.

We should update the samples with a few options:
1. Samples are updated to not use try-with-resources
2. Samples have wording to describe that they are for example purposed and link to the official docs
3. ... Other options?

High Level Changes:
The samples from the GAPIC clients are generated from the generator. Based on the option we choose, we'll have to update the generator accordingly.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。