use consistent naming for poll intermediate-response/result and final response/result

anuchandy · anuchandy · commit 8ad1ea72da4b · 2025-04-24T18:03:57.000-07:00
diff --git a/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/extension/plugin/PollingSettings.java b/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/extension/plugin/PollingSettings.java
@@ -15,20 +15,25 @@
 public final class PollingSettings implements JsonSerializable<PollingSettings> {
     private String strategy;
     private String syncStrategy;
-    private String intermediateType;
-    private String finalType;
+    private String pollResultType;
+    private String finalResultType;
     private String pollInterval;
 
     public PollingSettings() {
     }
 
     /**
      * The format of the java source code to instantiate a polling strategy class with PollingStrategyOptions argument.
+     * For example, in case of the strategy 'OperationLocationPollingStrategy' class, the code after applying the format
+     * looks like -
+     * new OperationLocationPollingStrategy(new PollingStrategyOptions(...));
      */
     public static final String INSTANTIATE_POLLING_STRATEGY_FORMAT;
     /**
      * The format of the java source code to instantiate a polling strategy class with PollingStrategyOptions and LRO
-     * final result arguments.
+     * final result arguments. For example, in case of the strategy 'OperationLocationPollingStrategy' class, the code
+     * after applying the format looks like -
+     * new OperationLocationPollingStrategy(new PollingStrategyOptions(...), finalResultType);
      */
     public static final String INSTANTIATE_POLLING_STRATEGY_WITH_RESULT_FORMAT;
     private static final String INSTANTIATE_DEFAULT_POLLING_STRATEGY;
@@ -91,17 +96,17 @@ public String getSyncStrategy() {
      *
      * @return The intermediate type for polling.
      */
-    public String getIntermediateType() {
-        return intermediateType;
+    public String getPollResultType() {
+        return pollResultType;
     }
 
     /**
      * Gets the type of the poll response once the long-running operation is completed.
      *
      * @return The final type for polling.
      */
-    public String getFinalType() {
-        return finalType;
+    public String getFinalResultType() {
+        return finalResultType;
     }
 
     /**
@@ -118,8 +123,8 @@ public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         return jsonWriter.writeStartObject()
             .writeStringField("strategy", strategy)
             .writeStringField("sync-strategy", syncStrategy)
-            .writeStringField("intermediate-type", intermediateType)
-            .writeStringField("final-type", finalType)
+            .writeStringField("intermediate-type", pollResultType)
+            .writeStringField("final-type", finalResultType)
             .writeStringField("poll-interval", pollInterval)
             .writeEndObject();
     }
@@ -144,9 +149,9 @@ public static PollingSettings fromJson(JsonReader jsonReader) throws IOException
                 } else if ("sync-strategy".equals(fieldName)) {
                     pollingSettings.syncStrategy = reader.getString();
                 } else if ("intermediate-type".equals(fieldName)) {
-                    pollingSettings.intermediateType = reader.getString();
+                    pollingSettings.pollResultType = reader.getString();
                 } else if ("final-type".equals(fieldName)) {
-                    pollingSettings.finalType = reader.getString();
+                    pollingSettings.finalResultType = reader.getString();
                 } else if ("poll-interval".equals(fieldName)) {
                     pollingSettings.pollInterval = reader.getString();
                 } else {
diff --git a/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ClientMethodMapper.java b/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ClientMethodMapper.java
@@ -379,8 +379,7 @@ private List<ClientMethod> createClientMethods(Operation operation, boolean isPr
                         }
                     }
 
-                    PollingSettings pollingSettings = settings.getPollingSettings(proxyMethod.getOperationId());
-
+                    final PollingSettings pollingSettings = settings.getPollingSettings(proxyMethod.getOperationId());
                     MethodPollingDetails methodPollingDetails = null;
                     MethodPollingDetails dpgMethodPollingDetailsWithModel = null;   // for additional LRO methods
 
@@ -395,34 +394,34 @@ private List<ClientMethod> createClientMethods(Operation operation, boolean isPr
                             methodPollingDetails
                                 = new MethodPollingDetails(pollingSettings.getStrategy(),
                                     pollingSettings.getSyncStrategy(),
-                                    getPollingIntermediateType(pollingSettings, syncReturnType),
-                                    getPollingFinalType(pollingSettings, syncReturnType,
+                                    getPollResultType(pollingSettings, syncReturnType),
+                                    getPollingFinalResultType(pollingSettings, syncReturnType,
                                         MethodUtil.getHttpMethod(operation)),
                                     pollingSettings.getPollIntervalInSeconds());
                         }
                     }
 
                     if (methodPollingDetails != null && isProtocolMethod
                     // models of LRO configured
-                        && !(ClassType.BINARY_DATA.equals(methodPollingDetails.getIntermediateType())
-                            && (ClassType.BINARY_DATA.equals(methodPollingDetails.getFinalType())
-                                || ClassType.VOID.equals(methodPollingDetails.getFinalType().asNullable())))) {
+                        && !(ClassType.BINARY_DATA.equals(methodPollingDetails.getPollResultType())
+                            && (ClassType.BINARY_DATA.equals(methodPollingDetails.getFinalResultType())
+                                || ClassType.VOID.equals(methodPollingDetails.getFinalResultType().asNullable())))) {
 
                         // a new method to be added as implementation only (not exposed to client) for developer
                         dpgMethodPollingDetailsWithModel = methodPollingDetails;
 
                         // keep consistency with DPG from Swagger, see getPollingFinalType
-                        IType resultType = ClassType.BINARY_DATA;
+                        IType finalResultType = ClassType.BINARY_DATA;
                         // DELETE would not have final response as resource is deleted
                         if (MethodUtil.getHttpMethod(operation) == HttpMethod.DELETE) {
-                            resultType = PrimitiveType.VOID;
+                            finalResultType = PrimitiveType.VOID;
                         }
 
                         // DPG keep the method with BinaryData
                         methodPollingDetails
                             = new MethodPollingDetails(dpgMethodPollingDetailsWithModel.getPollingStrategy(),
                                 dpgMethodPollingDetailsWithModel.getSyncPollingStrategy(), ClassType.BINARY_DATA,
-                                resultType, dpgMethodPollingDetailsWithModel.getPollIntervalInSeconds());
+                                finalResultType, dpgMethodPollingDetailsWithModel.getPollIntervalInSeconds());
                     }
 
                     final ClientMethod lroBaseMethod
@@ -1047,28 +1046,29 @@ protected void addClientMethodWithContext(List<ClientMethod> methods, ClientMeth
         methods.add(withContextMethod);
     }
 
-    private IType getPollingIntermediateType(PollingSettings pollingSettings, IType syncReturnType) {
+    private IType getPollResultType(PollingSettings pollingSettings, IType syncReturnType) {
         assert pollingSettings != null;
 
         if (JavaSettings.getInstance().isFluent()) {
             return syncReturnType.asNullable();
         }
 
-        final IType intermediateResponseType;
-        if (pollingSettings.getIntermediateType() != null) {
-            intermediateResponseType = createTypeFromModelName(pollingSettings.getIntermediateType());
+        final IType pollResultType;
+        if (pollingSettings.getPollResultType() != null) {
+            pollResultType = createTypeFromModelName(pollingSettings.getPollResultType());
         } else {
-            intermediateResponseType = syncReturnType.asNullable();
+            pollResultType = syncReturnType.asNullable();
         }
-        if (intermediateResponseType.asNullable() == ClassType.VOID) {
+        if (pollResultType.asNullable() == ClassType.VOID) {
             // azure-core wants poll response to be non-null
             return ClassType.BINARY_DATA;
         } else {
-            return intermediateResponseType;
+            return pollResultType;
         }
     }
 
-    private IType getPollingFinalType(PollingSettings pollingSettings, IType syncReturnType, HttpMethod httpMethod) {
+    private IType getPollingFinalResultType(PollingSettings pollingSettings, IType syncReturnType,
+        HttpMethod httpMethod) {
         assert pollingSettings != null;
 
         if (JavaSettings.getInstance().isFluent()) {
@@ -1080,17 +1080,17 @@ private IType getPollingFinalType(PollingSettings pollingSettings, IType syncRet
             return PrimitiveType.VOID;
         }
 
-        final IType finalResponseType;
-        if (pollingSettings.getFinalType() != null) {
-            finalResponseType = createTypeFromModelName(pollingSettings.getFinalType());
+        final IType finalResultType;
+        if (pollingSettings.getFinalResultType() != null) {
+            finalResultType = createTypeFromModelName(pollingSettings.getFinalResultType());
         } else {
-            finalResponseType = syncReturnType.asNullable();
+            finalResultType = syncReturnType.asNullable();
         }
-        if (finalResponseType.asNullable() == ClassType.VOID) {
+        if (finalResultType.asNullable() == ClassType.VOID) {
             // azure-core wants poll response to be non-null
             return ClassType.BINARY_DATA;
         } else {
-            return finalResponseType;
+            return finalResultType;
         }
     }
 
@@ -1111,22 +1111,22 @@ private static MethodPollingDetails methodPollingDetailsFromMetadata(Operation o
         // Step_1: Resolve LRO intermediate and final response types.
         //
         ObjectMapper objectMapper = Mappers.getObjectMapper();
-        final IType intermediateType;
-        if (pollingSettings.getIntermediateType() != null) {
+        final IType pollResultType;
+        if (pollingSettings.getPollResultType() != null) {
             // pollingSettings would take precedence over 'LongRunningMetadata'
-            intermediateType = createTypeFromModelName(pollingSettings.getIntermediateType());
+            pollResultType = createTypeFromModelName(pollingSettings.getPollResultType());
         } else {
-            intermediateType = objectMapper.map(metadata.getPollResultType());
+            pollResultType = objectMapper.map(metadata.getPollResultType());
         }
 
-        final IType finalType;
-        if (pollingSettings.getFinalType() != null) {
-            finalType = createTypeFromModelName(pollingSettings.getFinalType());
+        final IType finalResultType;
+        if (pollingSettings.getFinalResultType() != null) {
+            finalResultType = createTypeFromModelName(pollingSettings.getFinalResultType());
         } else {
             if (metadata.getFinalResultType() == null) {
-                finalType = PrimitiveType.VOID;
+                finalResultType = PrimitiveType.VOID;
             } else {
-                finalType = objectMapper.map(metadata.getFinalResultType());
+                finalResultType = objectMapper.map(metadata.getFinalResultType());
             }
         }
 
@@ -1158,7 +1158,7 @@ private static MethodPollingDetails methodPollingDetailsFromMetadata(Operation o
             syncPollingStrategy = pollingSettings.getSyncStrategy();
         }
 
-        return new MethodPollingDetails(pollingStrategy, syncPollingStrategy, intermediateType, finalType,
+        return new MethodPollingDetails(pollingStrategy, syncPollingStrategy, pollResultType, finalResultType,
             pollingSettings.getPollIntervalInSeconds());
     }
 
diff --git a/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ClientMethodsReturnDescription.java b/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ClientMethodsReturnDescription.java
@@ -231,19 +231,19 @@ public ReturnValue getReturnValue(ClientMethodType methodType, MethodPollingDeta
                         syncReturnType.asNullable());
                     return createReturnValue(returnType, syncReturnType);
                 } else {
-                    IType returnType
-                        = GenericType.SyncPoller(pollingDetails.getIntermediateType(), pollingDetails.getFinalType());
-                    return createReturnValue(returnType, pollingDetails.getFinalType());
+                    IType returnType = GenericType.SyncPoller(pollingDetails.getPollResultType(),
+                        pollingDetails.getFinalResultType());
+                    return createReturnValue(returnType, pollingDetails.getFinalResultType());
                 }
             case LongRunningBeginAsync:
                 if (settings.isFluent()) {
                     IType returnType = GenericType.PollerFlux(GenericType.PollResult(syncReturnType.asNullable()),
                         syncReturnType.asNullable());
                     return createReturnValue(returnType, syncReturnType);
                 } else {
-                    IType returnType
-                        = GenericType.PollerFlux(pollingDetails.getIntermediateType(), pollingDetails.getFinalType());
-                    return createReturnValue(returnType, pollingDetails.getFinalType());
+                    IType returnType = GenericType.PollerFlux(pollingDetails.getPollResultType(),
+                        pollingDetails.getFinalResultType());
+                    return createReturnValue(returnType, pollingDetails.getFinalResultType());
                 }
             default:
                 throw new IllegalArgumentException("Unsupported method type: " + methodType
diff --git a/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/model/clientmodel/MethodPollingDetails.java b/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/model/clientmodel/MethodPollingDetails.java
@@ -6,16 +6,16 @@
 public class MethodPollingDetails {
     private final String pollingStrategy;
     private final String syncPollingStrategy;
-    private final IType intermediateType;
-    private final IType finalType;
+    private final IType pollResultType;
+    private final IType finalResultType;
     private final int pollIntervalInSeconds;
 
-    public MethodPollingDetails(String pollingStrategy, String syncPollingStrategy, IType intermediateType,
-        IType finalType, int pollIntervalInSeconds) {
+    public MethodPollingDetails(String pollingStrategy, String syncPollingStrategy, IType pollResultType,
+        IType finalResultType, int pollIntervalInSeconds) {
         this.pollingStrategy = pollingStrategy;
         this.syncPollingStrategy = syncPollingStrategy;
-        this.intermediateType = intermediateType;
-        this.finalType = finalType;
+        this.pollResultType = pollResultType;
+        this.finalResultType = finalResultType;
         this.pollIntervalInSeconds = pollIntervalInSeconds;
     }
 
@@ -27,12 +27,12 @@ public String getSyncPollingStrategy() {
         return syncPollingStrategy;
     }
 
-    public IType getIntermediateType() {
-        return intermediateType;
+    public IType getPollResultType() {
+        return pollResultType;
     }
 
-    public IType getFinalType() {
-        return finalType;
+    public IType getFinalResultType() {
+        return finalResultType;
     }
 
     public int getPollIntervalInSeconds() {
diff --git a/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/template/ClientMethodTemplate.java b/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/template/ClientMethodTemplate.java
@@ -1769,8 +1769,8 @@ private String getPollingStrategy(ClientMethod clientMethod, String contextParam
             .replace("{context}", contextParam)
             .replace("{serviceVersion}", getServiceVersionValue(clientMethod))
             .replace("{serializerAdapter}", clientMethod.getClientReference() + ".getSerializerAdapter()")
-            .replace("{intermediate-type}", clientMethod.getMethodPollingDetails().getIntermediateType().toString())
-            .replace("{final-type}", clientMethod.getMethodPollingDetails().getFinalType().toString())
+            .replace("{intermediate-type}", clientMethod.getMethodPollingDetails().getPollResultType().toString())
+            .replace("{final-type}", clientMethod.getMethodPollingDetails().getFinalResultType().toString())
             .replace(".setServiceVersion(null)", "")
             .replace(".setEndpoint(null)", "");
     }
@@ -1808,8 +1808,8 @@ private String getSyncPollingStrategy(ClientMethod clientMethod, String contextP
             .replace("{context}", contextParam)
             .replace("{serviceVersion}", getServiceVersionValue(clientMethod))
             .replace("{serializerAdapter}", clientMethod.getClientReference() + ".getSerializerAdapter()")
-            .replace("{intermediate-type}", clientMethod.getMethodPollingDetails().getIntermediateType().toString())
-            .replace("{final-type}", clientMethod.getMethodPollingDetails().getFinalType().toString())
+            .replace("{intermediate-type}", clientMethod.getMethodPollingDetails().getPollResultType().toString())
+            .replace("{final-type}", clientMethod.getMethodPollingDetails().getFinalResultType().toString())
             .replace(".setServiceVersion(null)", "")
             .replace(".setEndpoint(null)", "");
     }
diff --git a/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/util/TemplateUtil.java b/packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/util/TemplateUtil.java
@@ -144,13 +144,14 @@ public static void writeClientMethodsAndHelpers(JavaClass classBlock, List<Clien
             // getLongRunningOperationTypeReferenceExpression
             if (clientMethod.getType() == ClientMethodType.LongRunningBeginAsync
                 && clientMethod.getMethodPollingDetails() != null) {
-                if (clientMethod.getMethodPollingDetails().getIntermediateType() instanceof GenericType) {
+                if (clientMethod.getMethodPollingDetails().getPollResultType() instanceof GenericType) {
                     typeReferenceStaticClasses
-                        .add((GenericType) clientMethod.getMethodPollingDetails().getIntermediateType());
+                        .add((GenericType) clientMethod.getMethodPollingDetails().getPollResultType());
                 }
 
-                if (clientMethod.getMethodPollingDetails().getFinalType() instanceof GenericType) {
-                    typeReferenceStaticClasses.add((GenericType) clientMethod.getMethodPollingDetails().getFinalType());
+                if (clientMethod.getMethodPollingDetails().getFinalResultType() instanceof GenericType) {
+                    typeReferenceStaticClasses
+                        .add((GenericType) clientMethod.getMethodPollingDetails().getFinalResultType());
                 }
             }
         }
@@ -176,8 +177,8 @@ public static void writeClientMethodsAndHelpers(JavaClass classBlock, List<Clien
      */
     public static String getLongRunningOperationTypeReferenceExpression(MethodPollingDetails details) {
         // see writeTypeReferenceStaticClass
-        return getTypeReferenceCreation(details.getIntermediateType()) + ", "
-            + getTypeReferenceCreation(details.getFinalType());
+        return getTypeReferenceCreation(details.getPollResultType()) + ", "
+            + getTypeReferenceCreation(details.getFinalResultType());
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -144,13 +144,14 @@ public static void writeClientMethodsAndHelpers(JavaClass classBlock, List<Clien`
`144`	`144`	`// getLongRunningOperationTypeReferenceExpression`
`145`	`145`	`if (clientMethod.getType() == ClientMethodType.LongRunningBeginAsync`
`146`	`146`	`&& clientMethod.getMethodPollingDetails() != null) {`
`147`		`- if (clientMethod.getMethodPollingDetails().getIntermediateType() instanceof GenericType) {`
	`147`	`+ if (clientMethod.getMethodPollingDetails().getPollResultType() instanceof GenericType) {`
`148`	`148`	`typeReferenceStaticClasses`
`149`		`- .add((GenericType) clientMethod.getMethodPollingDetails().getIntermediateType());`
	`149`	`+ .add((GenericType) clientMethod.getMethodPollingDetails().getPollResultType());`
`150`	`150`	`}`
`151`	`151`
`152`		`- if (clientMethod.getMethodPollingDetails().getFinalType() instanceof GenericType) {`
`153`		`- typeReferenceStaticClasses.add((GenericType) clientMethod.getMethodPollingDetails().getFinalType());`
	`152`	`+ if (clientMethod.getMethodPollingDetails().getFinalResultType() instanceof GenericType) {`
	`153`	`+ typeReferenceStaticClasses`
	`154`	`+ .add((GenericType) clientMethod.getMethodPollingDetails().getFinalResultType());`
`154`	`155`	`}`
`155`	`156`	`}`
`156`	`157`	`}`
`@@ -176,8 +177,8 @@ public static void writeClientMethodsAndHelpers(JavaClass classBlock, List<Clien`
`176`	`177`	`*/`
`177`	`178`	`public static String getLongRunningOperationTypeReferenceExpression(MethodPollingDetails details) {`
`178`	`179`	`// see writeTypeReferenceStaticClass`
`179`		`- return getTypeReferenceCreation(details.getIntermediateType()) + ", "`
`180`		`- + getTypeReferenceCreation(details.getFinalType());`
	`180`	`+ return getTypeReferenceCreation(details.getPollResultType()) + ", "`
	`181`	`+ + getTypeReferenceCreation(details.getFinalResultType());`
`181`	`182`	`}`
`182`	`183`
`183`	`184`	`/**`