feat(generator): emit callable getter and convenience method for resumable upload RPCs

- In AbstractServiceClientClassComposer: emit public ResumableUploadCallable<RequestT, ResponseT> [method]Callable() delegating to stub
- In AbstractServiceClientClassComposer: emit synchronous convenience method [method](RequestT request, InputStream payload) calling ApiExceptions.callAndTranslateApiException
- Suppress method variants (flattened methods) for resumable upload RPCs
- In ServiceClientCommentComposer: emit Javadoc call context override warning on both callable method and synchronous convenience method
- Cover the generated client and its samples with ResumableUploadServiceClient.golden and the resumableuploadserviceclient sample goldens

Author: whowes

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java

@@ -33,13 +33,22 @@
 import java.util.Optional;
 import java.util.stream.Collectors;
 import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 @NullMarked
 public class ServiceClientCommentComposer {
   // Tokens.
   private static final String EMPTY_STRING = "";
   private static final String API_EXCEPTION_TYPE_NAME = "com.google.api.gax.rpc.ApiException";
   private static final String EXCEPTION_CONDITION = "if the remote call fails";
+  private static final String REQUEST_PARAM_NAME = "request";
+  private static final String REQUEST_PARAM_DESCRIPTION =
+      "The request object containing all of the parameters for the API call.";
+  private static final String PAYLOAD_PARAM_NAME = "payload";
+  private static final String PAYLOAD_PARAM_DESCRIPTION = "The payload data stream to upload.";
+  private static final String CALL_SETTINGS_PARAM_NAME = "callSettings";
+  private static final String CALL_SETTINGS_PARAM_DESCRIPTION =
+      "The call settings to apply to this upload, or null to use defaults.";
 
   // Constants.
   private static final String SERVICE_DESCRIPTION_INTRO_STRING =
@@ -105,9 +114,9 @@ public static List<CommentStatement> createClassHeaderComments(
       String classMethodSampleCode,
       String credentialsSampleCode,
       String endpointSampleCode,
-      String transportSampleCode,
-      String primaryTransport,
-      String secondaryTransport) {
+      @Nullable String transportSampleCode,
+      @Nullable String primaryTransport,
+      @Nullable String secondaryTransport) {
     JavaDocComment.Builder classHeaderJavadocBuilder = JavaDocComment.builder();
     if (service.hasDescription()) {
       String descriptionComment =
@@ -187,14 +196,13 @@ public static List<CommentStatement> createRpcMethodHeaderComment(
       methodJavadocBuilder = methodJavadocBuilder.addUnescapedComment(descriptionComment);
     }
 
-    if (sampleCodeOpt.isPresent()) {
+    if (sampleCodeOpt.isPresent() && !method.isResumableUpload()) {
       methodJavadocBuilder.addParagraph(METHOD_DESCRIPTION_SAMPLE_CODE_SUMMARY_STRING);
       methodJavadocBuilder.addSampleCode(sampleCodeOpt.get());
     }
 
     if (methodArguments.isEmpty()) {
-      methodJavadocBuilder.addParam(
-          "request", "The request object containing all of the parameters for the API call.");
+      methodJavadocBuilder.addParam(REQUEST_PARAM_NAME, REQUEST_PARAM_DESCRIPTION);
     } else {
       for (MethodArgument argument : methodArguments) {
         // TODO(miraleung): Remove the newline replacement when we support CommonMark.
@@ -204,6 +212,11 @@ public static List<CommentStatement> createRpcMethodHeaderComment(
       }
     }
 
+    if (method.isResumableUpload()) {
+      methodJavadocBuilder.addParam(PAYLOAD_PARAM_NAME, PAYLOAD_PARAM_DESCRIPTION);
+      methodJavadocBuilder.addParam(CALL_SETTINGS_PARAM_NAME, CALL_SETTINGS_PARAM_DESCRIPTION);
+    }
+
     methodJavadocBuilder.setThrows(API_EXCEPTION_TYPE_NAME, EXCEPTION_CONDITION);
 
     if (method.isDeprecated()) {
@@ -348,8 +361,8 @@ public static List<CommentStatement> createRpcCallableMethodHeaderComment(
       methodJavadocBuilder = methodJavadocBuilder.addUnescapedComment(descriptionComment);
     }
 
-    methodJavadocBuilder.addParagraph(METHOD_DESCRIPTION_SAMPLE_CODE_SUMMARY_STRING);
-    if (sampleCodeOpt.isPresent()) {
+    if (sampleCodeOpt.isPresent() && !method.isResumableUpload()) {
+      methodJavadocBuilder.addParagraph(METHOD_DESCRIPTION_SAMPLE_CODE_SUMMARY_STRING);
       methodJavadocBuilder.addSampleCode(sampleCodeOpt.get());
     }
 

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceClientClassComposer.java

@@ -24,10 +24,13 @@
 import com.google.api.gax.paging.AbstractFixedSizeCollection;
 import com.google.api.gax.paging.AbstractPage;
 import com.google.api.gax.paging.AbstractPagedListResponse;
+import com.google.api.gax.rpc.ApiExceptions;
 import com.google.api.gax.rpc.BidiStreamingCallable;
 import com.google.api.gax.rpc.ClientStreamingCallable;
 import com.google.api.gax.rpc.OperationCallable;
 import com.google.api.gax.rpc.PageContext;
+import com.google.api.gax.rpc.ResumableUploadCallSettings;
+import com.google.api.gax.rpc.ResumableUploadCallable;
 import com.google.api.gax.rpc.ServerStreamingCallable;
 import com.google.api.gax.rpc.UnaryCallable;
 import com.google.api.generator.engine.ast.AnnotationNode;
@@ -88,6 +91,7 @@
 import com.google.longrunning.Operation;
 import com.google.rpc.Status;
 import java.io.IOException;
+import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -109,6 +113,7 @@ public abstract class AbstractServiceClientClassComposer implements ClassCompose
   private static final String CALLABLE_NAME_PATTERN = "%sCallable";
   private static final String PAGED_CALLABLE_NAME_PATTERN = "%sPagedCallable";
   private static final String OPERATION_CALLABLE_NAME_PATTERN = "%sOperationCallable";
+  private static final String REQUEST_VAR_NAME = "request";
 
   private static final Reference LIST_REFERENCE = ConcreteReference.withClazz(List.class);
   private static final Reference MAP_REFERENCE = ConcreteReference.withClazz(Map.class);
@@ -650,42 +655,46 @@ private static List<MethodDefinition> createServiceMethods(
         methodVariantsForClientHeader.put(method.name(), new ArrayList<>());
       }
       if (method.stream().equals(Stream.NONE)) {
-        List<MethodDefinition> generatedMethods =
-            createMethodVariants(
-                method,
-                ClassNames.getServiceClientClassName(service),
-                messageTypes,
-                typeStore,
-                resourceNames,
-                samples,
-                service);
-
-        // Collect data for gapic_metadata.json.
-        grpcRpcToJavaMethodMetadata
-            .get(method.name())
-            .addAll(
-                generatedMethods.stream()
-                    .map(m -> javaMethodNameFn.apply(m))
-                    .collect(Collectors.toList()));
-
-        // Collect data for Client header
-        methodVariantsForClientHeader
-            .get(method.name())
-            .addAll(
-                generatedMethods.stream()
-                    .map(AbstractServiceClientClassComposer::getJavaMethod)
-                    .collect(Collectors.toList()));
-        javaMethods.addAll(generatedMethods);
+        if (!method.isResumableUpload()) {
+          List<MethodDefinition> generatedMethods =
+              createMethodVariants(
+                  method,
+                  ClassNames.getServiceClientClassName(service),
+                  messageTypes,
+                  typeStore,
+                  resourceNames,
+                  samples,
+                  service);
+
+          // Collect data for gapic_metadata.json.
+          grpcRpcToJavaMethodMetadata
+              .get(method.name())
+              .addAll(
+                  generatedMethods.stream()
+                      .map(m -> javaMethodNameFn.apply(m))
+                      .collect(Collectors.toList()));
+
+          // Collect data for Client header
+          methodVariantsForClientHeader
+              .get(method.name())
+              .addAll(
+                  generatedMethods.stream()
+                      .map(AbstractServiceClientClassComposer::getJavaMethod)
+                      .collect(Collectors.toList()));
+          javaMethods.addAll(generatedMethods);
+        }
 
         MethodDefinition generatedMethod =
-            createMethodDefaultMethod(
-                method,
-                ClassNames.getServiceClientClassName(service),
-                messageTypes,
-                typeStore,
-                resourceNames,
-                samples,
-                service);
+            method.isResumableUpload()
+                ? createResumableUploadDefaultMethod(method, typeStore)
+                : createMethodDefaultMethod(
+                    method,
+                    ClassNames.getServiceClientClassName(service),
+                    messageTypes,
+                    typeStore,
+                    resourceNames,
+                    samples,
+                    service);
 
         // Collect data for gapic_metadata.json and client header.
         grpcRpcToJavaMethodMetadata.get(method.name()).add(javaMethodNameFn.apply(generatedMethod));
@@ -778,7 +787,8 @@ private static List<MethodDefinition> createMethodVariants(
       // Request proto builder.
       VariableExpr requestVarExpr =
           VariableExpr.builder()
-              .setVariable(Variable.builder().setName("request").setType(methodInputType).build())
+              .setVariable(
+                  Variable.builder().setName(REQUEST_VAR_NAME).setType(methodInputType).build())
               .setIsDecl(true)
               .build();
 
@@ -873,7 +883,8 @@ private static MethodDefinition createMethodDefaultMethod(
     // Construct the method that accepts a request proto.
     VariableExpr requestArgVarExpr =
         VariableExpr.builder()
-            .setVariable(Variable.builder().setName("request").setType(methodInputType).build())
+            .setVariable(
+                Variable.builder().setName(REQUEST_VAR_NAME).setType(methodInputType).build())
             .setIsDecl(true)
             .build();
     String callableMethodName =
@@ -885,9 +896,8 @@ private static MethodDefinition createMethodDefaultMethod(
     }
 
     Optional<Sample> defaultMethodSample =
-        Optional.of(
-            ServiceClientMethodSampleComposer.composeCanonicalSample(
-                method, typeStore.get(clientName), resourceNames, messageTypes, service));
+        ServiceClientMethodSampleComposer.composeCanonicalSample(
+            method, typeStore.get(clientName), resourceNames, messageTypes, service);
     Optional<String> defaultMethodDocSample = Optional.empty();
     if (defaultMethodSample.isPresent()) {
       samples.add(defaultMethodSample.get());
@@ -914,14 +924,98 @@ private static MethodDefinition createMethodDefaultMethod(
             .setName(String.format(method.hasLro() ? "%sAsync" : "%s", methodName))
             .setArguments(Arrays.asList(requestArgVarExpr));
 
+    if (method.hasLro()) {
+      methodBuilder =
+          methodBuilder.setReturnExpr(callableMethodExpr).setReturnType(methodOutputType);
+    } else {
+      if (isProtoEmptyType(methodOutputType)) {
+        methodBuilder =
+            methodBuilder
+                .setBody(Arrays.asList(ExprStatement.withExpr(callableMethodExpr)))
+                .setReturnType(TypeNode.VOID);
+      } else {
+        methodBuilder =
+            methodBuilder.setReturnExpr(callableMethodExpr).setReturnType(methodOutputType);
+      }
+    }
+
+    methodBuilder.setAnnotations(createMethodAnnotations(method, typeStore));
+    return methodBuilder.build();
+  }
+
+  private static MethodDefinition createResumableUploadDefaultMethod(
+      Method method, TypeStore typeStore) {
+    String methodName = JavaStyle.toLowerCamelCase(method.name());
+    TypeNode methodInputType = method.inputType();
+    TypeNode methodOutputType = method.outputType();
+
+    VariableExpr requestArgVarExpr =
+        VariableExpr.builder()
+            .setVariable(
+                Variable.builder().setName(REQUEST_VAR_NAME).setType(methodInputType).build())
+            .setIsDecl(true)
+            .build();
+    VariableExpr payloadArgVarExpr =
+        VariableExpr.builder()
+            .setVariable(
+                Variable.builder().setName("payload").setType(typeStore.get("InputStream")).build())
+            .setIsDecl(true)
+            .build();
+    VariableExpr callSettingsArgVarExpr =
+        VariableExpr.builder()
+            .setVariable(
+                Variable.builder()
+                    .setName("callSettings")
+                    .setType(
+                        TypeNode.withReference(
+                            typeStore
+                                .get("ResumableUploadCallSettings")
+                                .reference()
+                                .copyAndSetNullable(true)))
+                    .build())
+            .setIsDecl(true)
+            .build();
+
+    String callableMethodName = String.format(CALLABLE_NAME_PATTERN, methodName);
+    MethodInvocationExpr callableMethodExpr =
+        MethodInvocationExpr.builder().setMethodName(callableMethodName).build();
+    MethodInvocationExpr futureCallExpr =
+        MethodInvocationExpr.builder()
+            .setExprReferenceExpr(callableMethodExpr)
+            .setMethodName("futureCall")
+            .setArguments(
+                Arrays.asList(
+                    requestArgVarExpr.toBuilder().setIsDecl(false).build(),
+                    payloadArgVarExpr.toBuilder().setIsDecl(false).build(),
+                    callSettingsArgVarExpr.toBuilder().setIsDecl(false).build()))
+            .build();
+
+    MethodInvocationExpr callAndTranslateExpr =
+        MethodInvocationExpr.builder()
+            .setStaticReferenceType(typeStore.get("ApiExceptions"))
+            .setMethodName("callAndTranslateApiException")
+            .setArguments(Arrays.asList(futureCallExpr))
+            .setReturnType(methodOutputType)
+            .build();
+
+    MethodDefinition.Builder methodBuilder =
+        MethodDefinition.builder()
+            .setHeaderCommentStatements(
+                ServiceClientCommentComposer.createRpcMethodHeaderComment(method, Optional.empty()))
+            .setScope(ScopeNode.PUBLIC)
+            .setIsFinal(true)
+            .setName(methodName)
+            .setArguments(
+                Arrays.asList(requestArgVarExpr, payloadArgVarExpr, callSettingsArgVarExpr));
+
     if (isProtoEmptyType(methodOutputType)) {
       methodBuilder =
           methodBuilder
-              .setBody(Arrays.asList(ExprStatement.withExpr(callableMethodExpr)))
+              .setBody(Arrays.asList(ExprStatement.withExpr(callAndTranslateExpr)))
               .setReturnType(TypeNode.VOID);
     } else {
       methodBuilder =
-          methodBuilder.setReturnExpr(callableMethodExpr).setReturnType(methodOutputType);
+          methodBuilder.setReturnExpr(callAndTranslateExpr).setReturnType(methodOutputType);
     }
 
     methodBuilder.setAnnotations(createMethodAnnotations(method, typeStore));
@@ -992,7 +1086,9 @@ private static MethodDefinition createCallableMethod(
         case NONE:
         // Fall through.
         default:
-          rawCallableReturnType = typeStore.get("UnaryCallable");
+          rawCallableReturnType =
+              typeStore.get(
+                  method.isResumableUpload() ? "ResumableUploadCallable" : "UnaryCallable");
       }
     }
 
@@ -1038,13 +1134,12 @@ private static MethodDefinition createCallableMethod(
     } else if (callableMethodKind.equals(CallableMethodKind.REGULAR)) {
       if (method.stream().equals(Stream.NONE)) {
         sampleCode =
-            Optional.of(
-                ServiceClientCallableMethodSampleComposer.composeRegularCallableMethod(
-                    method,
-                    typeStore.get(ClassNames.getServiceClientClassName(service)),
-                    resourceNames,
-                    messageTypes,
-                    service));
+            ServiceClientCallableMethodSampleComposer.composeRegularCallableMethod(
+                method,
+                typeStore.get(ClassNames.getServiceClientClassName(service)),
+                resourceNames,
+                messageTypes,
+                service);
       } else {
         sampleCode =
             Optional.of(
@@ -1797,6 +1892,7 @@ private static TypeStore createTypes(Service service, Map<String, Message> messa
     List<Class<?>> concreteClazzes =
         Arrays.asList(
             AbstractPagedListResponse.class,
+            ApiExceptions.class,
             ApiFunction.class,
             ApiFuture.class,
             ApiFutures.class,
@@ -1806,6 +1902,7 @@ private static TypeStore createTypes(Service service, Map<String, Message> messa
             BidiStreamingCallable.class,
             ClientStreamingCallable.class,
             Generated.class,
+            InputStream.class,
             InterruptedException.class,
             IOException.class,
             MoreExecutors.class,
@@ -1814,6 +1911,8 @@ private static TypeStore createTypes(Service service, Map<String, Message> messa
             Operation.class,
             OperationFuture.class,
             OperationCallable.class,
+            ResumableUploadCallSettings.class,
+            ResumableUploadCallable.class,
             ServerStreamingCallable.class,
             Status.class,
             Strings.class,