<feature>[vm]: add vm metadata header definitions

Resolves: ZSV-11559

Change-Id: I3cd9fa26b6af7bd47787ab88c5050683a3356059

Author: taogan21

header/src/main/java/org/zstack/header/storage/primary/APIScanVmInstanceMetadataFromPrimaryStorageEvent.java

@@ -0,0 +1,33 @@
+package org.zstack.header.storage.primary;
+
+import org.zstack.header.message.APIEvent;
+import org.zstack.header.rest.RestResponse;
+
+import java.util.ArrayList;
+import java.util.List;
+
+@RestResponse(fieldsTo = {"all"})
+public class APIScanVmInstanceMetadataFromPrimaryStorageEvent extends APIEvent {
+    private List<VmMetadataScanEntry> vmInstanceMetadata = new ArrayList<>();
+
+    public APIScanVmInstanceMetadataFromPrimaryStorageEvent() {
+        super(null);
+    }
+
+    public APIScanVmInstanceMetadataFromPrimaryStorageEvent(String apiId) {
+        super(apiId);
+    }
+
+    public List<VmMetadataScanEntry> getVmInstanceMetadata() {
+        return vmInstanceMetadata;
+    }
+
+    public void setVmInstanceMetadata(List<VmMetadataScanEntry> vmInstanceMetadata) {
+        this.vmInstanceMetadata = vmInstanceMetadata == null ? new ArrayList<>() : vmInstanceMetadata;
+    }
+
+    public static APIScanVmInstanceMetadataFromPrimaryStorageEvent __example__() {
+        APIScanVmInstanceMetadataFromPrimaryStorageEvent evt = new APIScanVmInstanceMetadataFromPrimaryStorageEvent();
+        return evt;
+    }
+}

header/src/main/java/org/zstack/header/storage/primary/APIScanVmInstanceMetadataFromPrimaryStorageEventDoc_zh_cn.groovy

@@ -0,0 +1,32 @@
+package org.zstack.header.storage.primary
+
+
+import org.zstack.header.errorcode.ErrorCode
+
+doc {
+
+	title "扫描主存储上的云主机元数据返回"
+
+	ref {
+		name "vmInstanceMetadata"
+		path "org.zstack.header.storage.primary.APIScanVmInstanceMetadataFromPrimaryStorageEvent.vmInstanceMetadata"
+		desc "云主机元数据摘要列表"
+		type "List"
+		since "5.0.0"
+		clz VmMetadataScanEntry.class
+	}
+	field {
+		name "success"
+		desc "操作是否成功"
+		type "boolean"
+		since "5.0.0"
+	}
+	ref {
+		name "error"
+		path "org.zstack.header.storage.primary.APIScanVmInstanceMetadataFromPrimaryStorageEvent.error"
+		desc "错误码，若不为null，则表示操作失败, 操作成功时该字段为null"
+		type "ErrorCode"
+		since "5.0.0"
+		clz ErrorCode.class
+	}
+}

header/src/main/java/org/zstack/header/storage/primary/APIScanVmInstanceMetadataFromPrimaryStorageMsg.java

@@ -0,0 +1,35 @@
+package org.zstack.header.storage.primary;
+
+import org.springframework.http.HttpMethod;
+import org.zstack.header.message.APIMessage;
+import org.zstack.header.message.APIParam;
+import org.zstack.header.rest.RestRequest;
+
+@RestRequest(
+        path = "/primary-storage/vm-instances/metadata/scan",
+        method = HttpMethod.GET,
+        responseClass = APIScanVmInstanceMetadataFromPrimaryStorageEvent.class
+)
+public class APIScanVmInstanceMetadataFromPrimaryStorageMsg extends APIMessage implements PrimaryStorageMessage {
+    @APIParam(resourceType = PrimaryStorageVO.class)
+    private String uuid;
+
+    public String getUuid() {
+        return uuid;
+    }
+
+    public void setUuid(String uuid) {
+        this.uuid = uuid;
+    }
+
+    @Override
+    public String getPrimaryStorageUuid() {
+        return uuid;
+    }
+
+    public static APIScanVmInstanceMetadataFromPrimaryStorageMsg __example__() {
+        APIScanVmInstanceMetadataFromPrimaryStorageMsg msg = new APIScanVmInstanceMetadataFromPrimaryStorageMsg();
+        msg.setUuid(uuid());
+        return msg;
+    }
+}

header/src/main/java/org/zstack/header/storage/primary/APIScanVmInstanceMetadataFromPrimaryStorageMsgDoc_zh_cn.groovy

@@ -0,0 +1,58 @@
+package org.zstack.header.storage.primary
+
+import org.zstack.header.storage.primary.APIScanVmInstanceMetadataFromPrimaryStorageEvent
+
+doc {
+	title "扫描主存储上的云主机元数据"
+
+	category "主存储"
+
+	desc """扫描指定主存储上所有云主机元数据文件，返回元数据摘要列表"""
+
+	rest {
+		request {
+			url "GET /v1/primary-storage/vm-instances/metadata/scan"
+
+			header (Authorization: 'OAuth the-session-uuid')
+
+			clz APIScanVmInstanceMetadataFromPrimaryStorageMsg.class
+
+			desc """"""
+
+			params {
+
+				column {
+					name "uuid"
+					enclosedIn ""
+					desc "主存储UUID"
+					location "query"
+					type "String"
+					optional false
+					since "5.0.0"
+				}
+				column {
+					name "systemTags"
+					enclosedIn ""
+					desc "系统标签"
+					location "query"
+					type "List"
+					optional true
+					since "5.0.0"
+				}
+				column {
+					name "userTags"
+					enclosedIn ""
+					desc "用户标签"
+					location "query"
+					type "List"
+					optional true
+					since "5.0.0"
+				}
+			}
+		}
+
+		response {
+			clz APIScanVmInstanceMetadataFromPrimaryStorageEvent.class
+		}
+	}
+}

header/src/main/java/org/zstack/header/storage/primary/CleanupVmInstanceMetadataOnPrimaryStorageMsg.java

@@ -0,0 +1,52 @@
+package org.zstack.header.storage.primary;
+
+import org.zstack.header.message.NeedReplyMessage;
+
+public class CleanupVmInstanceMetadataOnPrimaryStorageMsg extends NeedReplyMessage implements PrimaryStorageMessage {
+    private String primaryStorageUuid;
+    private String vmInstanceUuid;
+    private String rootVolumeUuid;
+    private String metadataPath;
+    private String hostUuid;
+
+    @Override
+    public String getPrimaryStorageUuid() {
+        return primaryStorageUuid;
+    }
+
+    public void setPrimaryStorageUuid(String primaryStorageUuid) {
+        this.primaryStorageUuid = primaryStorageUuid;
+    }
+
+    public String getVmInstanceUuid() {
+        return vmInstanceUuid;
+    }
+
+    public void setVmInstanceUuid(String vmInstanceUuid) {
+        this.vmInstanceUuid = vmInstanceUuid;
+    }
+
+    public String getRootVolumeUuid() {
+        return rootVolumeUuid;
+    }
+
+    public void setRootVolumeUuid(String rootVolumeUuid) {
+        this.rootVolumeUuid = rootVolumeUuid;
+    }
+
+    public String getMetadataPath() {
+        return metadataPath;
+    }
+
+    public void setMetadataPath(String metadataPath) {
+        this.metadataPath = metadataPath;
+    }
+
+    public String getHostUuid() {
+        return hostUuid;
+    }
+
+    public void setHostUuid(String hostUuid) {
+        this.hostUuid = hostUuid;
+    }
+}

header/src/main/java/org/zstack/header/storage/primary/CleanupVmInstanceMetadataOnPrimaryStorageReply.java

@@ -0,0 +1,6 @@
+package org.zstack.header.storage.primary;
+
+import org.zstack.header.message.MessageReply;
+
+public class CleanupVmInstanceMetadataOnPrimaryStorageReply extends MessageReply {
+}

header/src/main/java/org/zstack/header/storage/primary/GetVmInstanceMetadataFromPrimaryStorageMsg.java

@@ -0,0 +1,44 @@
+package org.zstack.header.storage.primary;
+
+import org.zstack.header.message.NeedReplyMessage;
+
+
+public class GetVmInstanceMetadataFromPrimaryStorageMsg extends NeedReplyMessage implements PrimaryStorageMessage {
+    private String primaryStorageUuid;
+    private String metadataPath;
+    private String rootVolumeUuid;
+    private String hostUuid;
+
+    @Override
+    public String getPrimaryStorageUuid() {
+        return primaryStorageUuid;
+    }
+
+    public void setPrimaryStorageUuid(String primaryStorageUuid) {
+        this.primaryStorageUuid = primaryStorageUuid;
+    }
+
+    public String getMetadataPath() {
+        return metadataPath;
+    }
+
+    public void setMetadataPath(String metadataPath) {
+        this.metadataPath = metadataPath;
+    }
+
+    public String getRootVolumeUuid() {
+        return rootVolumeUuid;
+    }
+
+    public void setRootVolumeUuid(String rootVolumeUuid) {
+        this.rootVolumeUuid = rootVolumeUuid;
+    }
+
+    public String getHostUuid() {
+        return hostUuid;
+    }
+
+    public void setHostUuid(String hostUuid) {
+        this.hostUuid = hostUuid;
+    }
+}

header/src/main/java/org/zstack/header/storage/primary/GetVmInstanceMetadataFromPrimaryStorageReply.java

@@ -0,0 +1,15 @@
+package org.zstack.header.storage.primary;
+
+import org.zstack.header.message.MessageReply;
+
+public class GetVmInstanceMetadataFromPrimaryStorageReply extends MessageReply {
+    private String metadata;
+
+    public String getMetadata() {
+        return metadata;
+    }
+
+    public void setMetadata(String metadata) {
+        this.metadata = metadata;
+    }
+}

header/src/main/java/org/zstack/header/storage/primary/ReadVmInstanceMetadataMsg.java

@@ -0,0 +1,21 @@
+package org.zstack.header.storage.primary;
+
+import org.zstack.header.message.NeedReplyMessage;
+import org.zstack.header.vm.VmInstanceMessage;
+
+public class ReadVmInstanceMetadataMsg extends NeedReplyMessage implements VmInstanceMessage {
+    private String uuid;
+
+    public String getUuid() {
+        return uuid;
+    }
+
+    public void setUuid(String uuid) {
+        this.uuid = uuid;
+    }
+
+    @Override
+    public String getVmInstanceUuid() {
+        return uuid;
+    }
+}

header/src/main/java/org/zstack/header/storage/primary/ReadVmInstanceMetadataReply.java

@@ -0,0 +1,15 @@
+package org.zstack.header.storage.primary;
+
+import org.zstack.header.message.MessageReply;
+
+public class ReadVmInstanceMetadataReply extends MessageReply {
+    private String vmMetadata;
+
+    public String getVmMetadata() {
+        return vmMetadata;
+    }
+
+    public void setVmMetadata(String vmMetadata) {
+        this.vmMetadata = vmMetadata;
+    }
+}