Fixed javadoc errors (#5379)

Signed-off-by: Krishna Kondaka <[email protected]>

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/AlsoRequired.java

@@ -16,6 +16,7 @@
 public @interface AlsoRequired {
     /**
      * Array of Required annotations, each representing a required property with its allowed values.
+     * @return returns array of required values
      */
     Required[] values();
 
@@ -25,11 +26,13 @@
     @interface Required {
         /**
          * Name of the required property.
+         * @return returns name
          */
         String name();
 
         /**
          * Allowed values for the required property. The default value of {} means any non-null value is allowed.
+         * @return returns array of allowed values
          */
         String[] allowedValues() default {};
     }

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/ConditionalRequired.java

@@ -13,6 +13,7 @@
 public @interface ConditionalRequired {
     /**
      * Array of if-then-else requirements.
+     * @return returns array of if and else values
      */
     IfThenElse[] value();
 
@@ -22,14 +23,17 @@
     @interface IfThenElse {
         /**
          * Array of property schemas involved in if condition.
+         * @return returns of if schema properties
          */
         SchemaProperty[] ifFulfilled();
         /**
          * Array of property schemas involved in then expectation.
+         * @return returns of then schema properties
          */
         SchemaProperty[] thenExpect();
         /**
          * Array of property schemas involved in else expectation.
+         * @return returns of else schema properties
          */
         SchemaProperty[] elseExpect() default {};
     }
@@ -40,10 +44,12 @@
     @interface SchemaProperty {
         /**
          * Name of the property.
+         * @return returns schema field
          */
         String field();
         /**
          * Value of the property. Empty string means any non-null value is allowed.
+         * @return returns schema value
          */
         String value() default "";
     }

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/ExampleValues.java

@@ -44,6 +44,7 @@
 
         /**
          * A description of the example value.
+         * @return returns description
          *
          * @since 2.11
          */

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/processor/Processor.java

@@ -37,6 +37,7 @@ public interface Processor<InputRecord extends Record<?>, OutputRecord extends R
      * @since 2.11
      * Indicates if the processor holds the events or not
      * Holding events indicates that the events are not ready to be released.
+     * @return returns if events are held by the processor or not
      */
     default boolean holdsEvents() {
         return false;

data-prepper-pipeline-parser/src/main/java/org/opensearch/dataprepper/pipeline/parser/transformer/DynamicConfigTransformer.java

@@ -486,9 +486,9 @@ public Object invokeMethod(String methodName, Class<?> parameterType, Object arg
      * Replaces template node in the jsonPath with the node from
      * original json.
      *
-     * @param root
-     * @param jsonPath
-     * @param newNode
+     * @param root json root node
+     * @param jsonPath json path
+     * @param newNode new node to be repalces with
      */
     public void replaceNode(JsonNode root, String jsonPath, JsonNode newNode) {
         try {

data-prepper-plugins/aggregate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/aggregate/AggregateAction.java

@@ -32,7 +32,7 @@ default AggregateActionResponse handleEvent(final Event event, final AggregateAc
 
     /**
      * indicates if the action holds the events or not
-     *
+     * @return returns if events are held by the processor or not
      */
     default boolean holdsEvents() {
         return false;

data-prepper-plugins/aws-plugin-api/src/main/java/org/opensearch/dataprepper/aws/api/AwsCredentialsOptions.java

@@ -139,7 +139,7 @@ public Builder withStsHeaderOverrides(final Map<String, String> stsHeaderOverrid
         /**
          * Configures whether to use default credentials.
          *
-         * @param useDefaultCredentialsProvider
+         * @param useDefaultCredentialsProvider boolean indicating if default credentials provider should be used or not
          * @return The {@link Builder} for continuing to build
          */
         public Builder withUseDefaultCredentialsProvider(final boolean useDefaultCredentialsProvider) {

data-prepper-plugins/dynamodb-source/src/main/java/org/opensearch/dataprepper/plugins/source/dynamodb/converter/RecordConverter.java

@@ -77,9 +77,11 @@ void flushBuffer() throws Exception {
     /**
      * Add event record to buffer
      *
+     * @param acknowledgementSet      acknowledgement set
      * @param data                    A map to hold event data, note that it may be empty.
      * @param keys                    A map to hold the keys (partition key and sort key)
      * @param eventCreationTimeMillis Creation timestamp of the event
+     * @param eventVersionNumber      Event version number
      * @param eventName               Event name
      * @param userIdentity            UserIdentity for TTL based deletes
      * @throws Exception Exception if failed to write to buffer.

data-prepper-plugins/dynamodb-source/src/main/java/org/opensearch/dataprepper/plugins/source/dynamodb/leader/ShardCache.java

@@ -49,7 +49,7 @@ public void put(final String shardId, final String parentShardId) {
      * Get child shard ids by parent shard id from cache.
      * If none is found, return null.
      *
-     * @param parentShardId
+     * @param parentShardId parent shard id
      * @return a list of Child Shard IDs
      */
     public List<String> get(String parentShardId) {

data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/DlqProvider.java

@@ -21,6 +21,7 @@ public interface DlqProvider {
      * Allows implementors to provide a {@link DlqWriter}. This may be optional, in which case it is not used.
      * @param pluginMetricsScope the {@link org.opensearch.dataprepper.metrics.PluginMetrics} component scope.
      *                           This is used to place the DLQ metrics under the correct parent plugin.
+     * @return returns dlq writer
      * @since 2.2
      */
     default Optional<DlqWriter> getDlqWriter(final String pluginMetricsScope) {

data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/DlqWriter.java

@@ -23,15 +23,15 @@ public interface DlqWriter {
      * @param dlqObjects the list of objects to be written to the DLQ
      * @param pipelineName the pipeline the DLQ object is associated with.
      * @param pluginId the id of the plugin the DLQ object is associated with.
-     * @throws IOException
+     * @throws IOException io exception
      *
      * @since 2.2
      */
     void write(final List<DlqObject> dlqObjects, final String pipelineName, final String pluginId) throws IOException;
 
     /**
      * Closes any open connections to the DLQ
-     * @throws IOException
+     * @throws IOException io exception
      *
      * @since 2.2
      */

data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/GeoIPProcessorService.java

@@ -30,6 +30,8 @@ public class GeoIPProcessorService {
      * GeoIPProcessorService constructor for initialization of required attributes
      *
      * @param geoIpServiceConfig geoIpServiceConfig
+     * @param geoIPDatabaseManager geoIPDatabaseManager
+     * @param readLock readLock
      */
     public GeoIPProcessorService(final GeoIpServiceConfig geoIpServiceConfig,
                                  final GeoIPDatabaseManager geoIPDatabaseManager,

data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/api/GeoIPDatabaseReader.java

@@ -38,6 +38,8 @@ public interface GeoIPDatabaseReader extends AutoCloseable {
      * Gets the geo data from the {@link com.maxmind.geoip2.DatabaseReader}
      *
      * @param inetAddress InetAddress
+     * @param fields fields
+     * @param geoIPDatabases geo ip databases
      * @return Map of geo field and value pairs from IP address
      *
      * @since 2.7

data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/api/GeoIpConfigSupplier.java

@@ -17,7 +17,7 @@
  */
 public interface GeoIpConfigSupplier {
     /**
-     * Returns the {@link GeoIPProcessorService}
+     * @return returns the {@link GeoIPProcessorService}
      *
      * @since 2.7
      */

data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/DatabaseReaderBuilder.java

@@ -24,6 +24,7 @@ public DatabaseReaderBuilder() {
      * @param databasePath databasePath
      * @param cacheSize cacheSize
      * @return DatabaseReader
+     * @throws IOException io exception
      */
     public DatabaseReader buildReader(final Path databasePath, final int cacheSize) throws IOException {
         return new DatabaseReader.Builder(databasePath.toFile())

data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/HttpDBDownloadService.java

@@ -31,7 +31,9 @@ public class HttpDBDownloadService implements DBSource {
 
     /**
      * HttpDBDownloadService constructor for initialisation of attributes
-     * @param destinationDirectory destinationDirectory
+     * @param destinationDirectory destination directory
+     * @param geoIPFileManager geo ip file manager
+     * @param maxMindDatabaseConfig max min database config
      */
     public HttpDBDownloadService(final String destinationDirectory,
                                  final GeoIPFileManager geoIPFileManager,
@@ -85,6 +87,7 @@ private File decompressAndgetTarFile(final String tarFolderPath, final String do
     /**
      * Build Request And DownloadFile
      * @param url url
+     * @param downloadTarFilepath download tar file path
      */
     public void buildRequestAndDownloadFile(final String url, final String downloadTarFilepath)  {
         downloadDBFileFromMaxmind(url, downloadTarFilepath);

data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/LocalDBDownloadService.java

@@ -22,6 +22,7 @@ public class LocalDBDownloadService implements DBSource {
     /**
      * LocalDBDownloadService constructor for initialisation of attributes
      * @param destinationDirectory destinationDirectory
+     * @param maxMindDatabaseConfig maxMindDatabaseConfig
      */
     public LocalDBDownloadService(final String destinationDirectory, final MaxMindDatabaseConfig maxMindDatabaseConfig) {
         this.destinationDirectory = destinationDirectory;
@@ -30,6 +31,7 @@ public LocalDBDownloadService(final String destinationDirectory, final MaxMindDa
 
     /**
      * Initialisation of Download from local file path
+     * @throws Exception exception
      */
     @Override
     public void initiateDownload() throws Exception {

data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/S3DBService.java

@@ -26,7 +26,9 @@ public class S3DBService implements DBSource {
     /**
      * S3DBService constructor for initialisation of attributes
      *
+     * @param awsAuthenticationOptionsConfig  awsAuthenticationOptionsConfig 
      * @param destinationDirectory destinationDirectory
+     * @param maxMindDatabaseConfig maxMindDatabaseConfig
      */
     public S3DBService(final AwsAuthenticationOptionsConfig awsAuthenticationOptionsConfig,
                        final String destinationDirectory,

data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/processor/GeoIPProcessor.java

@@ -65,9 +65,10 @@ public class GeoIPProcessor extends AbstractProcessor<Record<Event>, Record<Even
 
   /**
    * GeoIPProcessor constructor for initialization of required attributes
-   * @param pluginMetrics pluginMetrics
-   * @param geoIPProcessorConfig geoIPProcessorConfig
-   * @param geoIpConfigSupplier geoIpConfigSupplier
+   * @param pluginMetrics plugin metrics
+   * @param geoIPProcessorConfig geoIP processor config
+   * @param geoIpConfigSupplier geoIp config supplier
+   * @param expressionEvaluator expression evaluator
    */
   @DataPrepperPluginConstructor
   public GeoIPProcessor(final PluginMetrics pluginMetrics,
@@ -257,4 +258,4 @@ public boolean isReadyForShutdown() {
   public void shutdown() {
 
   }
-}
+}

data-prepper-plugins/http-source-common/src/main/java/org/opensearch/dataprepper/http/codec/Codec.java

@@ -12,14 +12,14 @@
 
 /**
  * Codec parses the content of HTTP request into custom Java type.
- * <p>
  */
 public interface Codec<T> {
     /**
      * parse the request into custom type
      *
      * @param httpData The content of the original HTTP request
-     * @return The target data type
+     * @return T The target data type
+     * @throws IOException A failure while parsing data.
      */
     T parse(HttpData httpData) throws IOException;
 
@@ -33,9 +33,7 @@ public interface Codec<T> {
 
     /*
      * Serializes the HttpData and split into multiple bodies based on splitLength.
-     * <p>
      * The serialized bodies are passed to the serializedBodyConsumer.
-     * <p>
      * This API will split into multiple bodies based on splitLength. Note that if a single
      * item is larger than this, it will be output and exceed that length.
      *

data-prepper-plugins/http-source-common/src/main/java/org/opensearch/dataprepper/http/codec/JsonCodec.java

@@ -27,7 +27,6 @@
 /**
  * JsonCodec parses the json array format HTTP data into List<{@link String}>.
  * TODO: replace output List<String> with List<InternalModel> type
- * <p>
  */
 public class JsonCodec implements Codec<List<String>> {
     private static final ObjectMapper mapper = new ObjectMapper();

data-prepper-plugins/in-memory-source-coordination-store/src/main/java/org/opensearch/dataprepper/plugins/sourcecoordinator/inmemory/InMemorySourceCoordinationStore.java

@@ -40,6 +40,7 @@ public InMemorySourceCoordinationStore(final PluginSetting pluginSetting) {
 
     /**
      * For Testing
+     * @param inMemoryPartitionAccessor inMemoryPartitionAccessor
      */
     public InMemorySourceCoordinationStore(final InMemoryPartitionAccessor inMemoryPartitionAccessor) {
         this.inMemoryPartitionAccessor = inMemoryPartitionAccessor;

data-prepper-plugins/kafka-plugins/src/main/java/org/opensearch/dataprepper/plugins/kafka/common/thread/KafkaPluginThreadFactory.java

@@ -52,6 +52,7 @@ public static KafkaPluginThreadFactory defaultExecutorThreadFactory(final String
      * Creates an instance specifically for use with {@link Executors}.
      *
      * @param kafkaPluginType The name of the plugin type. e.g. sink, source, buffer
+     * @param kafkaTopic kafka topic name
      * @return An instance of the {@link KafkaPluginThreadFactory}.
      */
     public static KafkaPluginThreadFactory defaultExecutorThreadFactory(

data-prepper-plugins/mongodb/src/main/java/org/opensearch/dataprepper/plugins/mongo/converter/RecordConverter.java

@@ -57,6 +57,7 @@ private String getAttributeValue(final Map<String, Object> data, final String at
      * @param eventCreateTimeEpochMillis Creation timestamp of the event in epoch millis
      * @param eventVersionNumber      Event version number to handle conflicts
      * @param eventName               Event name
+     * @param primaryKeyBsonType      primaryKeyBsonType
      * @return Jackson document event
      */
     public Event convert(final String record,
@@ -98,6 +99,7 @@ public Event convert(final String record,
      * @param record                  record that will be converted to Event.
      * @param eventCreationTimeMillis Creation timestamp of the event
      * @param eventVersionNumber      Event version number to handle conflicts
+     * @param primaryKeyBsonType      primaryKeyBsonType
      * @return Jackson document event
      */
     public Event convert(final String record,

data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/bulk/AccumulatingBulkRequest.java

@@ -10,8 +10,8 @@
 /**
  * Accumulates Bulk Requests.
  *
- * @param <O>
- * @param <R>
+ * @param <O> OperationType
+ * @param <R> RequestType
  */
 public interface AccumulatingBulkRequest<O, R> {
     long estimateSizeInBytesWithDocument(O documentOrOperation);

data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/bulk/SerializedJson.java

@@ -25,6 +25,7 @@ public interface SerializedJson extends SizedDocument {
      * @param jsonString The serialized JSON string which forms this JSON data.
      * @param docId Optional documment ID string
      * @param routingField Optional routing field string
+     * @param pipelineField pipeline Field
      * @return A new {@link SerializedJson}.
      */
     static SerializedJson fromStringAndOptionals(String jsonString, String docId, String routingField, String pipelineField) {

data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/AbstractIndexManager.java

@@ -217,7 +217,7 @@ private String getISMEnabled(final GetClusterSettingsResponse response) {
     /**
      * Setups anything required for the index.
      *
-     * @throws IOException
+     * @throws IOException io exception
      */
     @Override
     public void setupIndex() throws IOException {

data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/IndexTemplateAPIWrapper.java

@@ -11,13 +11,16 @@ public interface IndexTemplateAPIWrapper<T> {
      * Create or update the index template
      *
      * @param indexTemplate The {@link IndexTemplate} to create or update.
+     * @throws IOException io exception
      */
     void putTemplate(IndexTemplate indexTemplate) throws IOException;
 
     /**
      * Retrieve the existing index template
      *
      * @param name The index template name to retrieve by.
+     * @throws IOException io exception
+     * @return an {@code Optional} containing the template if found, otherwise an empty {@code Optional}.
      */
     Optional<T> getTemplate(String name) throws IOException;
 }