java doc

Signed-off-by: Aman Khare <[email protected]>

server/src/main/java/org/opensearch/gateway/TransportNodesListGatewayStartedShardsBatch.java

@@ -256,6 +256,13 @@ public void writeTo(StreamOutput out) throws IOException {
         }
     }
 
+    /**
+     * Primary shard response from node. It contains the metadata in
+     * {@link TransportNodesGatewayStartedShardHelper.GatewayStartedShard} and any exception thrown from code will be
+     * stored in transportError. This exception is stored specifically to disambiguate the store related exceptions
+     * present in {@link TransportNodesGatewayStartedShardHelper.GatewayStartedShard} as those exceptions may be used
+     * during decision-making.
+     */
     public static class GatewayStartedShard {
         private final TransportNodesGatewayStartedShardHelper.GatewayStartedShard gatewayStartedShard;
         private final Exception transportError;