From 68f68444a99a0808338780091d0e00e9f1ab6d06 Mon Sep 17 00:00:00 2001 From: Sean Kao Date: Sat, 22 Jun 2024 10:58:00 -0700 Subject: [PATCH] add javadoc for metadata log service constructor Signed-off-by: Sean Kao --- .../flint/common/metadata/log/FlintMetadataLogService.java | 4 ++++ .../core/metadata/log/FlintMetadataLogServiceBuilder.java | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/flint-commons/src/main/scala/org/opensearch/flint/common/metadata/log/FlintMetadataLogService.java b/flint-commons/src/main/scala/org/opensearch/flint/common/metadata/log/FlintMetadataLogService.java index 4cb1305d2..352f4ecce 100644 --- a/flint-commons/src/main/scala/org/opensearch/flint/common/metadata/log/FlintMetadataLogService.java +++ b/flint-commons/src/main/scala/org/opensearch/flint/common/metadata/log/FlintMetadataLogService.java @@ -10,6 +10,10 @@ /** * Flint metadata log service provides API for metadata log related operations on a Flint index * regardless of underlying storage. + *

+ * Custom implementations of this interface are expected to provide a public constructor with + * the signature {@code public MyCustomService(SparkConf sparkConf)} to be instantiated by + * the FlintMetadataLogServiceBuilder. */ public interface FlintMetadataLogService { diff --git a/flint-core/src/main/scala/org/opensearch/flint/core/metadata/log/FlintMetadataLogServiceBuilder.java b/flint-core/src/main/scala/org/opensearch/flint/core/metadata/log/FlintMetadataLogServiceBuilder.java index 51d049050..9ec4ac2c4 100644 --- a/flint-core/src/main/scala/org/opensearch/flint/core/metadata/log/FlintMetadataLogServiceBuilder.java +++ b/flint-core/src/main/scala/org/opensearch/flint/core/metadata/log/FlintMetadataLogServiceBuilder.java @@ -13,6 +13,10 @@ /** * {@link FlintMetadataLogService} builder. + *

+ * Custom implementations of {@link FlintMetadataLogService} are expected to provide a public + * constructor with the signature {@code public MyCustomService(SparkConf sparkConf)} to be + * instantiated by this builder. */ public class FlintMetadataLogServiceBuilder { public static FlintMetadataLogService build(FlintOptions options, SparkConf sparkConf) {