Metadata improvements to show identifier and status indexes details #…

…1318

matching-ws/src/main/java/life/catalogue/matching/IndexMetadata.java

@@ -0,0 +1,32 @@
+package life.catalogue.matching;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+
+/**
+ * Metadata about an index.
+ */
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+@Data
+@Schema(description = "Metadata about an index", title = "IndexMetadata", type = "object")
+public class IndexMetadata {
+  @Schema(description = "The dataset key")
+  String datasetKey;
+  @Schema(description = "The GBIF key")
+  String gbifKey;
+  @Schema(description = "The dataset description")
+  String datasetTitle;
+  @Schema(description = "The size of the index in MB")
+  Long sizeInMB = 0L;
+  @Schema(description = "The number of name usages in the index")
+  Long taxonCount = 0L;
+  @Schema(description = "The number of name usages matched to main index")
+  Long matchesToMain = 0L;
+  @Schema(description = "Counts of taxa by rank")
+  Map<String, Long> taxaByRankCount = new HashMap<>();
+}