resources

type AccessInfo struct {
	Endpoint   string `json:"Endpoint,omitempty" example:"https://1.2.3.4"`
	Kubeconfig string `json:"Kubeconfig,omitempty" example:"apiVersion: v1\nclusters:\n- cluster:\n ...."`
}

type AddonsInfo struct {
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type AnyCallHandler interface {
	AnyCall(callInfo AnyCallInfo) (AnyCallInfo, error)
}

type AnyCallInfo struct {
	FID           string     `json:"FID" validate:"required" example:"countAll"` // Function ID, ex: countAll
	IKeyValueList []KeyValue `json:"IKeyValueList" validate:"required"`          // Input Arguments List, ex:[{"Key": "rsType", "Value": "vpc"}]
	OKeyValueList []KeyValue `json:"OKeyValueList" validate:"required"`          // Output Results List, ex:[{"Key": "Count", "Value": "10"}]"
}

type CapacityGBRange struct {
	Min int64 `json:"Min" example:"100"`    // Minimum capacity in GB
	Max int64 `json:"Max" example:"102400"` // Maximum capacity in GB
}

type CloudPrice struct {
	Meta       Meta   `json:"Meta" validate:"required" description:"Metadata information about the price data"`
	CloudName  string `json:"CloudName" validate:"required" example:"AWS"`        // Name of the cloud provider
	RegionName string `json:"RegionName" validate:"required" example:"us-east-1"` // Name of the region

	PriceList []Price `json:"PriceList" validate:"required" description:"List of prices"` // List of prices for different services/products
}

type ClusterHandler interface {

	//------ Cluster Management
	ListIID() ([]*IID, error)
	CreateCluster(clusterReqInfo ClusterInfo) (ClusterInfo, error)
	ListCluster() ([]*ClusterInfo, error)
	GetCluster(clusterIID IID) (ClusterInfo, error)
	DeleteCluster(clusterIID IID) (bool, error)

	//------ Token Management
	GenerateClusterToken(clusterIID IID) (string, error)

	//------ NodeGroup Management
	AddNodeGroup(clusterIID IID, nodeGroupReqInfo NodeGroupInfo) (NodeGroupInfo, error)
	SetNodeGroupAutoScaling(clusterIID IID, nodeGroupIID IID, on bool) (bool, error)
	ChangeNodeGroupScaling(clusterIID IID, nodeGroupIID IID,
		DesiredNodeSize int, MinNodeSize int, MaxNodeSize int) (NodeGroupInfo, error)
	RemoveNodeGroup(clusterIID IID, nodeGroupIID IID) (bool, error)

	//------ Upgrade K8S
	UpgradeCluster(clusterIID IID, newVersion string) (ClusterInfo, error)
}

type ClusterInfo struct {
	IId IID `json:"IId" validate:"required"`

	Version string      `json:"Version" validate:"required" example:"1.30"` // Kubernetes Version, ex) 1.30
	Network NetworkInfo `json:"Network" validate:"required"`

	// ---
	NodeGroupList []NodeGroupInfo `json:"NodeGroupList" validate:"omitempty"`
	AccessInfo    AccessInfo      `json:"AccessInfo,omitempty"`
	Addons        AddonsInfo      `json:"Addons,omitempty"`

	Status ClusterStatus `json:"Status" validate:"required" example:"Active"`

	CreatedTime  time.Time  `json:"CreatedTime,omitempty" example:"2024-08-27T10:00:00Z"`
	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type ClusterStatus string

type CronSchedule struct {
	Minute     string `json:"Minute" default:"0"`     // 0-59, *
	Hour       string `json:"Hour" default:"5"`       // 0-23, *
	DayOfMonth string `json:"DayOfMonth" default:"*"` // 1-31, *
	Month      string `json:"Month" default:"*"`      // 1-12, *
	DayOfWeek  string `json:"DayOfWeek" default:"*"`  // 0-6 (Sunday=0), *
}

type DiskHandler interface {

	//------ Disk Management
	ListIID() ([]*IID, error)
	CreateDisk(DiskReqInfo DiskInfo) (DiskInfo, error)
	ListDisk() ([]*DiskInfo, error)
	GetDisk(diskIID IID) (DiskInfo, error)
	ChangeDiskSize(diskIID IID, size string) (bool, error)
	DeleteDisk(diskIID IID) (bool, error)

	//------ Disk Attachment
	AttachDisk(diskIID IID, ownerVM IID) (DiskInfo, error)
	DetachDisk(diskIID IID, ownerVM IID) (bool, error)
}

type DiskInfo struct {
	IId  IID    `json:"IId" validate:"required"`                       // {NameId, SystemId}
	Zone string `json:"Zone" validate:"required" example:"us-east-1a"` // Target Zone Name

	DiskType string `json:"DiskType" validate:"required" example:"gp2"` // "gp2", "Premium SSD", ...
	DiskSize string `json:"DiskSize" validate:"required" example:"100"` // "default", "50", "1000" (unit is GB)

	Status  DiskStatus `json:"Status" validate:"required" example:"Available"`
	OwnerVM IID        `json:"OwnerVM" validate:"omitempty"` // When the Status is DiskAttached

	CreatedTime  time.Time  `json:"CreatedTime" validate:"required"`             // The time when the disk was created
	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty"`      // A list of tags associated with this disk
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"` // Additional key-value pairs associated with this disk
}

type DiskStatus string

type FileSystemBackupInfo struct {
	FileSystemIID string       `json:"FileSystemIID" validate:"required"` // The File System IID to which this backup belongs
	Schedule      CronSchedule `json:"BackupSchedule,omitempty"`          // Cron schedule for backups, default is "0 5 * * *" (Every day at 5 AM)

	// for response only, not for request
	BackupID     string     `json:"BackupID" validate:"required"`
	CreationTime time.Time  `json:"CreationTime"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type FileSystemHandler interface {
	// Meta API
	GetMetaInfo() (FileSystemMetaInfo, error)

	// List all file system IDs, not detailed info
	ListIID() ([]*IID, error)

	// File System Management
	CreateFileSystem(reqInfo FileSystemInfo) (FileSystemInfo, error)
	ListFileSystem() ([]*FileSystemInfo, error)
	GetFileSystem(iid IID) (FileSystemInfo, error)
	DeleteFileSystem(iid IID) (bool, error)

	// Access Subnet Management
	AddAccessSubnet(iid IID, subnetIID IID) (FileSystemInfo, error) // Add a subnet to the file system for access; creates a mount target in the driver if needed
	RemoveAccessSubnet(iid IID, subnetIID IID) (bool, error)        // Remove a subnet from the file system access list; deletes the mount target if needed
	ListAccessSubnet(iid IID) ([]IID, error)                        // List of subnets whose VMs can use this file system

	// Backup Management
	ScheduleBackup(reqInfo FileSystemBackupInfo) (FileSystemBackupInfo, error) // Create a backup with the specified schedule
	OnDemandBackup(fsIID IID) (FileSystemBackupInfo, error)                    // Create an on-demand backup for the specified file system
	ListBackup(fsIID IID) ([]FileSystemBackupInfo, error)
	GetBackup(fsIID IID, backupID string) (FileSystemBackupInfo, error)
	DeleteBackup(fsIID IID, backupID string) (bool, error)
}

type FileSystemInfo struct {
	IId              IID    `json:"IId" validate:"required"` // {NameId, SystemId}
	Region           string `json:"Region,omitempty" example:"us-east-1"`
	Zone             string `json:"Zone,omitempty" example:"us-east-1a"`
	VpcIID           IID    `json:"VpcIID" validate:"required"` // Owner VPC IID
	AccessSubnetList []IID  `json:"AccessSubnetList,omitempty"` // List of subnets whose VMs can use this file system

	Encryption     bool                 `json:"Encryption,omitempty" default:"false"` // Encryption enabled or not
	BackupSchedule FileSystemBackupInfo `json:"BackupSchedule,omitempty"`             // Cron schedule for backups, default is "0 5 * * *" (Every day at 5 AM)
	TagList        []KeyValue           `json:"TagList,omitempty" validate:"omitempty"`

	//**************************************************************************************************
	//** (1) Basic setup: If not set by the user, these fields use CSP default values.
	//** (2) Advanced setup: If set by the user, these fields enable CSP-specific file system features.
	//**************************************************************************************************
	FileSystemType FileSystemType `json:"FileSystemType,omitempty" example:"RegionType"` // RegionType, ZoneType; CSP default if omitted
	NFSVersion     string         `json:"NFSVersion" validate:"required" example:"4.1"`  // NFS protocol version, e.g., "3.0", "4.1"; CSP default if omitted
	CapacityGB     int64          `json:"CapacityGB,omitempty" example:"1024"`           // Capacity in GB, -1 when not applicable. Ignored if CSP unsupported.; CSP default if omitted
	// Each key/value must match one of the PerformanceOptions provided by the cloud driver for the selected file system type.
	PerformanceInfo map[string]string `json:"PerformanceInfo,omitempty"` // Performance options, e.g., {"Tier": "STANDARD"}, {"ThroughputMode": "provisioned", "Throughput": "128"}; CSP default if omitted

	// only for response, not for request
	Status          FileSystemStatus  `json:"Status" validate:"required" example:"Available"`
	UsedSizeGB      int64             `json:"UsedSizeGB" validate:"required" example:"256"` // Current used size in GB.
	MountTargetList []MountTargetInfo `json:"MountTargetList,omitempty"`

	CreatedTime  time.Time  `json:"CreatedTime" validate:"required"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"` // Additional key-value pairs associated with this File System
}

type FileSystemMetaInfo struct {
	// filled by the cloud driver
	SupportsFileSystemType map[FileSystemType]bool    `json:"SupportsFileSystemType"`       // e.g., {"RegionType": true, "ZoneType": true, "RegionZoneBasedType": true, ...}
	SupportsVPC            map[RSType]bool            `json:"SupportsVPC"`                  // e.g., {"VPC": true} or {"VPC": false} (if not supported)
	SupportsNFSVersion     []string                   `json:"SupportsNFSVersion"`           // e.g., ["3.0", "4.1"]
	SupportsCapacity       bool                       `json:"SupportsCapacity"`             // true if capacity can be specified
	CapacityGBOptions      map[string]CapacityGBRange `json:"CapacityGBOptions,omitempty"`  // Capacity ranges per file system option (valid only if SupportsCapacity is true). e.g., GCP Filestore: {"Basic": {Min: 1024, Max: 65229}, "Zonal": {Min: 1024, Max: 102400}, "Regional": {Min: 1024, Max: 102400}}
	PerformanceOptions     map[string][]string        `json:"PerformanceOptions,omitempty"` // Available performance settings per file system option. e.g., {"Basic": ["STANDARD"], "Zonal": ["HIGH_SCALE", "EXTREME"]}
}

type FileSystemStatus string

type FileSystemType string

type GpuInfo struct {
	Count          string `json:"Count" validate:"required" example:"2"`                      // Number of GPUs, "-1" when not applicable
	Mfr            string `json:"Mfr,omitempty" validate:"omitempty" example:"NVIDIA"`        // Manufacturer of the GPU, NA when not applicable
	Model          string `json:"Model,omitempty" validate:"omitempty" example:"Tesla K80"`   // Model of the GPU, NA when not applicable
	MemSizeGB      string `json:"MemSizeGB,omitempty" validate:"omitempty" example:"12"`      // Memory size of the GPU in GB, "-1" when not applicable
	TotalMemSizeGB string `json:"TotalMemSizeGB,omitempty" validate:"omitempty" example:"24"` // Total Memory size of the GPU in GB, "-1" when not applicable
}

type HealthCheckerInfo struct {
	Protocol  string `json:"Protocol" validate:"required" example:"TCP"` // TCP|HTTP
	Port      string `json:"Port" validate:"required" example:"80"`      // Listener Port or 1-65535
	Interval  int    `json:"Interval" validate:"required" example:"30"`  // secs, Interval time between health checks.
	Timeout   int    `json:"Timeout" validate:"required" example:"5"`    // secs, Waiting time to decide an unhealthy VM when no response.
	Threshold int    `json:"Threshold" validate:"required" example:"3"`  // num, The number of continuous health checks to change the VM status.

	CspID        string     `json:"CspID,omitempty" validate:"omitempty"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type HealthInfo struct {
	AllVMs       *[]IID `json:"AllVMs" validate:"required"`
	HealthyVMs   *[]IID `json:"HealthyVMs" validate:"required"`
	UnHealthyVMs *[]IID `json:"UnHealthyVMs" validate:"required"`
}

type IID struct {
	NameId   string `json:"NameId" validate:"required" example:"user-defined-name"`
	SystemId string `json:"SystemId" validate:"required" example:"csp-defined-id"`
}

type ImageHandler interface {
	CreateImage(imageReqInfo ImageReqInfo) (ImageInfo, error)
	ListImage() ([]*ImageInfo, error)
	GetImage(imageIID IID) (ImageInfo, error)
	CheckWindowsImage(imageIID IID) (bool, error)
	DeleteImage(imageIID IID) (bool, error)
}

type ImageInfo struct {
	IId IID `json:"IId" validate:"required" description:"The ID of the image."` // {NameId, SystemId}, {ami-00aa5a103ddf4509f, ami-00aa5a103ddf4509f}

	Name           string         `json:"Name" validate:"required" example:"ami-00aa5a103ddf4509f" description:"The name of the image."` // ami-00aa5a103ddf4509f
	OSArchitecture OSArchitecture ``                                                                                                     // arm64, x86_64 etc.
	/* 127-byte string literal not displayed */
	OSPlatform     OSPlatform `json:"OSPlatform" validate:"required" example:"Linux/UNIX" description:"The platform of the operating system of the image."` // Linux/UNIX, Windows, NA
	OSDistribution string     ``                                                                                                                            // Ubuntu 22.04~, CentOS 8 etc.
	/* 134-byte string literal not displayed */
	OSDiskType   string `json:"OSDiskType" validate:"required" example:"HDD" description:"The type of the OS disk of for the VM being created."`        // ebs, HDD, etc.
	OSDiskSizeGB string `json:"OSDiskSizeGB" validate:"required" example:"50" description:"The (minimum) OS disk size in GB for the VM being created."` // 10, 50, 100 etc.

	ImageStatus ImageStatus `` // Available, Unavailable
	/* 129-byte string literal not displayed */

	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty" description:"A list of key-value pairs associated with the image."`
}

type ImageReqInfo struct {
	IId IID // {NameId, SystemId}

}

type ImageStatus string

type ImageType string

type KeyPairHandler interface {
	CreateKey(keyPairReqInfo KeyPairReqInfo) (KeyPairInfo, error)
	ListKey() ([]*KeyPairInfo, error)
	GetKey(keyIID IID) (KeyPairInfo, error)
	DeleteKey(keyIID IID) (bool, error)
	ListIID() ([]*IID, error)
}

type KeyPairInfo struct {
	IId         IID    `json:"IId" validate:"required"`                                                                              // {NameId, SystemId}
	Fingerprint string `json:"Fingerprint,omitempty" validate:"omitempty" example:"3b:16:bf:1b:13:4b:b3:58:97:dc:72:19:45:bb:2c:8f"` // Unique identifier for the public key
	PublicKey   string `json:"PublicKey,omitempty" validate:"omitempty" example:"ssh-rsa AAAAB3..."`                                 // Public part of the KeyPair
	PrivateKey  string `json:"PrivateKey,omitempty" validate:"omitempty" example:"-----BEGIN PRIVATE KEY-----..."`                   // Private part of the KeyPair
	VMUserID    string `json:"VMUserID,omitempty" validate:"omitempty" example:"cb-user"`                                            // cb-user or Administrator

	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty"`      // List of tags associated with this KeyPair
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"` // Additional metadata as key-value pairs
}

type KeyPairReqInfo struct {
	IId IID // {NameId, SystemId}

	TagList []KeyValue
}

type KeyValue struct {
	Key   string `json:"Key" validate:"required" example:"key1"`
	Value string `json:"Value,omitempty" validate:"omitempty"  example:"value1"`
}

type ListenerInfo struct {
	Protocol string `json:"Protocol" validate:"required" example:"TCP"` // TCP|UDP
	IP       string `json:"IP" validate:"omitempty" example:"192.168.0.1"`
	Port     string `json:"Port" validate:"required" example:"80"` // 1-65535
	DNSName  string `json:"DNSName" validate:"omitempty" example:"nlb.example.com"`

	CspID        string     `json:"CspID,omitempty" validate:"omitempty"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type Meta struct {
	Version     string `json:"Version" validate:"required" example:"1.0"`        // Version of the pricing data
	Description string `json:"Description,omitempty" example:"Cloud price data"` // Description of the pricing data
}

type MountTargetInfo struct {
	SubnetIID IID `json:"SubnetIID,omitempty"` // location of the mount target

	SecurityGroups      []string   `json:"SecurityGroups,omitempty"`                    // security groups associated with the mount target
	Endpoint            string     `json:"Endpoint,omitempty"`                          // mount target endpoint (IP, DNS, URL)
	MountCommandExample string     `json:"MountCommandExample,omitempty"`               // Example mount command
	KeyValueList        []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"` // Additional key-value pairs associated with this mount target
}

type MyImageHandler interface {

	//------ Snapshot to create a MyImage
	SnapshotVM(snapshotReqInfo MyImageInfo) (MyImageInfo, error)

	//------ MyImage Management
	ListIID() ([]*IID, error)
	ListMyImage() ([]*MyImageInfo, error)
	GetMyImage(myImageIID IID) (MyImageInfo, error)
	CheckWindowsImage(myImageIID IID) (bool, error)
	DeleteMyImage(myImageIID IID) (bool, error)
}

type MyImageInfo struct {
	IId      IID `json:"IId" validate:"required"` // {NameId, SystemId}
	SourceVM IID `json:"SourceVM" validate:"omitempty"`

	Status MyImageStatus `json:"Status" validate:"required" example:"Available"` // Available | Unavailable

	CreatedTime  time.Time  `json:"CreatedTime" validate:"required"`
	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type MyImageStatus string

type NLBHandler interface {

	//------ NLB Management
	ListIID() ([]*IID, error)
	CreateNLB(nlbReqInfo NLBInfo) (NLBInfo, error)
	ListNLB() ([]*NLBInfo, error)
	GetNLB(nlbIID IID) (NLBInfo, error)
	DeleteNLB(nlbIID IID) (bool, error)

	GetVMGroupHealthInfo(nlbIID IID) (HealthInfo, error)
	AddVMs(nlbIID IID, vmIIDs *[]IID) (VMGroupInfo, error)
	RemoveVMs(nlbIID IID, vmIIDs *[]IID) (bool, error)

	//------ Frontend Control
	ChangeListener(nlbIID IID, listener ListenerInfo) (ListenerInfo, error)
	//------ Backend Control
	ChangeVMGroupInfo(nlbIID IID, vmGroup VMGroupInfo) (VMGroupInfo, error)
	ChangeHealthCheckerInfo(nlbIID IID, healthChecker HealthCheckerInfo) (HealthCheckerInfo, error)
}

type NLBInfo struct {
	IId    IID `json:"IId" validate:"required"`
	VpcIID IID `json:"VpcIID" validate:"required"` // Owner VPC IID

	Type  string `json:"Type" validate:"required" example:"PUBLIC"`  // PUBLIC(V) | INTERNAL
	Scope string `json:"Scope" validate:"required" example:"REGION"` // REGION(V) | GLOBAL

	//------ Frontend
	Listener ListenerInfo `json:"Listener" validate:"required"`

	//------ Backend
	VMGroup       VMGroupInfo       `json:"VMGroup" validate:"required"`
	HealthChecker HealthCheckerInfo `json:"HealthChecker" validate:"required"`

	CreatedTime  time.Time  `json:"CreatedTime" validate:"required" example:"2024-08-27T10:00:00Z"`
	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type NetworkInfo struct {
	VpcIID            IID   `json:"VpcIID" validate:"required"`
	SubnetIIDs        []IID `json:"SubnetIIDs" validate:"required"`
	SecurityGroupIIDs []IID `json:"SecurityGroupIIDs" validate:"required"`

	// ---
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type NodeGroupInfo struct {
	IId IID `json:"IId" validate:"required"`

	// VM config.
	ImageIID     IID    `json:"ImageIID" validate:"required"`
	VMSpecName   string `json:"VMSpecName" validate:"required" example:"t3.medium"`
	RootDiskType string `json:"RootDiskType,omitempty" validate:"omitempty"`
	RootDiskSize string `json:"RootDiskSize,omitempty" validate:"omitempty" example:"50"` // in GB
	KeyPairIID   IID    `json:"KeyPairIID" validate:"required"`

	// Scaling config.
	OnAutoScaling   bool `json:"OnAutoScaling" validate:"required" example:"true"`
	DesiredNodeSize int  `json:"DesiredNodeSize" validate:"required" example:"2"`
	MinNodeSize     int  `json:"MinNodeSize" validate:"required" example:"1"`
	MaxNodeSize     int  `json:"MaxNodeSize" validate:"required" example:"3"`

	// ---
	Status NodeGroupStatus `json:"Status" validate:"required" example:"Active"`
	Nodes  []IID           `json:"Nodes,omitempty" validate:"omitempty"`

	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type NodeGroupStatus string

type OSArchitecture string

type OSPlatform string

type OnDemand struct {
	PricingId   string `json:"PricingId" validate:"required" example:"price-123"`    // ID of the pricing policy
	Unit        string `json:"Unit" validate:"required" example:"Hour"`              // Unit of the pricing (e.g., per hour)
	Currency    string `json:"Currency" validate:"required" example:"USD"`           // Currency of the pricing
	Price       string `json:"Price" validate:"required" example:"0.02"`             // Price in the specified currency per unit
	Description string `json:"Description,omitempty" example:"Pricing for t2.micro"` // Description of the pricing policy
}

type Platform string

type Price struct {
	ZoneName    string      `json:"ZoneName,omitempty" example:"us-east-1a"`                                     // Name of the zone
	ProductInfo ProductInfo `json:"ProductInfo" validate:"required" description:"Information about the product"` // Information about the product
	PriceInfo   PriceInfo   `json:"PriceInfo" validate:"required" description:"Pricing details of the product"`  // Pricing details of the product
}

type PriceInfo struct {
	OnDemand     OnDemand    `json:"OnDemand" validate:"required" description:"Ondemand pricing details"`  // Ondemand pricing details
	CSPPriceInfo interface{} `json:"CSPPriceInfo" validate:"required" description:"Additional price info"` // Additional price information specific to CSP
}

type PriceInfoHandler interface {
	ListProductFamily(regionName string) ([]string, error)
	GetPriceInfo(productFamily string, regionName string, filterList []KeyValue, simpleVMSpecInfo bool) (string, error) // return string: json format
}

type ProductInfo struct {
	ProductId      string      `json:"ProductId" validate:"required" example:"prod-123"`                                      // ID of the product
	VMSpecName     string      `json:"VMSpecName,omitempty" validate:"omitempty" example:"t2.micro"`                          // Name of the VM spec (used in simple mode)
	VMSpecInfo     *VMSpecInfo `json:"VMSpecInfo,omitempty" validate:"omitempty" description:"Information about the VM spec"` // Information about the VM spec (used in detailed mode, default mode)
	Description    string      `json:"Description,omitempty" example:"General purpose instance"`                              // Description of the product
	CSPProductInfo interface{} `json:"CSPProductInfo" validate:"required" description:"Additional product info"`              // Additional product information specific to CSP
}

type RSType string

type RegionInfo struct {
	Region string `json:"Region" validate:"required" example:"us-east-1"`
	Zone   string `json:"Zone,omitempty" validate:"omitempty" example:"us-east-1a"`
}

type RegionZoneHandler interface {
	ListRegionZone() ([]*RegionZoneInfo, error)
	GetRegionZone(Name string) (RegionZoneInfo, error)

	ListOrgRegion() (string, error) // return string: json format
	ListOrgZone() (string, error)   // return string: json format
}

type RegionZoneInfo struct {
	Name           string     `json:"Name" validate:"required" example:"us-east"`
	DisplayName    string     `json:"DisplayName" validate:"required" example:"United States, Ohio"`
	CSPDisplayName string     `json:"CSPDisplayName" validate:"required" example:"US East (N. Virginia)"`
	ZoneList       []ZoneInfo `json:"ZoneList,omitempty" validate:"omitempty"`
	KeyValueList   []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type SecurityHandler interface {
	ListIID() ([]*IID, error)

	CreateSecurity(securityReqInfo SecurityReqInfo) (SecurityInfo, error)
	ListSecurity() ([]*SecurityInfo, error)
	GetSecurity(securityIID IID) (SecurityInfo, error)
	DeleteSecurity(securityIID IID) (bool, error)

	AddRules(sgIID IID, securityRules *[]SecurityRuleInfo) (SecurityInfo, error)
	RemoveRules(sgIID IID, securityRules *[]SecurityRuleInfo) (bool, error)
}

type SecurityInfo struct {
	IId IID `json:"IId" validate:"required"` // {NameId, SystemId}

	VpcIID IID `json:"VpcIID" validate:"required"` // {NameId, SystemId}

	SecurityRules *[]SecurityRuleInfo `json:"SecurityRules" validate:"required" description:"A list of security rules applied to this security group"`

	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty" description:"A list of tags associated with this security group"`
	KeyValueList []KeyValue `` /* 127-byte string literal not displayed */
}

type SecurityReqInfo struct {
	IId IID // {NameId, SystemId}

	VpcIID IID // {NameId, SystemId}
	//Direction     string // To be deprecated
	SecurityRules *[]SecurityRuleInfo

	TagList []KeyValue
}

type SecurityRuleInfo struct {
	Direction  string `json:"Direction" validate:"required" example:"inbound"`         // inbound or outbound
	IPProtocol string `json:"IPProtocol" validate:"required" example:"TCP"`            // TCP, UDP, ICMP, ALL
	FromPort   string `json:"FromPort" validate:"required" example:"22"`               // TCP, UDP: 1~65535, ICMP, ALL: -1
	ToPort     string `json:"ToPort" validate:"required" example:"22"`                 // TCP, UDP: 1~65535, ICMP, ALL: -1
	CIDR       string `json:"CIDR,omitempty" validate:"omitempty" example:"0.0.0.0/0"` // if not specified, defaults to 0.0.0.0/0
}

type SubnetInfo struct {
	IId       IID    `json:"IId" validate:"required"` // {NameId, SystemId}
	Zone      string `json:"Zone" validate:"required" example:"us-east-1a"`
	IPv4_CIDR string `json:"IPv4_CIDR" validate:"required" example:"10.0.8.0/22" description:"The IPv4 CIDR block for the subnet"`

	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty" description:"A list of tags associated with this subnet"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty" description:"Additional key-value pairs associated with this subnet"`
}

type TagHandler interface {
	AddTag(resType RSType, resIID IID, tag KeyValue) (KeyValue, error)
	ListTag(resType RSType, resIID IID) ([]KeyValue, error)
	GetTag(resType RSType, resIID IID, key string) (KeyValue, error)
	RemoveTag(resType RSType, resIID IID, key string) (bool, error)

	// Find tags by tag key or value
	// resType: ALL | VPC, SUBNET, etc.,.
	// keyword: The keyword to search for in the tag key or value.
	// if you want to find all tags, set keyword to "" or "*".
	FindTag(resType RSType, keyword string) ([]*TagInfo, error)
}

type TagInfo struct {
	ResType RSType `json:"ResType" validate:"required" example:"VPC"`
	ResIId  IID    `json:"ResIId" validate:"required"`

	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type VCpuInfo struct {
	Count    string `json:"Count" validate:"required" example:"2"`                 // Number of VCpu, "-1" when not applicable
	ClockGHz string `json:"ClockGHz,omitempty" validate:"omitempty" example:"2.5"` // Clock speed in GHz, "-1" when not applicable
}

type VMGroupInfo struct {
	Protocol string `json:"Protocol" validate:"required" example:"TCP"` // TCP|UDP
	Port     string `json:"Port" validate:"required" example:"8080"`    // 1-65535
	VMs      *[]IID `json:"VMs" validate:"required"`

	CspID        string     `json:"CspID,omitempty" validate:"omitempty"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type VMHandler interface {
	ListIID() ([]*IID, error)

	StartVM(vmReqInfo VMReqInfo) (VMInfo, error)

	SuspendVM(vmIID IID) (VMStatus, error)
	ResumeVM(vmIID IID) (VMStatus, error)
	RebootVM(vmIID IID) (VMStatus, error)
	TerminateVM(vmIID IID) (VMStatus, error)

	ListVMStatus() ([]*VMStatusInfo, error)
	GetVMStatus(vmIID IID) (VMStatus, error)

	ListVM() ([]*VMInfo, error)
	GetVM(vmIID IID) (VMInfo, error)
}

type VMInfo struct {
	IId       IID       `json:"IId" validate:"required"`                                      // example:"{NameId: 'vm-01', SystemId: 'i-12345678'}"
	StartTime time.Time `json:"StartTime" validate:"required" example:"2024-08-27T10:00:00Z"` // Timezone: based on cloud-barista server location.

	Region            RegionInfo `json:"Region" validate:"required"`                          // example:"{Region: 'us-east-1', Zone: 'us-east-1a'}"
	ImageType         ImageType  `json:"ImageType" validate:"required" example:"PublicImage"` // PublicImage | MyImage
	ImageIId          IID        `json:"ImageIId" validate:"required"`                        // example:"{NameId: 'ami-12345678', SystemId: 'ami-12345678'}"
	VMSpecName        string     `json:"VMSpecName" validate:"required" example:"t2.micro"`   // instance type or flavour, etc... ex) t2.micro or f1.micro
	VpcIID            IID        `json:"VpcIID" validate:"required"`                          // example:"{NameId: 'vpc-01', SystemId: 'vpc-12345678'}"
	SubnetIID         IID        `json:"SubnetIID" validate:"required"`                       // example:"{NameId: 'subnet-01', SystemId: 'subnet-12345678'}"
	SecurityGroupIIds []IID      `json:"SecurityGroupIIds" validate:"required"`               // example:"[{NameId: 'sg-01', SystemId: 'sg-12345678'}]"

	KeyPairIId IID `json:"KeyPairIId" validate:"required"` // example:"{NameId: 'keypair-01', SystemId: 'keypair-12345678'}"

	RootDiskType   string `json:"RootDiskType" validate:"required" example:"gp2"`         // "gp2", "Premium SSD", ...
	RootDiskSize   string `json:"RootDiskSize" validate:"required" example:"50"`          // "default", "50", "1000" (unit is GB)
	RootDeviceName string `json:"RootDeviceName" validate:"required" example:"/dev/sda1"` // "/dev/sda1", ...

	DataDiskIIDs []IID `json:"DataDiskIIDs,omitempty" validate:"omitempty"` // example:"[{NameId: 'datadisk-01', SystemId: 'datadisk-12345678'}]"

	VMBootDisk  string `json:"VMBootDisk,omitempty" validate:"omitempty" example:"/dev/sda1"`  // Deprecated soon
	VMBlockDisk string `json:"VMBlockDisk,omitempty" validate:"omitempty" example:"/dev/sda2"` // Deprecated soon

	VMUserId     string `json:"VMUserId" validate:"required" example:"cb-user"`                     // cb-user or Administrator
	VMUserPasswd string `json:"VMUserPasswd,omitempty" validate:"omitempty" example:"password1234"` // Only for Windows

	NetworkInterface string `json:"NetworkInterface" validate:"required" example:"eni-12345678"`
	PublicIP         string `json:"PublicIP" validate:"required" example:"1.2.3.4"`
	PublicDNS        string `json:"PublicDNS,omitempty" validate:"omitempty" example:"ec2-1-2-3-4.compute-1.amazonaws.com"`
	PrivateIP        string `json:"PrivateIP" validate:"required" example:"192.168.1.1"`
	PrivateDNS       string `json:"PrivateDNS,omitempty" validate:"omitempty" example:"ip-192-168-1-1.ec2.internal"`

	Platform Platform `json:"Platform" validate:"required" example:"LINUX"` // LINUX | WINDOWS

	SSHAccessPoint string `json:"SSHAccessPoint,omitempty" validate:"omitempty" example:"10.2.3.2:22"` // Deprecated
	AccessPoint    string `json:"AccessPoint" validate:"required" example:"1.2.3.4:22"`                // 10.2.3.2:22, 123.456.789.123:432

	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty"`      // example:"[{Key: 'Name', Value: 'MyVM'}]"
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"` // example:"[{Key: 'Architecture', Value: 'x86_64'}]"
}

type VMReqInfo struct {
	IId IID // {NameId, SystemId}

	ImageType         ImageType // PublicImage | MyImage, default: PublicImage
	ImageIID          IID
	VpcIID            IID
	SubnetIID         IID
	SecurityGroupIIDs []IID

	VMSpecName string
	KeyPairIID IID

	RootDiskType string // "", "SSD(gp2)", "Premium SSD", ...
	RootDiskSize string // "", "default", "50", "1000" (unit is GB)

	DataDiskIIDs []IID

	VMUserId     string
	VMUserPasswd string
	WindowsType  bool

	TagList []KeyValue
}

type VMSpecHandler interface {
	ListVMSpec() ([]*VMSpecInfo, error)
	GetVMSpec(Name string) (VMSpecInfo, error)

	ListOrgVMSpec() (string, error)           // return string: json format
	GetOrgVMSpec(Name string) (string, error) // return string: json format
}

type VMSpecInfo struct {
	Region     string    `json:"Region" validate:"required" example:"us-east-1"` // Region where the VM spec is available
	Name       string    `json:"Name" validate:"required" example:"t2.micro"`    // Name of the VM spec
	VCpu       VCpuInfo  `json:"VCpu" validate:"required"`                       // CPU details of the VM spec
	MemSizeMiB string    `json:"MemSizeMiB" validate:"required" example:"1024"`  // Memory size in MiB
	DiskSizeGB string    `json:"DiskSizeGB" validate:"required" example:"8"`     // Disk size in GB, "-1" when not applicable
	Gpu        []GpuInfo `json:"Gpu,omitempty" validate:"omitempty"`             // GPU details if available

	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"` // Additional key-value pairs for the VM spec
}

type VMStatus string

type VMStatusInfo struct {
	IId      IID      `json:"IId" validate:"required" example:"` // {NameId: 'vm-01', SystemId: 'i-12345678'}"
	VmStatus VMStatus `json:"VmStatus" validate:"required" example:"Running"`
}

type VPCHandler interface {
	ListIID() ([]*IID, error)
	CreateVPC(vpcReqInfo VPCReqInfo) (VPCInfo, error)
	ListVPC() ([]*VPCInfo, error)
	GetVPC(vpcIID IID) (VPCInfo, error)
	DeleteVPC(vpcIID IID) (bool, error)

	AddSubnet(vpcIID IID, subnetInfo SubnetInfo) (VPCInfo, error)
	RemoveSubnet(vpcIID IID, subnetIID IID) (bool, error)
}

type VPCInfo struct {
	IId            IID          `json:"IId" validate:"required"` // {NameId, SystemId}
	IPv4_CIDR      string       `json:"IPv4_CIDR" validate:"required" example:"10.0.0.0/16" description:"The IPv4 CIDR block for the VPC"`
	SubnetInfoList []SubnetInfo `json:"SubnetInfoList" validate:"required" description:"A list of subnet information associated with this VPC"`

	TagList      []KeyValue `json:"TagList,omitempty" validate:"omitempty" description:"A list of tags associated with this VPC"`
	KeyValueList []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty" description:"Additional key-value pairs associated with this VPC"`
}

type VPCReqInfo struct {
	IId            IID // {NameId, SystemId}
	IPv4_CIDR      string
	SubnetInfoList []SubnetInfo

	TagList []KeyValue
}

type ZoneInfo struct {
	Name           string     `json:"Name" validate:"required" example:"us-east-1a"`
	DisplayName    string     `json:"DisplayName" validate:"required" example:"United States, Ohio"`
	CSPDisplayName string     `json:"CSPDisplayName" validate:"required" example:"US East (N. Virginia)"`
	Status         ZoneStatus `json:"Status" validate:"required" example:"Available"`
	KeyValueList   []KeyValue `json:"KeyValueList,omitempty" validate:"omitempty"`
}

type ZoneStatus string