googleapis / googleapis/google-cloud-java

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

オープン
#12,376 コメント 3 件 リアクション 0 件 担当者 1 名 @lqiu96 が担当を希望しています GitHub で見る
priority: p3 samples type: docs
主要言語
Java
スター
2.1k
フォーク
1.2k
平均マージ
1日 23時間
マージ済み PR(30日)
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 を短くまとめたダイジェスト。