From 37829e4efa4cc3522af74e9cba37c4ca707f8230 Mon Sep 17 00:00:00 2001 From: Krishna Kondaka Date: Fri, 31 Jan 2025 20:47:36 +0000 Subject: [PATCH] Fixed javadoc errors Signed-off-by: Krishna Kondaka --- .../model/annotations/AlsoRequired.java | 3 +++ .../model/annotations/ConditionalRequired.java | 6 ++++++ .../model/annotations/ExampleValues.java | 1 + .../dataprepper/model/processor/Processor.java | 1 + .../transformer/DynamicConfigTransformer.java | 6 +++--- .../processor/aggregate/AggregateAction.java | 2 +- .../aws/api/AwsCredentialsOptions.java | 2 +- .../dynamodb/converter/RecordConverter.java | 2 ++ .../source/dynamodb/leader/ShardCache.java | 2 +- .../dataprepper/plugins/dlq/DlqProvider.java | 1 + .../dataprepper/plugins/dlq/DlqWriter.java | 4 ++-- .../geoip/extension/GeoIPProcessorService.java | 2 ++ .../geoip/extension/api/GeoIPDatabaseReader.java | 2 ++ .../geoip/extension/api/GeoIpConfigSupplier.java | 2 +- .../databasedownload/DatabaseReaderBuilder.java | 1 + .../databasedownload/HttpDBDownloadService.java | 5 ++++- .../databasedownload/LocalDBDownloadService.java | 2 ++ .../extension/databasedownload/S3DBService.java | 2 ++ .../plugins/geoip/processor/GeoIPProcessor.java | 9 +++++---- .../opensearch/dataprepper/http/codec/Codec.java | 6 ++---- .../dataprepper/http/codec/JsonCodec.java | 1 - .../InMemorySourceCoordinationStore.java | 1 + .../common/thread/KafkaPluginThreadFactory.java | 1 + .../plugins/mongo/converter/RecordConverter.java | 2 ++ .../opensearch/bulk/AccumulatingBulkRequest.java | 4 ++-- .../sink/opensearch/bulk/SerializedJson.java | 1 + .../opensearch/index/AbstractIndexManager.java | 2 +- .../index/IndexTemplateAPIWrapper.java | 3 +++ .../opensearch/worker/client/SearchAccessor.java | 8 +++++--- .../otelmetrics/OTelMetricsProtoHelper.java | 10 ++++------ .../processor/parse/AbstractParseProcessor.java | 4 ++++ .../processor/parse/CommonParseConfig.java | 4 ++++ .../rds/resync/CascadingActionDetector.java | 6 ++++++ .../plugins/codec/parquet/S3OutputStream.java | 2 ++ .../plugins/sink/s3/KeyGenerator.java | 1 + .../dataprepper/plugins/sink/s3/S3Sink.java | 3 +++ .../plugins/sink/s3/S3SinkConfig.java | 1 + .../plugins/sink/s3/S3SinkService.java | 8 +++++++- .../plugins/sink/s3/accumulator/ObjectKey.java | 4 +++- .../plugins/source/s3/S3EventNotification.java | 3 ++- .../plugins/source/s3/S3ObjectHandler.java | 2 ++ .../plugins/source/jira/JiraService.java | 6 ++++-- .../source/jira/utils/AddressValidation.java | 3 ++- .../source/jira/utils/JiraConfigHelper.java | 2 ++ .../plugins/processor/OTelHelper.java | 8 ++++---- .../processor/ServiceMapRelationship.java | 16 ++++++++++++---- .../plugins/source/sqs/MessageFieldStrategy.java | 2 ++ .../test/helper/ReflectivelySetField.java | 1 + 48 files changed, 125 insertions(+), 45 deletions(-) diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/AlsoRequired.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/AlsoRequired.java index ae4275a3cc..e07a315f1d 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/AlsoRequired.java +++ b/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 {}; } diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/ConditionalRequired.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/ConditionalRequired.java index 7808b0d321..4234c15f96 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/ConditionalRequired.java +++ b/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 ""; } diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/ExampleValues.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/ExampleValues.java index 5ab7593cd3..145a31a8a3 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/annotations/ExampleValues.java +++ b/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 */ diff --git a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/processor/Processor.java b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/processor/Processor.java index 784758fa95..b28dfa25df 100644 --- a/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/processor/Processor.java +++ b/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/processor/Processor.java @@ -37,6 +37,7 @@ public interface Processor, 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; diff --git a/data-prepper-pipeline-parser/src/main/java/org/opensearch/dataprepper/pipeline/parser/transformer/DynamicConfigTransformer.java b/data-prepper-pipeline-parser/src/main/java/org/opensearch/dataprepper/pipeline/parser/transformer/DynamicConfigTransformer.java index c782515ef3..ad333954f2 100644 --- a/data-prepper-pipeline-parser/src/main/java/org/opensearch/dataprepper/pipeline/parser/transformer/DynamicConfigTransformer.java +++ b/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 { diff --git a/data-prepper-plugins/aggregate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/aggregate/AggregateAction.java b/data-prepper-plugins/aggregate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/aggregate/AggregateAction.java index 541cd15d3d..6e17e01188 100644 --- a/data-prepper-plugins/aggregate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/aggregate/AggregateAction.java +++ b/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; diff --git a/data-prepper-plugins/aws-plugin-api/src/main/java/org/opensearch/dataprepper/aws/api/AwsCredentialsOptions.java b/data-prepper-plugins/aws-plugin-api/src/main/java/org/opensearch/dataprepper/aws/api/AwsCredentialsOptions.java index 1c0baea3bd..37d161cc81 100644 --- a/data-prepper-plugins/aws-plugin-api/src/main/java/org/opensearch/dataprepper/aws/api/AwsCredentialsOptions.java +++ b/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 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) { diff --git a/data-prepper-plugins/dynamodb-source/src/main/java/org/opensearch/dataprepper/plugins/source/dynamodb/converter/RecordConverter.java b/data-prepper-plugins/dynamodb-source/src/main/java/org/opensearch/dataprepper/plugins/source/dynamodb/converter/RecordConverter.java index dd4c6fe3e3..6e9b9c624c 100644 --- a/data-prepper-plugins/dynamodb-source/src/main/java/org/opensearch/dataprepper/plugins/source/dynamodb/converter/RecordConverter.java +++ b/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. diff --git a/data-prepper-plugins/dynamodb-source/src/main/java/org/opensearch/dataprepper/plugins/source/dynamodb/leader/ShardCache.java b/data-prepper-plugins/dynamodb-source/src/main/java/org/opensearch/dataprepper/plugins/source/dynamodb/leader/ShardCache.java index d259bbe778..cf266b3028 100644 --- a/data-prepper-plugins/dynamodb-source/src/main/java/org/opensearch/dataprepper/plugins/source/dynamodb/leader/ShardCache.java +++ b/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 get(String parentShardId) { diff --git a/data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/DlqProvider.java b/data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/DlqProvider.java index 863a84643b..16881a8d67 100644 --- a/data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/DlqProvider.java +++ b/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 getDlqWriter(final String pluginMetricsScope) { diff --git a/data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/DlqWriter.java b/data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/DlqWriter.java index bc1a7011df..a47c2bc3a9 100644 --- a/data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/DlqWriter.java +++ b/data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/DlqWriter.java @@ -23,7 +23,7 @@ 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 */ @@ -31,7 +31,7 @@ public interface DlqWriter { /** * Closes any open connections to the DLQ - * @throws IOException + * @throws IOException io exception * * @since 2.2 */ diff --git a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/GeoIPProcessorService.java b/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/GeoIPProcessorService.java index 21ab0f1190..580d677e55 100644 --- a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/GeoIPProcessorService.java +++ b/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, diff --git a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/api/GeoIPDatabaseReader.java b/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/api/GeoIPDatabaseReader.java index 8f611cc9b4..52ee171eb4 100644 --- a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/api/GeoIPDatabaseReader.java +++ b/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 diff --git a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/api/GeoIpConfigSupplier.java b/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/api/GeoIpConfigSupplier.java index 11a9db45cf..bdb07f415d 100644 --- a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/api/GeoIpConfigSupplier.java +++ b/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 */ diff --git a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/DatabaseReaderBuilder.java b/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/DatabaseReaderBuilder.java index 8a6caaabaf..cc90c7bf50 100644 --- a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/DatabaseReaderBuilder.java +++ b/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()) diff --git a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/HttpDBDownloadService.java b/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/HttpDBDownloadService.java index c382e72726..4bff5ed156 100644 --- a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/HttpDBDownloadService.java +++ b/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); diff --git a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/LocalDBDownloadService.java b/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/LocalDBDownloadService.java index 9d60727315..4b8ea96676 100644 --- a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/LocalDBDownloadService.java +++ b/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 { diff --git a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/S3DBService.java b/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/S3DBService.java index c3f57e76cb..085f1d37bb 100644 --- a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/extension/databasedownload/S3DBService.java +++ b/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, diff --git a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/processor/GeoIPProcessor.java b/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/processor/GeoIPProcessor.java index afb0ed23d3..d039c18d22 100644 --- a/data-prepper-plugins/geoip-processor/src/main/java/org/opensearch/dataprepper/plugins/geoip/processor/GeoIPProcessor.java +++ b/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 */ public interface Codec { /** * 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 { /* * Serializes the HttpData and split into multiple bodies based on splitLength. - *

* The serialized bodies are passed to the serializedBodyConsumer. - *

* 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. * diff --git a/data-prepper-plugins/http-source-common/src/main/java/org/opensearch/dataprepper/http/codec/JsonCodec.java b/data-prepper-plugins/http-source-common/src/main/java/org/opensearch/dataprepper/http/codec/JsonCodec.java index 6306366816..792d55e50d 100644 --- a/data-prepper-plugins/http-source-common/src/main/java/org/opensearch/dataprepper/http/codec/JsonCodec.java +++ b/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 - *

*/ public class JsonCodec implements Codec> { private static final ObjectMapper mapper = new ObjectMapper(); diff --git a/data-prepper-plugins/in-memory-source-coordination-store/src/main/java/org/opensearch/dataprepper/plugins/sourcecoordinator/inmemory/InMemorySourceCoordinationStore.java b/data-prepper-plugins/in-memory-source-coordination-store/src/main/java/org/opensearch/dataprepper/plugins/sourcecoordinator/inmemory/InMemorySourceCoordinationStore.java index 2bf6922f86..857ce79bad 100644 --- a/data-prepper-plugins/in-memory-source-coordination-store/src/main/java/org/opensearch/dataprepper/plugins/sourcecoordinator/inmemory/InMemorySourceCoordinationStore.java +++ b/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; diff --git a/data-prepper-plugins/kafka-plugins/src/main/java/org/opensearch/dataprepper/plugins/kafka/common/thread/KafkaPluginThreadFactory.java b/data-prepper-plugins/kafka-plugins/src/main/java/org/opensearch/dataprepper/plugins/kafka/common/thread/KafkaPluginThreadFactory.java index b5dede6cda..0331ffea32 100644 --- a/data-prepper-plugins/kafka-plugins/src/main/java/org/opensearch/dataprepper/plugins/kafka/common/thread/KafkaPluginThreadFactory.java +++ b/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( diff --git a/data-prepper-plugins/mongodb/src/main/java/org/opensearch/dataprepper/plugins/mongo/converter/RecordConverter.java b/data-prepper-plugins/mongodb/src/main/java/org/opensearch/dataprepper/plugins/mongo/converter/RecordConverter.java index e6516c0348..81c78cbe7c 100644 --- a/data-prepper-plugins/mongodb/src/main/java/org/opensearch/dataprepper/plugins/mongo/converter/RecordConverter.java +++ b/data-prepper-plugins/mongodb/src/main/java/org/opensearch/dataprepper/plugins/mongo/converter/RecordConverter.java @@ -57,6 +57,7 @@ private String getAttributeValue(final Map 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, diff --git a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/bulk/AccumulatingBulkRequest.java b/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/bulk/AccumulatingBulkRequest.java index 34f0d489e0..73a48ae0b6 100644 --- a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/bulk/AccumulatingBulkRequest.java +++ b/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/bulk/AccumulatingBulkRequest.java @@ -10,8 +10,8 @@ /** * Accumulates Bulk Requests. * - * @param - * @param + * @param OperationType + * @param RequestType */ public interface AccumulatingBulkRequest { long estimateSizeInBytesWithDocument(O documentOrOperation); diff --git a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/bulk/SerializedJson.java b/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/bulk/SerializedJson.java index d85a5992c5..c1b5ae3799 100644 --- a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/bulk/SerializedJson.java +++ b/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) { diff --git a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/AbstractIndexManager.java b/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/AbstractIndexManager.java index bb1565dcd1..1a65396c39 100644 --- a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/AbstractIndexManager.java +++ b/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 { diff --git a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/IndexTemplateAPIWrapper.java b/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/IndexTemplateAPIWrapper.java index 8a267d15b3..4b967666fb 100644 --- a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/IndexTemplateAPIWrapper.java +++ b/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/IndexTemplateAPIWrapper.java @@ -11,6 +11,7 @@ public interface IndexTemplateAPIWrapper { * 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; @@ -18,6 +19,8 @@ public interface IndexTemplateAPIWrapper { * 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 getTemplate(String name) throws IOException; } diff --git a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/source/opensearch/worker/client/SearchAccessor.java b/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/source/opensearch/worker/client/SearchAccessor.java index 3b34acba97..7fa8ba2b71 100644 --- a/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/source/opensearch/worker/client/SearchAccessor.java +++ b/data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/source/opensearch/worker/client/SearchAccessor.java @@ -40,7 +40,7 @@ public interface SearchAccessor { /** * Searches using a PIT context * @param searchPointInTimeRequest payload for searching with PIT context - * @return + * @return SearchWithSearchAfterResults seach results * @since 2.4 */ SearchWithSearchAfterResults searchWithPit(SearchPointInTimeRequest searchPointInTimeRequest); @@ -55,7 +55,7 @@ public interface SearchAccessor { /** * Creates scroll context * @param createScrollRequest payload for creating the scroll context - * @return + * @return CreateScrollResponse create scroll response * @since 2.4 */ CreateScrollResponse createScroll(CreateScrollRequest createScrollRequest); @@ -63,7 +63,7 @@ public interface SearchAccessor { /** * Search with scroll context. * @param searchScrollRequest payload for searching with scroll context - * @return + * @return SearchScrollResponse search scroll response */ SearchScrollResponse searchWithScroll(SearchScrollRequest searchScrollRequest); @@ -75,6 +75,8 @@ public interface SearchAccessor { /** * Searches with sort and search_after without using any search contexts (Point-in-Time or Scroll) + * @param noSearchContextSearchRequest nosearch context request + * @return SearchWithSearchAfterResults search results */ SearchWithSearchAfterResults searchWithoutSearchContext(NoSearchContextSearchRequest noSearchContextSearchRequest); } diff --git a/data-prepper-plugins/otel-metrics-raw-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/otelmetrics/OTelMetricsProtoHelper.java b/data-prepper-plugins/otel-metrics-raw-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/otelmetrics/OTelMetricsProtoHelper.java index a925bb4730..3a90eaea16 100644 --- a/data-prepper-plugins/otel-metrics-raw-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/otelmetrics/OTelMetricsProtoHelper.java +++ b/data-prepper-plugins/otel-metrics-raw-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/otelmetrics/OTelMetricsProtoHelper.java @@ -73,7 +73,7 @@ private OTelMetricsProtoHelper() { * Converts an {@link AnyValue} into its appropriate data type * * @param value The value to convert - * @return + * @return returns converted value object */ public static Object convertAnyValue(final AnyValue value) { switch (value.getValueCase()) { @@ -125,7 +125,6 @@ public static Map convertKeysOfDataPointAttributes(final NumberD /** * Unpacks the List of {@link KeyValue} object into a Map. - *

* Converts the keys into an os friendly format and casts the underlying data into its actual type? * * @param attributesList The list of {@link KeyValue} objects to process @@ -138,7 +137,6 @@ public static Map unpackKeyValueList(List attributesLi /** * Unpacks the List of {@link KeyValue} object into a Map. - *

* Converts the keys into an os friendly format and casts the underlying data into its actual type? * * @param attributesList The list of {@link KeyValue} objects to process @@ -194,6 +192,7 @@ public static Map getResourceAttributes(final Resource resource) /** * Extracts the name and version of the used instrumentation library used * + * @param instrumentationLibrary instrumentationLibrary * @return A map, containing information about the instrumentation library */ public static Map getInstrumentationLibraryAttributes(final InstrumentationLibrary instrumentationLibrary) { @@ -210,6 +209,7 @@ public static Map getInstrumentationLibraryAttributes(final Inst /** * Extracts the name and version of the used instrumentation scope used * + * @param instrumentationScope instrumentationScope * @return A map, containing information about the instrumentation scope */ public static Map getInstrumentationScopeAttributes(final InstrumentationScope instrumentationScope) { @@ -260,9 +260,7 @@ public static List getQuantileValues(List * the OTel metrics proto spec - *

- * The boundaries for bucket at index i are: - *

+ *

The boundaries for bucket at index i are:

* 
{@code
      * (-infinity, explicit_bounds[i]) for i == 0
      * (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)
diff --git a/data-prepper-plugins/parse-json-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/parse/AbstractParseProcessor.java b/data-prepper-plugins/parse-json-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/parse/AbstractParseProcessor.java
index 8f5e650a4f..e294f3c283 100644
--- a/data-prepper-plugins/parse-json-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/parse/AbstractParseProcessor.java
+++ b/data-prepper-plugins/parse-json-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/parse/AbstractParseProcessor.java
@@ -84,6 +84,8 @@ protected AbstractParseProcessor(final PluginMetrics pluginMetrics,
     }
 
     /**
+     * @param message message
+     * @param context context
      * @return Optional HashMap of the parsed value - empty if the message was invalid (be sure to log the error)
      */
     protected abstract Optional> readValue(String message, Event context);
@@ -222,6 +224,8 @@ private String getEndOfPointer(final String trimmedPointer) {
 
     /**
      * Trim the pointer and change each front slash / to be a dot (.) to process
+     * @param pointer input string
+     * @return returns replaced string
      */
     private String normalizePointerStructure(final String pointer) {
         return pointer.replace('/','.');
diff --git a/data-prepper-plugins/parse-json-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/parse/CommonParseConfig.java b/data-prepper-plugins/parse-json-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/parse/CommonParseConfig.java
index d52282043a..fc91f91572 100644
--- a/data-prepper-plugins/parse-json-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/parse/CommonParseConfig.java
+++ b/data-prepper-plugins/parse-json-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/parse/CommonParseConfig.java
@@ -52,23 +52,27 @@ public interface CommonParseConfig {
     /**
      * An optional setting used to specify whether the destination field should be overwritten if it already exists.
      * Defaults to true.
+     * @return returns  overwrite if destination exists flag
      */
     boolean getOverwriteIfDestinationExists();
 
     /**
      * An optional setting used to request dropping the original raw message after successfully parsing the input event.
      * Defaults to false.
+     * @return returns delete source required flag
      */
     boolean isDeleteSourceRequested();
 
     /**
      * An optional setting used to determine how to handle parsing errors. Default is skip, which includes logging the error
      * and passing the failed Event downstream to the next processor.
+     * @return returns handle failed events option
      */
     HandleFailedEventsOption getHandleFailedEventsOption();
 
     /**
      * An optional setting used to determine the depth of the input to handle
+     * @return returns depth
      */
     int getDepth();
 }
diff --git a/data-prepper-plugins/rds-source/src/main/java/org/opensearch/dataprepper/plugins/source/rds/resync/CascadingActionDetector.java b/data-prepper-plugins/rds-source/src/main/java/org/opensearch/dataprepper/plugins/source/rds/resync/CascadingActionDetector.java
index 98df985ccb..2630be739a 100644
--- a/data-prepper-plugins/rds-source/src/main/java/org/opensearch/dataprepper/plugins/source/rds/resync/CascadingActionDetector.java
+++ b/data-prepper-plugins/rds-source/src/main/java/org/opensearch/dataprepper/plugins/source/rds/resync/CascadingActionDetector.java
@@ -83,6 +83,9 @@ public Map getParentTableMap(StreamPartition streamPartitio
 
     /**
      * Detects if a binlog event contains cascading updates and if detected, creates resync partitions
+     * @param event event
+     * @param parentTableMap parent table map
+     * @param tableMetadata table meta data
      */
     public void detectCascadingUpdates(Event event, Map parentTableMap, TableMetadata tableMetadata) {
         final UpdateRowsEventData data = event.getData();
@@ -140,6 +143,9 @@ public void detectCascadingUpdates(Event event, Map parentT
 
     /**
      * Detects if a binlog event contains cascading deletes and if detected, creates resync partitions
+     * @param event event
+     * @param parentTableMap parent table map
+     * @param tableMetadata table meta data
      */
     public void detectCascadingDeletes(Event event, Map parentTableMap, TableMetadata tableMetadata) {
         if (parentTableMap.containsKey(tableMetadata.getFullTableName())) {
diff --git a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/codec/parquet/S3OutputStream.java b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/codec/parquet/S3OutputStream.java
index b4538acaf8..9830ef027b 100644
--- a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/codec/parquet/S3OutputStream.java
+++ b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/codec/parquet/S3OutputStream.java
@@ -93,6 +93,8 @@ public class S3OutputStream extends PositionOutputStream {
      * @param s3Client the AmazonS3 client
      * @param bucketSupplier  name of the bucket
      * @param keySupplier     path within the bucket
+     * @param defaultBucket default bucket
+     * @param bucketOwnerProvider bucket owner provider
      */
     public S3OutputStream(final S3AsyncClient s3Client,
                           final Supplier bucketSupplier,
diff --git a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/KeyGenerator.java b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/KeyGenerator.java
index 7a742d0217..423df4b6a4 100644
--- a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/KeyGenerator.java
+++ b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/KeyGenerator.java
@@ -30,6 +30,7 @@ public KeyGenerator(final S3SinkConfig s3SinkConfig,
     /**
      * Generate the s3 object path prefix and object file name.
      *
+     * @param event event
      * @return object key path.
      */
     public String generateKeyForEvent(final Event event) {
diff --git a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3Sink.java b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3Sink.java
index c4c88dc323..ad81cf9d0c 100644
--- a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3Sink.java
+++ b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3Sink.java
@@ -60,6 +60,9 @@ public class S3Sink extends AbstractSink> {
      * @param pluginSetting dp plugin settings.
      * @param s3SinkConfig  s3 sink configurations.
      * @param pluginFactory dp plugin factory.
+     * @param sinkContext sink context
+     * @param awsCredentialsSupplier aws credentials supplier
+     * @param expressionEvaluator expression evaluator
      */
     @DataPrepperPluginConstructor
     public S3Sink(final PluginSetting pluginSetting,
diff --git a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3SinkConfig.java b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3SinkConfig.java
index f5e36ea643..15279dae24 100644
--- a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3SinkConfig.java
+++ b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3SinkConfig.java
@@ -126,6 +126,7 @@ public ThresholdOptions getThresholdOptions() {
 
     /**
      * Threshold configuration for the aggregation of all S3 groups
+     * @return returns aggregate threshold options
      */
     public AggregateThresholdOptions getAggregateThresholdOptions() { return aggregateThresholdOptions; }
 
diff --git a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3SinkService.java b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3SinkService.java
index 571a952f01..811ab3246b 100644
--- a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3SinkService.java
+++ b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/S3SinkService.java
@@ -67,7 +67,10 @@ public class S3SinkService {
 
     /**
      * @param s3SinkConfig  s3 sink related configuration.
-     * @param pluginMetrics metrics.
+     * @param codecContext codecContext.
+     * @param retrySleepTime retrySleepTime
+     * @param pluginMetrics pluginMetrics
+     * @param s3GroupManager s3GroupManager
      */
     public S3SinkService(final S3SinkConfig s3SinkConfig,
                          final OutputCodecContext codecContext,
@@ -169,6 +172,9 @@ void output(Collection> records) {
     }
 
     /**
+     * @param completableFutures completableFutures
+     * @param s3Group s3 group
+     * @param forceFlush force flush flag
      * @return whether the flush was attempted
      */
     private boolean flushToS3IfNeeded(final List> completableFutures, final S3Group s3Group, final boolean forceFlush) {
diff --git a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/accumulator/ObjectKey.java b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/accumulator/ObjectKey.java
index 65ac8edcef..637e72c76d 100644
--- a/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/accumulator/ObjectKey.java
+++ b/data-prepper-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/s3/accumulator/ObjectKey.java
@@ -69,6 +69,8 @@ private static String buildingPathPrefixInternal(final S3SinkConfig s3SinkConfig
      *
      * @param s3SinkConfig s3 sink configuration
      * @param codecExtension extension
+     * @param event event
+     * @param expressionEvaluator expressionEvaluator
      * @return s3 object name with prefix
      */
     public static String objectFileName(final S3SinkConfig s3SinkConfig,
@@ -86,4 +88,4 @@ public static String objectFileName(final S3SinkConfig s3SinkConfig,
                     (codecExtension!=null? codecExtension : DEFAULT_CODEC_FILE_EXTENSION);
         }
     }
-}
\ No newline at end of file
+}
diff --git a/data-prepper-plugins/s3-source/src/main/java/org/opensearch/dataprepper/plugins/source/s3/S3EventNotification.java b/data-prepper-plugins/s3-source/src/main/java/org/opensearch/dataprepper/plugins/source/s3/S3EventNotification.java
index 2220eea653..b81ef6d92f 100644
--- a/data-prepper-plugins/s3-source/src/main/java/org/opensearch/dataprepper/plugins/source/s3/S3EventNotification.java
+++ b/data-prepper-plugins/s3-source/src/main/java/org/opensearch/dataprepper/plugins/source/s3/S3EventNotification.java
@@ -146,6 +146,7 @@ public String getUrlDecodedKey() {
 
     /**
      * @deprecated use {@link #getSizeAsLong()} instead.
+     * @return returns size
      */
     @Deprecated
     @JsonIgnore
@@ -397,4 +398,4 @@ public GlacierEventDataEntity getGlacierEventData() {
       return glacierEventData;
     }
   }
-}
\ No newline at end of file
+}
diff --git a/data-prepper-plugins/s3-source/src/main/java/org/opensearch/dataprepper/plugins/source/s3/S3ObjectHandler.java b/data-prepper-plugins/s3-source/src/main/java/org/opensearch/dataprepper/plugins/source/s3/S3ObjectHandler.java
index faf442d120..40a77d98dc 100644
--- a/data-prepper-plugins/s3-source/src/main/java/org/opensearch/dataprepper/plugins/source/s3/S3ObjectHandler.java
+++ b/data-prepper-plugins/s3-source/src/main/java/org/opensearch/dataprepper/plugins/source/s3/S3ObjectHandler.java
@@ -18,6 +18,8 @@ public interface S3ObjectHandler {
      * Parse S3 object content using S3 object reference and pushing to buffer
      * @param s3ObjectReference Contains bucket and s3 object details
      * @param acknowledgementSet acknowledgement set for the object
+     * @param sourceCoordinator source coordinator
+     * @param partitionKey partition key
      *
      * @throws IOException exception is thrown every time because this is not supported
      */
diff --git a/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/JiraService.java b/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/JiraService.java
index 4600d1bdeb..e07aaca2a4 100644
--- a/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/JiraService.java
+++ b/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/JiraService.java
@@ -75,6 +75,7 @@ public JiraService(JiraSourceConfig jiraSourceConfig, JiraRestClient jiraRestCli
      *
      * @param configuration the configuration.
      * @param timestamp     timestamp.
+     * @param itemInfoQueue item info queue
      */
     public void getJiraEntities(JiraSourceConfig configuration, Instant timestamp, Queue itemInfoQueue) {
         log.trace("Started to fetch entities");
@@ -91,6 +92,7 @@ public String getIssue(String issueKey) {
      *
      * @param configuration Input Parameter
      * @param timestamp     Input Parameter
+     * @param itemInfoQueue item info queue
      */
     private void searchForNewTicketsAndAddToQueue(JiraSourceConfig configuration, Instant timestamp,
                                                   Queue itemInfoQueue) {
@@ -127,7 +129,7 @@ private void addItemsToQueue(List issueList, Queue itemInfo
      *
      * @param configuration Input Parameter
      * @param ts            Input Parameter
-     * @return String Builder
+     * @return String Builder created issue filter criteria
      */
     private StringBuilder createIssueFilterCriteria(JiraSourceConfig configuration, Instant ts) {
 
@@ -214,4 +216,4 @@ private void validateProjectFilters(JiraSourceConfig configuration) {
 
     }
 
-}
\ No newline at end of file
+}
diff --git a/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/AddressValidation.java b/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/AddressValidation.java
index d6cc166226..98b8c09c6a 100644
--- a/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/AddressValidation.java
+++ b/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/AddressValidation.java
@@ -33,6 +33,7 @@ public class AddressValidation {
      * Method for getInetAddress.
      *
      * @param url input parameter.
+     * @return returns inet address
      */
     public static InetAddress getInetAddress(String url) {
         try {
@@ -57,4 +58,4 @@ public static void validateInetAddress(@NonNull final InetAddress address) {
             throw new BadRequestException(INVALID_URL);
         }
     }
-}
\ No newline at end of file
+}
diff --git a/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/JiraConfigHelper.java b/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/JiraConfigHelper.java
index dd815bd607..ab851d0793 100644
--- a/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/JiraConfigHelper.java
+++ b/data-prepper-plugins/saas-source-plugins/jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/JiraConfigHelper.java
@@ -47,6 +47,7 @@ public static List getIssueStatusExcludeFilter(JiraSourceConfig reposito
     /**
      * Get Issue Types Filter from repository configuration.
      *
+     * @param repositoryConfiguration repo config
      * @return List Issue Type Filter.
      */
     public static List getIssueTypeIncludeFilter(JiraSourceConfig repositoryConfiguration) {
@@ -67,6 +68,7 @@ public static List getIssueTypeExcludeFilter(JiraSourceConfig repository
      * Get Project Filter Types from repository configuration.
      * public static final String ST = "status";
      *
+     * @param repositoryConfiguration repo config
      * @return List Project Filter.
      */
     public static List getProjectNameIncludeFilter(JiraSourceConfig repositoryConfiguration) {
diff --git a/data-prepper-plugins/service-map-stateful/src/main/java/org/opensearch/dataprepper/plugins/processor/OTelHelper.java b/data-prepper-plugins/service-map-stateful/src/main/java/org/opensearch/dataprepper/plugins/processor/OTelHelper.java
index 93859adccb..8ffda8a6c7 100644
--- a/data-prepper-plugins/service-map-stateful/src/main/java/org/opensearch/dataprepper/plugins/processor/OTelHelper.java
+++ b/data-prepper-plugins/service-map-stateful/src/main/java/org/opensearch/dataprepper/plugins/processor/OTelHelper.java
@@ -18,8 +18,8 @@ public class OTelHelper {
     /**
      * Helper method which accepts a OpenTelemetry trace resource object and return the service name object.
      *
-     * @param resource
-     * @return
+     * @param resource resource
+     * @return returns service name
      */
     public static Optional getServiceName(final Resource resource) {
         return resource.getAttributesList().stream().filter(
@@ -31,8 +31,8 @@ public static Optional getServiceName(final Resource resource) {
     /**
      * Helper method which checks if OpenTelemetry span is valid for processing.
      *
-     * @param span
-     * @return
+     * @param span span
+     * @return returns if the span is valid or not
      */
     public static boolean checkValidSpan(final Span span) {
         return !span.getTraceId().isEmpty() && !span.getSpanId().isEmpty() && !span.getName().isEmpty();
diff --git a/data-prepper-plugins/service-map-stateful/src/main/java/org/opensearch/dataprepper/plugins/processor/ServiceMapRelationship.java b/data-prepper-plugins/service-map-stateful/src/main/java/org/opensearch/dataprepper/plugins/processor/ServiceMapRelationship.java
index 2d20dd95c8..1144b86c9d 100644
--- a/data-prepper-plugins/service-map-stateful/src/main/java/org/opensearch/dataprepper/plugins/processor/ServiceMapRelationship.java
+++ b/data-prepper-plugins/service-map-stateful/src/main/java/org/opensearch/dataprepper/plugins/processor/ServiceMapRelationship.java
@@ -66,6 +66,11 @@ private ServiceMapRelationship(final String serviceName, final String kind, fina
 
     /**
      * Create a destination relationship
+     * @param serviceName service name
+     * @param spanKind span kind
+     * @param domain domain
+     * @param resource resource
+     * @param traceGroupName trace group name
      * @return Relationship with the fields set, and target set to null
      */
     public static ServiceMapRelationship newDestinationRelationship (
@@ -79,6 +84,11 @@ public static ServiceMapRelationship newDestinationRelationship (
 
     /**
      * Create a target relationship
+     * @param serviceName service name
+     * @param spanKind span kind
+     * @param domain domain
+     * @param resource resource
+     * @param traceGroupName trace group name
      * @return Relationship with the fields set, and destination set to null
      */
     public static ServiceMapRelationship newTargetRelationship (
@@ -164,12 +174,10 @@ private String md5Hash() {
 
     /**
      * The endpoint follows the URL spec.
-     * 

-     * Example, https://paymentservice/makePayment.
-     * 

+     * 
 Example, https://paymentservice/makePayment.  

      *  domain: paymentservice
      *  resource: makePayment
-     * 

+     * 
      *
      */
     public static class Endpoint {
diff --git a/data-prepper-plugins/sqs-source/src/main/java/org/opensearch/dataprepper/plugins/source/sqs/MessageFieldStrategy.java b/data-prepper-plugins/sqs-source/src/main/java/org/opensearch/dataprepper/plugins/source/sqs/MessageFieldStrategy.java
index f7decd3f91..91ba2be3f1 100644
--- a/data-prepper-plugins/sqs-source/src/main/java/org/opensearch/dataprepper/plugins/source/sqs/MessageFieldStrategy.java
+++ b/data-prepper-plugins/sqs-source/src/main/java/org/opensearch/dataprepper/plugins/source/sqs/MessageFieldStrategy.java
@@ -16,6 +16,8 @@
 public interface MessageFieldStrategy {
   /**
    * Converts the SQS message body into one or more events.
+   * @param messageBody message body
+   * @return returns list of events fromt he body
    */
     List parseEvents(String messageBody);
 }
diff --git a/data-prepper-test-common/src/main/java/org/opensearch/dataprepper/test/helper/ReflectivelySetField.java b/data-prepper-test-common/src/main/java/org/opensearch/dataprepper/test/helper/ReflectivelySetField.java
index 799274ca7a..6b5f0e79b6 100644
--- a/data-prepper-test-common/src/main/java/org/opensearch/dataprepper/test/helper/ReflectivelySetField.java
+++ b/data-prepper-test-common/src/main/java/org/opensearch/dataprepper/test/helper/ReflectivelySetField.java
@@ -17,6 +17,7 @@ private ReflectivelySetField() {
 
     /**
      * Reflectively set the field of a configuration object.
+     * @param  The type
      * @param configurationClass The class of the configuration object.
      * @param configurationObject The configuration object itself (for tests you might need to specify
      *                            "NameOfTestClass.this.configurationObject"