googleapis / googleapis/google-cloud-java

[sdk-platform-java] [ggj] generate example of ApiCallContext.withRetrySettings on client

オープン
#12,543 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
priority: p3 type: feature request
主要言語
Java
スター
2.1k
フォーク
1.2k
平均マージ
1日 23時間
マージ済み PR(30日)
154

説明

https://github.com/googleapis/gax-java/pull/1238 introduced a new feature to the `ApiCallContext` that allows end users to supply `RetrySetttings` to be used for a single method invocation. The examples and documentation in the PR are generic, and show how to create an entirely new `RetrySettings` instance to supply via `withRetrySettings`, but there is API specific documentation that ggj could generate that would greatly help users. We should generate a single, client-level example of configuring `RetrySettings` via the `ApiCallContext` in the GAPIC layer that utilizes that GAPIC's `StubSettings` class as a base `RetrySettings` to modify. An example usage is as follows:

```java
LanguageServiceClient client = LanguageServiceClient.create();

// In order to adjust the RetrySettings on a per-call basis, modify the default settings
// and supply it via the ApiCallContext.
RetrySettings retrySettings =
client
.getSettings()
.analyzeSentimentSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(10L))
.builder();

ApiCallContext callContext = GrpcCallContext.createDefault().withRetrySettings(retrySettings);

client.analyzeSentimentCallable().call(request, callContext);
```

_Note: The spacing is probably off there._

A similar existing example in [`LanguageServiceStubSettings`](https://github.com/googleapis/java-language/blob/master/google-cloud-language/src/main/java/com/google/cloud/language/v1/stub/LanguageServiceStubSettings.java#L70-L85).

I'm thinking it would be generated in this [client-level doc comment](https://github.com/googleapis/java-language/blob/master/google-cloud-language/src/main/java/com/google/cloud/language/v1/LanguageServiceClient.java#L61-L91) block somewhere.

cc: @miraleung

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。