Add javadoc for ConnectorSplit#isRemotelyAccessible

trinodb · Jul 21, 2022 · 6461915 · 6461915
1 parent 8c319ac
commit 6461915
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/core/trino-spi/src/main/java/io/trino/spi/connector/ConnectorSplit.java b/core/trino-spi/src/main/java/io/trino/spi/connector/ConnectorSplit.java
@@ -20,6 +20,13 @@
 
 public interface ConnectorSplit
 {
+    /**
+     * Returns true when this ConnectorSplit can be scheduled on any node.
+     * <p>
+     * When true, the addresses returned by {@link #getAddresses()} may be used as hints by the scheduler
+     * during splits assignment.
+     * When false, the split will always be scheduled on one of the addresses returned by {@link #getAddresses()}.
+     */
     boolean isRemotelyAccessible();
 
     List<HostAddress> getAddresses();