Add experimental annotations to direct-query and direct-query-core

direct-query-core/src/main/java/org/opensearch/sql/datasource/client/DataSourceClient.java

@@ -8,5 +8,7 @@
 /**
  * Base interface for all data source clients. This interface serves as a marker interface for all
  * client implementations.
+ *
+ * @opensearch.experimental
  */
 public interface DataSourceClient {}

direct-query-core/src/main/java/org/opensearch/sql/datasource/client/DataSourceClientFactory.java

@@ -15,7 +15,11 @@
 import org.opensearch.sql.datasource.model.DataSourceType;
 import org.opensearch.sql.prometheus.utils.PrometheusClientUtils;
 
-/** Factory for creating data source clients based on the data source type. */
+/**
+ * Factory for creating data source clients based on the data source type.
+ *
+ * @opensearch.experimental
+ */
 public class DataSourceClientFactory {
 
   private static final Logger LOG = LogManager.getLogger();

direct-query-core/src/main/java/org/opensearch/sql/datasource/client/exceptions/DataSourceClientException.java

@@ -5,7 +5,11 @@
 
 package org.opensearch.sql.datasource.client.exceptions;
 
-/** Exception thrown when there are issues with data source client operations. */
+/**
+ * Exception thrown when there are issues with data source client operations.
+ *
+ * @opensearch.experimental
+ */
 public class DataSourceClientException extends RuntimeException {
 
   public DataSourceClientException(String message) {

direct-query-core/src/main/java/org/opensearch/sql/datasource/query/QueryHandler.java

@@ -16,6 +16,8 @@
  * Interface for handling queries for specific data source types.
  *
  * @param <T> The client type this handler works with, extending DataSourceClient
+ *
+ * @opensearch.experimental
  */
 public interface QueryHandler<T extends DataSourceClient> {
 

direct-query-core/src/main/java/org/opensearch/sql/datasource/query/QueryHandlerRegistry.java

@@ -10,7 +10,11 @@
 import org.opensearch.common.inject.Inject;
 import org.opensearch.sql.datasource.client.DataSourceClient;
 
-/** Registry for all query handlers. */
+/**
+ * Registry for all query handlers.
+ *
+ * @opensearch.experimental
+ */
 public class QueryHandlerRegistry {
 
   private final List<QueryHandler<?>> handlers;

direct-query-core/src/main/java/org/opensearch/sql/directquery/DirectQueryExecutorService.java

@@ -10,6 +10,9 @@
 import org.opensearch.sql.directquery.rest.model.GetDirectQueryResourcesRequest;
 import org.opensearch.sql.directquery.rest.model.GetDirectQueryResourcesResponse;
 
+/*
+ * @opensearch.experimental
+ */
 public interface DirectQueryExecutorService {
 
   /**

direct-query-core/src/main/java/org/opensearch/sql/directquery/DirectQueryExecutorServiceImpl.java

@@ -17,6 +17,9 @@
 import org.opensearch.sql.directquery.rest.model.GetDirectQueryResourcesRequest;
 import org.opensearch.sql.directquery.rest.model.GetDirectQueryResourcesResponse;
 
+/*
+ * @opensearch.experimental
+ */
 public class DirectQueryExecutorServiceImpl implements DirectQueryExecutorService {
 
   private final DataSourceClientFactory dataSourceClientFactory;

direct-query-core/src/main/java/org/opensearch/sql/directquery/model/DataSourceOptions.java

@@ -5,5 +5,9 @@
 
 package org.opensearch.sql.directquery.model;
 
-/** Interface for data source specific options. */
+/**
+ * Interface for data source specific options.
+ *
+ * @opensearch.experimental
+ */
 public interface DataSourceOptions {}

direct-query-core/src/main/java/org/opensearch/sql/directquery/rest/model/DirectQueryResourceType.java

@@ -5,7 +5,11 @@
 
 package org.opensearch.sql.directquery.rest.model;
 
-/** Enum representing the types of resources that can be queried. */
+/**
+ * Enum representing the types of resources that can be queried.
+ *
+ * @opensearch.experimental
+ */
 public enum DirectQueryResourceType {
   UNKNOWN,
   LABELS,

direct-query-core/src/main/java/org/opensearch/sql/directquery/rest/model/ExecuteDirectQueryRequest.java

@@ -15,6 +15,9 @@
 
 @Data
 @NoArgsConstructor
+/*
+ * @opensearch.experimental
+ */
 public class ExecuteDirectQueryRequest {
   // Required fields
   private String dataSources; // Required: From URI path parameter or request body

direct-query-core/src/main/java/org/opensearch/sql/directquery/rest/model/ExecuteDirectQueryResponse.java

@@ -9,6 +9,9 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
+/*
+ * @opensearch.experimental
+ */
 @Data
 @AllArgsConstructor
 @NoArgsConstructor

direct-query-core/src/main/java/org/opensearch/sql/directquery/rest/model/GetDirectQueryResourcesRequest.java

@@ -9,6 +9,9 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
+/*
+ * @opensearch.experimental
+ */
 @Data
 @NoArgsConstructor
 public class GetDirectQueryResourcesRequest {

direct-query-core/src/main/java/org/opensearch/sql/directquery/rest/model/GetDirectQueryResourcesResponse.java

@@ -19,6 +19,9 @@
 @Data
 @NoArgsConstructor
 @JsonInclude(JsonInclude.Include.NON_NULL)
+/*
+ * @opensearch.experimental
+ */
 public class GetDirectQueryResourcesResponse<T> {
   private T data;
 

direct-query-core/src/main/java/org/opensearch/sql/directquery/validator/DirectQueryRequestValidator.java

@@ -10,6 +10,9 @@
 import org.opensearch.sql.prometheus.model.PrometheusQueryType;
 import org.opensearch.sql.spark.rest.model.LangType;
 
+/*
+ * @opensearch.experimental
+ */
 public class DirectQueryRequestValidator {
   private DirectQueryRequestValidator() {}
 

direct-query-core/src/main/java/org/opensearch/sql/prometheus/client/PrometheusClient.java

@@ -13,6 +13,9 @@
 import org.opensearch.sql.datasource.client.DataSourceClient;
 import org.opensearch.sql.prometheus.model.MetricMetadata;
 
+/*
+ * @opensearch.experimental
+ */
 public interface PrometheusClient extends DataSourceClient {
 
   JSONObject queryRange(String query, Long start, Long end, String step) throws IOException;

direct-query-core/src/main/java/org/opensearch/sql/prometheus/client/PrometheusClientImpl.java

@@ -27,6 +27,9 @@
 import org.json.JSONObject;
 import org.opensearch.sql.prometheus.model.MetricMetadata;
 
+/*
+ * @opensearch.experimental
+ */
 public class PrometheusClientImpl implements PrometheusClient {
 
   private static final Logger logger = LogManager.getLogger(PrometheusClientImpl.class);

direct-query-core/src/main/java/org/opensearch/sql/prometheus/exception/PrometheusClientException.java

@@ -8,6 +8,9 @@
 import org.opensearch.sql.datasource.client.exceptions.DataSourceClientException;
 
 /** PrometheusClientException. */
+/*
+ * @opensearch.experimental
+ */
 public class PrometheusClientException extends DataSourceClientException {
   public PrometheusClientException(String message) {
     super(message);

direct-query-core/src/main/java/org/opensearch/sql/prometheus/model/MetricMetadata.java

@@ -18,6 +18,9 @@
 @NoArgsConstructor
 @EqualsAndHashCode
 @JsonIgnoreProperties(ignoreUnknown = true)
+/*
+ * @opensearch.experimental
+ */
 public class MetricMetadata {
   private String type;
   private String help;

direct-query-core/src/main/java/org/opensearch/sql/prometheus/model/PrometheusOptions.java

@@ -12,6 +12,9 @@
 /** Prometheus-specific options for direct queries. */
 @Data
 @NoArgsConstructor
+/*
+ * @opensearch.experimental
+ */
 public class PrometheusOptions implements DataSourceOptions {
   private PrometheusQueryType queryType;
   private String step; // Duration string in seconds

direct-query-core/src/main/java/org/opensearch/sql/prometheus/model/PrometheusQueryType.java

@@ -9,6 +9,9 @@
 
 /** Enum representing the types of Prometheus queries. */
 @Getter
+/*
+ * @opensearch.experimental
+ */
 public enum PrometheusQueryType {
   INSTANT("instant"),
   RANGE("range");

direct-query-core/src/main/java/org/opensearch/sql/prometheus/query/PrometheusQueryHandler.java

@@ -26,6 +26,9 @@
 import org.opensearch.sql.prometheus.model.PrometheusOptions;
 import org.opensearch.sql.prometheus.model.PrometheusQueryType;
 
+/*
+ * @opensearch.experimental
+ */
 public class PrometheusQueryHandler implements QueryHandler<PrometheusClient> {
   private static final Logger LOG = LogManager.getLogger(PrometheusQueryHandler.class);
 

direct-query-core/src/main/java/org/opensearch/sql/prometheus/utils/PrometheusClientUtils.java

@@ -25,6 +25,9 @@
 import org.opensearch.sql.prometheus.client.PrometheusClient;
 import org.opensearch.sql.prometheus.client.PrometheusClientImpl;
 
+/*
+ * @opensearch.experimental
+ */
 public class PrometheusClientUtils {
   private PrometheusClientUtils() {}
 

direct-query-core/src/test/java/org/opensearch/sql/datasource/client/DataSourceClientFactoryTest.java

@@ -27,6 +27,9 @@
 import org.opensearch.sql.prometheus.client.PrometheusClient;
 import org.opensearch.sql.prometheus.utils.PrometheusClientUtils;
 
+/*
+ * @opensearch.experimental
+ */
 @RunWith(MockitoJUnitRunner.class)
 public class DataSourceClientFactoryTest {
 

direct-query-core/src/test/java/org/opensearch/sql/datasource/query/QueryHandlerRegistryTest.java

@@ -23,6 +23,9 @@
 import org.mockito.junit.jupiter.MockitoExtension;
 import org.opensearch.sql.datasource.client.DataSourceClient;
 
+/*
+ * @opensearch.experimental
+ */
 @DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
 @ExtendWith(MockitoExtension.class)
 public class QueryHandlerRegistryTest {

direct-query-core/src/test/java/org/opensearch/sql/directquery/DirectQueryExecutorServiceImplTest.java

@@ -37,6 +37,9 @@
 import org.opensearch.sql.prometheus.model.PrometheusQueryType;
 import org.opensearch.sql.spark.rest.model.LangType;
 
+/*
+ * @opensearch.experimental
+ */
 @ExtendWith(MockitoExtension.class)
 public class DirectQueryExecutorServiceImplTest {
 

direct-query-core/src/test/java/org/opensearch/sql/directquery/validator/DirectQueryRequestValidatorTest.java

@@ -15,6 +15,9 @@
 import org.opensearch.sql.prometheus.model.PrometheusQueryType;
 import org.opensearch.sql.spark.rest.model.LangType;
 
+/*
+ * @opensearch.experimental
+ */
 public class DirectQueryRequestValidatorTest {
 
   @Test

direct-query-core/src/test/java/org/opensearch/sql/prometheus/client/PrometheusClientImplTest.java

@@ -35,6 +35,9 @@
 import org.junit.jupiter.api.Test;
 import org.opensearch.sql.prometheus.exception.PrometheusClientException;
 
+/*
+ * @opensearch.experimental
+ */
 public class PrometheusClientImplTest {
 
   private MockWebServer mockWebServer;

direct-query-core/src/test/java/org/opensearch/sql/prometheus/query/PrometheusQueryHandlerTest.java

@@ -35,6 +35,9 @@
 import org.opensearch.sql.prometheus.model.PrometheusOptions;
 import org.opensearch.sql.prometheus.model.PrometheusQueryType;
 
+/*
+ * @opensearch.experimental
+ */
 @RunWith(MockitoJUnitRunner.class)
 public class PrometheusQueryHandlerTest {
 

direct-query-core/src/test/java/org/opensearch/sql/prometheus/utils/PrometheusClientUtilsTest.java

@@ -26,6 +26,9 @@
 import org.opensearch.sql.datasource.model.DataSourceMetadata;
 import org.opensearch.sql.prometheus.client.PrometheusClient;
 
+/*
+ * @opensearch.experimental
+ */
 @RunWith(MockitoJUnitRunner.class)
 public class PrometheusClientUtilsTest {
 

direct-query-core/src/testFixtures/java/org/opensearch/sql/prometheus/constant/TestConstants.java

@@ -5,6 +5,9 @@
 
 package org.opensearch.sql.prometheus.constant;
 
+/*
+ * @opensearch.experimental
+ */
 public class TestConstants {
   public static final String QUERY = "test_query";
   public static final Long STARTTIME = 1664767694133L;

direct-query-core/src/testFixtures/java/org/opensearch/sql/prometheus/utils/TestUtils.java

@@ -8,6 +8,9 @@
 import java.io.IOException;
 import java.util.Objects;
 
+/*
+ * @opensearch.experimental
+ */
 public class TestUtils {
 
   /**

direct-query/src/main/java/org/opensearch/sql/directquery/rest/RestDirectQueryManagementAction.java

@@ -18,6 +18,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.opensearch.OpenSearchException;
+import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.rest.RestStatus;
 import org.opensearch.rest.BaseRestHandler;
@@ -39,6 +40,10 @@
 import org.opensearch.sql.protocol.response.format.JsonResponseFormatter;
 import org.opensearch.transport.client.node.NodeClient;
 
+/*
+ * @opensearch.experimental
+ */
+@ExperimentalApi
 @RequiredArgsConstructor
 public class RestDirectQueryManagementAction extends BaseRestHandler {
 

direct-query/src/main/java/org/opensearch/sql/directquery/rest/RestDirectQueryResourcesManagementAction.java

@@ -16,6 +16,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.opensearch.OpenSearchException;
+import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.rest.RestStatus;
 import org.opensearch.rest.BaseRestHandler;
@@ -35,6 +36,10 @@
 import org.opensearch.sql.opensearch.util.RestRequestUtil;
 import org.opensearch.transport.client.node.NodeClient;
 
+/*
+ * @opensearch.experimental
+ */
+@ExperimentalApi
 @RequiredArgsConstructor
 public class RestDirectQueryResourcesManagementAction extends BaseRestHandler {
 

direct-query/src/main/java/org/opensearch/sql/directquery/transport/TransportExecuteDirectQueryRequestAction.java

@@ -19,6 +19,9 @@
 import org.opensearch.tasks.Task;
 import org.opensearch.transport.TransportService;
 
+/*
+ * @opensearch.experimental
+ */
 public class TransportExecuteDirectQueryRequestAction
     extends HandledTransportAction<
         ExecuteDirectQueryActionRequest, ExecuteDirectQueryActionResponse> {

direct-query/src/main/java/org/opensearch/sql/directquery/transport/TransportGetDirectQueryResourcesRequestAction.java

@@ -20,6 +20,9 @@
 import org.opensearch.tasks.Task;
 import org.opensearch.transport.TransportService;
 
+/*
+ * @opensearch.experimental
+ */
 public class TransportGetDirectQueryResourcesRequestAction
     extends HandledTransportAction<
         GetDirectQueryResourcesActionRequest, GetDirectQueryResourcesActionResponse> {

direct-query/src/main/java/org/opensearch/sql/directquery/transport/config/DirectQueryModule.java

@@ -19,6 +19,9 @@
 import org.opensearch.sql.directquery.DirectQueryExecutorServiceImpl;
 import org.opensearch.sql.prometheus.query.PrometheusQueryHandler;
 
+/*
+ * @opensearch.experimental
+ */
 public class DirectQueryModule extends AbstractModule {
 
   @Override

direct-query/src/main/java/org/opensearch/sql/directquery/transport/format/DirectQueryRequestConverter.java

@@ -16,6 +16,9 @@
 import org.opensearch.sql.spark.rest.model.LangType;
 
 @UtilityClass
+/*
+ * @opensearch.experimental
+ */
 public class DirectQueryRequestConverter {
 
   public static ExecuteDirectQueryRequest fromXContentParser(XContentParser parser)