feat(generator): emit resumable upload settings and HttpJson upload stub by whowes · Pull Request #14321 · googleapis/google-cloud-java

whowes · 2026-09-09T06:33:44Z

Modified and introduces composers to emit an internal, dedicated REST stub and settings for resumable upload-powered services

blakeli0 · 2026-09-15T18:33:19Z

+   */
+  public static HttpJsonResumableUploadServiceResumableUploadStub createFrom(
+      ClientContext clientContext, ResumableUploadServiceStubSettings settings) {
+    String uploadEndpoint =


Maybe create a new clientContext using ClientContext.create(settings)? So we don't have to manually re-create the clientContext from existing clientContext?

After more investigation, I think ClientContext.create(settings) should work for httpjson stub without any issues. For grpc stub, we need to recreate the settings with a default internal header provider and httpjson channel, then ClientContext.create(settings) should work.

Hmmm, I guess I'm not seeing how calling ClientContext.create(settings) inside the upload stub without referencing the parent context can avoid at least two main issues:

for both transports, in the top-level stub layer's create(ClientContext) factory overload, settings is just <Service>StubSettings.newBuilder().build(), so if we re-create from settings then everything caller-supplied on the ClientContext is dropped. We'd also be creating a separate thread pool and doing another ADC lookup on every client instance (even on REST stubs that already built an HTTP ClientContext- this I guess isn't functionally a problem, just suboptimal).

we can't swap the gRPC internal headers (x-goog-api-client: ... grpc/...) for HTTP headers via settings.toBuilder() because StubSettings.Builder#setInternalHeaderProvider is protected and in a different package (unless you think it's worth widening it for this, but the above issue still seems like a blocker alone)

Took another look at this - I still don't see how we can fully rebuild from just settings without using some of the "parent" clientContext? In this PR as-is the generated code is pretty ugly but perhaps pushing that into the ClientContext itself makes sense - prototyped #14412 for illustration.

ClientContext is not the source of truth and users are not supposed to modify it directly, it is derived from StubSettings which is considered the source of truth for all the customization. Also see the javadocs for ClientContext.

For thread pool and ADC, I do agree it is a slightly overhead, but it might be OK for simplicity. For the least performance overhead, we can use clientContext directly for httpjson and recreate clientContext from StubSettings for grpc.

StubSettings.Builder#setInternalHeaderProvider is indeed a problem. We could expose a new toHttpJsonBuilder() that copies everything but change the internal header provider to httpjson format.

Since we're OK with the thread pool/ADC inefficiency this now is just creating fresh ClientContext. To make the internal headers work, there's now a generated setHttpJsonInternalHeaderProvider on the <Service>StubSettings.Builder that's only added for services that need resumable upload support.

blakeli0 · 2026-09-15T18:35:13Z

+   * settings. This is protected so that it is easy to make a subclass, but otherwise, the static
+   * factory methods should be preferred.
+   */
+  protected HttpJsonResumableUploadServiceResumableUploadStub(


We have three constructor/factory methods that have the same arguments, consider consolidate them.

Modified this to have one private constructor and one factory method (which has a conditional to adapt for gRPC v. HTTP/JSON).

blakeli0 · 2026-09-16T03:33:34Z

+      RetrySettings settings = null;
+      settings = RetrySettings.newBuilder().setRpcTimeoutMultiplier(1.0).build();
+      definitions.put("no_retry_params", settings);
+      RETRY_PARAM_DEFINITIONS = definitions.build();


The retry settings are not used currently, we need to add the initial unary call settings to ResumableUploadCallSettings. I'll work on it in a separate PR.

SGTM, thanks!

blakeli0 · 2026-09-18T17:18:23Z

+                    .build())
+            .setTransportChannelProvider(
+                InstantiatingHttpJsonChannelProvider.newBuilder()
+                    .setEndpoint(settings.getEndpoint())


Endpoint will be set in ClientContext, I don't think we need to set endpoint explicitly. For non-httpjson, I think we can use a default InstantiatingHttpJsonChannelProvider.

Switched to this approach.

blakeli0 · 2026-09-18T17:19:20Z

+                    .setTransportToken(
+                        GaxHttpJsonProperties.getHttpJsonTokenName(),
+                        GaxHttpJsonProperties.getHttpJsonVersion())
+                    .setQuotaProjectIdToken(settings.getQuotaProjectId())


quotaProjectId is also handled in ClientContext, we don't have to set it here.

blakeli0 · 2026-09-18T17:21:35Z

+      uploadMediaCallable;
+
+  public static HttpJsonResumableUploadServiceResumableUploadStub create(
+      ClientContext clientContext, ResumableUploadServiceStubSettings settings) throws IOException {


Do we still need to pass clientContext in if we are always recreating it from settings? I think we can use info from settings to determine if the setting is for grpc or httpjson.

I had intended that create would operate only on settings on the last round but clearly didn't get all the way there - apologies for the churn.

Now using only settings, withsettings.getTransportChannelProvider().getTransportName().equals(HttpJsonTransportChannel.getHttpJsonTransportName()) as the condition to determine whether we need to derive the ClientContext from gRPC.

Adds generator support for protocol-specific resumable upload options, independent of any transport stub wiring: - Emit ResumableUploadCallSettings on the generated <Service>Settings and <Service>StubSettings, populated with global timeouts extracted from the service config while bypassing standard unary retries. - Add HttpJsonServiceResumableUploadStubClassComposer, which generates the dedicated REST stub (HttpJson[Service]ResumableUploadStub) for services containing resumable upload RPC methods. - Extract HttpJsonDescriptorComposer out of HttpJsonServiceStubClassComposer and add path prefix support. Pure refactor with no golden changes, reused by the upload stub composer above. Supersedes #14318 and #14320, which are folded in here.

sonarqubecloud · 2026-09-18T18:29:51Z

Quality Gate passed for 'gapic-generator-java-root'

Issues
10 New issues
0 Accepted issues

Measures
0 Security Hotspots
96.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-09-18T18:31:04Z

Quality Gate passed for 'gapic-generator-java-root'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

blakeli0 · 2026-09-18T19:57:08Z

+        settings
+            .toBuilder()
+            .setHttpJsonInternalHeaderProvider(
+                ApiClientHeaderProvider.newBuilder()


Not in this PR: There might be a better way to do this without exposing a protected method. Or at least share the same generation code as the defaultHttpJsonHeaderProvider.

whowes added this pull request to stack #14327 September 9, 2026 06:35

This comment was marked as outdated.

Sign in to view

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from f246196 to 1885bb8 Compare September 9, 2026 15:50

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from 1885bb8 to 542f6e7 Compare September 9, 2026 20:16

whowes removed this pull request from stack #14327 September 9, 2026 23:45

whowes added this pull request to stack #14343 September 9, 2026 23:47

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from 542f6e7 to 6f00489 Compare September 9, 2026 23:51

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from 6f00489 to 296ed15 Compare September 10, 2026 00:19

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from 296ed15 to bbc408e Compare September 10, 2026 01:15

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from bbc408e to c8c1e06 Compare September 10, 2026 06:05

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from c8c1e06 to c41b295 Compare September 11, 2026 17:24

whowes removed this pull request from stack #14343 September 11, 2026 17:25

whowes added this pull request to stack #14363 September 11, 2026 17:25

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from c41b295 to 63a3b57 Compare September 11, 2026 18:30

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from 63a3b57 to f014476 Compare September 11, 2026 20:00

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from f014476 to 46d6fdf Compare September 11, 2026 21:14

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from 46d6fdf to 2525926 Compare September 11, 2026 21:39

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from 2525926 to 2f42f31 Compare September 11, 2026 22:15

whowes changed the base branch from whowes/generator-rest-composer-helpers to main September 15, 2026 16:45

whowes changed the title ~~feat(generator): add HttpJsonServiceResumableUploadStubClassComposer~~ feat(generator): emit resumable upload settings and HttpJson upload stub Sep 15, 2026

whowes added this pull request to stack #14390 September 15, 2026 16:48

blakeli0 reviewed Sep 15, 2026

View reviewed changes

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch 3 times, most recently from 57daa1f to 954089e Compare September 16, 2026 00:45

blakeli0 reviewed Sep 16, 2026

View reviewed changes

Comment thread ...nerator/gapic/composer/rest/goldens/HttpJsonResumableUploadServiceResumableUploadStub.golden Outdated

Comment thread ...c/test/java/com/google/api/generator/gapic/composer/rest/HttpJsonDescriptorComposerTest.java Outdated

blakeli0 reviewed Sep 16, 2026

View reviewed changes

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from 954089e to 5821e21 Compare September 16, 2026 05:46

This was referenced Sep 16, 2026

feat(generator): wire transport stub delegation to resumable upload stubs #14322

Open

[PROTOTYPE] add ClientContext.createWithTransport #14412

Closed

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch 3 times, most recently from c7cffbf to 82fe151 Compare September 18, 2026 15:03

whowes marked this pull request as ready for review September 18, 2026 15:07

whowes requested review from a team as code owners September 18, 2026 15:07

whowes requested a review from blakeli0 September 18, 2026 15:07

blakeli0 reviewed Sep 18, 2026

View reviewed changes

whowes force-pushed the whowes/generator-resumable-upload-stub-composer branch from 82fe151 to 1dee45d Compare September 18, 2026 18:17

blakeli0 reviewed Sep 18, 2026

View reviewed changes

blakeli0 approved these changes Sep 18, 2026

View reviewed changes

whowes requested a review from blakeli0 September 18, 2026 20:00

whowes merged commit c122474 into main Sep 18, 2026
306 of 310 checks passed

whowes deleted the whowes/generator-resumable-upload-stub-composer branch September 18, 2026 22:20

Conversation

whowes commented Sep 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

whowes Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Sep 18, 2026

Quality Gate passed for 'gapic-generator-java-root'

Uh oh!

sonarqubecloud Bot commented Sep 18, 2026

Quality Gate passed for 'gapic-generator-java-root'

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

whowes commented Sep 9, 2026 •

edited

Loading

whowes Sep 17, 2026 •

edited

Loading