[csharp] Address obsolete build warnings in ApiClient (#19847)

* Stop using obsolete MaxTimeout

* Convert timeout to a timespan, rather than update the configuration object

* Use async overload of RestClientExtensions.Deserialize

* Update samples

* Fix typo

* Undo timeout change
This commit is contained in:
Alec Petersen 2024-10-14 03:44:12 -04:00 committed by GitHub
parent 8849156d29
commit b5b760a8a2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 48 additions and 48 deletions

View File

@ -550,11 +550,11 @@ namespace {{packageName}}.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -587,7 +587,7 @@ namespace {{packageName}}.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -613,7 +613,7 @@ namespace {{packageName}}.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -533,11 +533,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -570,7 +570,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -594,7 +594,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -533,11 +533,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -570,7 +570,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -594,7 +594,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -549,11 +549,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -586,7 +586,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -610,7 +610,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -549,11 +549,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -586,7 +586,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -610,7 +610,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -549,11 +549,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -586,7 +586,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -610,7 +610,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -532,11 +532,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -569,7 +569,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -593,7 +593,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -548,11 +548,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -585,7 +585,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -609,7 +609,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -548,11 +548,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -585,7 +585,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -609,7 +609,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -532,11 +532,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -569,7 +569,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -593,7 +593,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -549,11 +549,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -586,7 +586,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -610,7 +610,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {

View File

@ -549,11 +549,11 @@ namespace Org.OpenAPITools.Client
} }
} }
private RestResponse<T> DeserializeRestResponseFromPolicy<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult) private async Task<RestResponse<T>> DeserializeRestResponseFromPolicyAsync<T>(RestClient client, RestRequest request, PolicyResult<RestResponse> policyResult, CancellationToken cancellationToken = default)
{ {
if (policyResult.Outcome == OutcomeType.Successful) if (policyResult.Outcome == OutcomeType.Successful)
{ {
return client.Deserialize<T>(policyResult.Result); return await client.Deserialize<T>(policyResult.Result, cancellationToken);
} }
else else
{ {
@ -586,7 +586,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.RetryPolicy; var policy = RetryConfiguration.RetryPolicy;
var policyResult = policy.ExecuteAndCapture(() => client.Execute(request)); var policyResult = policy.ExecuteAndCapture(() => client.Execute(request));
return Task.FromResult(DeserializeRestResponseFromPolicy<T>(client, request, policyResult)); return DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult);
} }
else else
{ {
@ -610,7 +610,7 @@ namespace Org.OpenAPITools.Client
{ {
var policy = RetryConfiguration.AsyncRetryPolicy; var policy = RetryConfiguration.AsyncRetryPolicy;
var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false); var policyResult = await policy.ExecuteAndCaptureAsync((ct) => client.ExecuteAsync(request, ct), cancellationToken).ConfigureAwait(false);
return DeserializeRestResponseFromPolicy<T>(client, request, policyResult); return await DeserializeRestResponseFromPolicyAsync<T>(client, request, policyResult, cancellationToken);
} }
else else
{ {