diff --git a/CHANGELOG.md b/CHANGELOG.md index a97c40fd40..f1e5d53466 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Added support for the `knn` namespace ([#1693](https://github.com/opensearch-project/opensearch-java/pull/1693)) - Added getter for retrieve all nodes along with their state ([#1698](https://github.com/opensearch-project/opensearch-java/pull/1698)) - Added support for the `search_relevance` namespace ([#1748](https://github.com/opensearch-project/opensearch-java/pull/1748)) +- Fix formatting of the main method to run for various samples ([#1749](https://github.com/opensearch-project/opensearch-java/pull/1749)) ### Dependencies - Bump `io.github.classgraph:classgraph` from 4.8.180 to 4.8.181 ([#1703](https://github.com/opensearch-project/opensearch-java/pull/1703)) diff --git a/samples/src/main/java/org/opensearch/client/samples/Bulk.java b/samples/src/main/java/org/opensearch/client/samples/Bulk.java index 0c6cdb47de..bf728ca45d 100644 --- a/samples/src/main/java/org/opensearch/client/samples/Bulk.java +++ b/samples/src/main/java/org/opensearch/client/samples/Bulk.java @@ -29,7 +29,7 @@ import org.opensearch.client.samples.util.IndexData; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=Bulk + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=Bulk} */ public class Bulk { private static final Logger LOGGER = LogManager.getLogger(Bulk.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/DataStreamBasics.java b/samples/src/main/java/org/opensearch/client/samples/DataStreamBasics.java index ac7a1cdd08..b6cdf3a224 100644 --- a/samples/src/main/java/org/opensearch/client/samples/DataStreamBasics.java +++ b/samples/src/main/java/org/opensearch/client/samples/DataStreamBasics.java @@ -19,7 +19,7 @@ import org.opensearch.client.opensearch.indices.PutIndexTemplateRequest; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=DataStreamBasics + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=DataStreamBasics} */ public class DataStreamBasics { private static final Logger LOGGER = LogManager.getLogger(DataStreamBasics.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/IndexTemplates.java b/samples/src/main/java/org/opensearch/client/samples/IndexTemplates.java index fd11165ba5..fa0ba81285 100644 --- a/samples/src/main/java/org/opensearch/client/samples/IndexTemplates.java +++ b/samples/src/main/java/org/opensearch/client/samples/IndexTemplates.java @@ -22,7 +22,7 @@ import org.opensearch.client.opensearch.indices.PutIndexTemplateRequest; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=IndexTemplates + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=IndexTemplates} */ public class IndexTemplates { private static final Logger LOGGER = LogManager.getLogger(IndexTemplates.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/IndexingBasics.java b/samples/src/main/java/org/opensearch/client/samples/IndexingBasics.java index e9850bb953..5f8ddf307f 100644 --- a/samples/src/main/java/org/opensearch/client/samples/IndexingBasics.java +++ b/samples/src/main/java/org/opensearch/client/samples/IndexingBasics.java @@ -30,7 +30,7 @@ import org.opensearch.client.samples.util.IndexData; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=IndexingBasics + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=IndexingBasics} */ public class IndexingBasics { private static final Logger LOGGER = LogManager.getLogger(IndexingBasics.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/PointInTime.java b/samples/src/main/java/org/opensearch/client/samples/PointInTime.java index 2ccf7eb356..eb45056d4a 100644 --- a/samples/src/main/java/org/opensearch/client/samples/PointInTime.java +++ b/samples/src/main/java/org/opensearch/client/samples/PointInTime.java @@ -25,7 +25,7 @@ import org.opensearch.client.opensearch.indices.IndexSettings; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=PointInTime + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=PointInTime} */ public class PointInTime { private static final Logger LOGGER = LogManager.getLogger(PointInTime.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/Search.java b/samples/src/main/java/org/opensearch/client/samples/Search.java index f23964976a..6c83a7a6a4 100644 --- a/samples/src/main/java/org/opensearch/client/samples/Search.java +++ b/samples/src/main/java/org/opensearch/client/samples/Search.java @@ -49,7 +49,7 @@ import org.opensearch.client.samples.util.IndexData; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=Search + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=Search} */ public class Search { private static final Logger LOGGER = LogManager.getLogger(Search.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/knn/KnnBasics.java b/samples/src/main/java/org/opensearch/client/samples/knn/KnnBasics.java index ec4b1cf028..7995ddaa0d 100644 --- a/samples/src/main/java/org/opensearch/client/samples/knn/KnnBasics.java +++ b/samples/src/main/java/org/opensearch/client/samples/knn/KnnBasics.java @@ -16,7 +16,7 @@ import org.opensearch.client.samples.util.RandUtil; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=knn.KnnBasics + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnBasics} */ public class KnnBasics { private static final Logger LOGGER = LogManager.getLogger(KnnBasics.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/knn/KnnBooleanFilter.java b/samples/src/main/java/org/opensearch/client/samples/knn/KnnBooleanFilter.java index 34968c7e0b..8d906c9f4a 100644 --- a/samples/src/main/java/org/opensearch/client/samples/knn/KnnBooleanFilter.java +++ b/samples/src/main/java/org/opensearch/client/samples/knn/KnnBooleanFilter.java @@ -16,7 +16,7 @@ import org.opensearch.client.samples.util.RandUtil; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=knn.KnnBooleanFilter + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnBooleanFilter} */ public class KnnBooleanFilter { private static final Logger LOGGER = LogManager.getLogger(KnnBooleanFilter.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/knn/KnnEfficientFilter.java b/samples/src/main/java/org/opensearch/client/samples/knn/KnnEfficientFilter.java index 6c0d627bd3..f20cdbe5af 100644 --- a/samples/src/main/java/org/opensearch/client/samples/knn/KnnEfficientFilter.java +++ b/samples/src/main/java/org/opensearch/client/samples/knn/KnnEfficientFilter.java @@ -18,7 +18,7 @@ import org.opensearch.client.samples.SampleClient; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=knn.KnnEfficientFilter + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnEfficientFilter} */ public class KnnEfficientFilter { private static final Logger LOGGER = LogManager.getLogger(KnnEfficientFilter.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/knn/KnnPainlessScript.java b/samples/src/main/java/org/opensearch/client/samples/knn/KnnPainlessScript.java index 2a60355c7b..2db0e22d28 100644 --- a/samples/src/main/java/org/opensearch/client/samples/knn/KnnPainlessScript.java +++ b/samples/src/main/java/org/opensearch/client/samples/knn/KnnPainlessScript.java @@ -17,7 +17,7 @@ import org.opensearch.client.samples.util.RandUtil; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=knn.KnnPainlessScript + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnPainlessScript} */ public class KnnPainlessScript { private static final Logger LOGGER = LogManager.getLogger(KnnPainlessScript.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/knn/KnnScriptScore.java b/samples/src/main/java/org/opensearch/client/samples/knn/KnnScriptScore.java index 2277db6d13..e99b208846 100644 --- a/samples/src/main/java/org/opensearch/client/samples/knn/KnnScriptScore.java +++ b/samples/src/main/java/org/opensearch/client/samples/knn/KnnScriptScore.java @@ -17,7 +17,7 @@ import org.opensearch.client.samples.util.RandUtil; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=knn.KnnScriptScore + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=knn.KnnScriptScore} */ public class KnnScriptScore { private static final Logger LOGGER = LogManager.getLogger(KnnScriptScore.class); diff --git a/samples/src/main/java/org/opensearch/client/samples/neural/NeuralSearch.java b/samples/src/main/java/org/opensearch/client/samples/neural/NeuralSearch.java index 693262e27e..3e13f25d2b 100644 --- a/samples/src/main/java/org/opensearch/client/samples/neural/NeuralSearch.java +++ b/samples/src/main/java/org/opensearch/client/samples/neural/NeuralSearch.java @@ -36,7 +36,7 @@ import org.opensearch.client.samples.SampleClient; /** - * Run with: ./gradlew :samples:run -Dsamples.mainClass=neural.NeuralSearch + * Run with: {@code ./gradlew :samples:run -Dsamples.mainClass=neural.NeuralSearch} */ public class NeuralSearch { private static final String SAMPLE_NAME = "neural-search";