Cleaned up comments and added descriptions for functions

aqden · Nov 7, 2023 · 19b80dc · 19b80dc
1 parent 64fea48
commit 19b80dc
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 1 deletion.
diff --git a/metadata-io/src/main/java/com/linkedin/metadata/search/EntitySearchService.java b/metadata-io/src/main/java/com/linkedin/metadata/search/EntitySearchService.java
@@ -38,6 +38,11 @@ public interface EntitySearchService {
    */
   void upsertDocument(@Nonnull String entityName, @Nonnull String document, @Nonnull String docId);
 
+  /**
+   *
+   * @param document the document to update into update index
+   * @param docId the ID of the document
+   */
   void createUpdateDocument(@Nonnull String document, @Nonnull String docId);
 
   /**

diff --git a/...ata-io/src/main/java/com/linkedin/metadata/search/elasticsearch/ElasticSearchService.java b/...ata-io/src/main/java/com/linkedin/metadata/search/elasticsearch/ElasticSearchService.java
@@ -70,6 +70,7 @@ public void upsertDocument(@Nonnull String entityName, @Nonnull String document,
     esWriteDAO.upsertDocument(entityName, document, docId);
   }
 
+  @Override
   public void createUpdateDocument(@Nonnull String document, @Nonnull String docId) {
     log.debug(String.format("Creating Update document document: %s, docId %s", document, docId));
     esWriteDAO.createUpdateDocument(document, docId);

diff --git a/metadata-io/src/main/java/com/linkedin/metadata/search/elasticsearch/update/ESWriteDAO.java b/metadata-io/src/main/java/com/linkedin/metadata/search/elasticsearch/update/ESWriteDAO.java
@@ -48,6 +48,12 @@ public void upsertDocument(@Nonnull String entityName, @Nonnull String document,
     bulkProcessor.add(updateRequest);
   }
 
+  /**
+   * Creates a request to insert new document into datahub_update_event index
+   *
+   * @param document the document to insert
+   * @param docId the ID of the document
+   */
   public void createUpdateDocument(@Nonnull String document, @Nonnull String docId) {
     final String indexName = indexConvention.getIndexName("datahub_update_event");
     final IndexRequest indexRequest = new IndexRequest(

diff --git a/...-io/src/main/java/com/linkedin/metadata/search/transformer/SearchDocumentTransformer.java b/...-io/src/main/java/com/linkedin/metadata/search/transformer/SearchDocumentTransformer.java
@@ -84,7 +84,6 @@ public Optional<String> transformAspect(
     return Optional.of(searchDocument.toString());
   }
 
-  //TODO: Transform event into a JSON-like string to upsert into search
   public String transformEvent(MetadataChangeLog event) {
     final ObjectNode searchDocument = JsonNodeFactory.instance.objectNode();
     searchDocument.put("urn", event.getEntityUrn().toString());