request

type AssignIPAddressRequest struct {
	Access     string          `json:"access,omitempty"`
	Family     string          `json:"family,omitempty"`
	ServerUUID string          `json:"server,omitempty"`
	Floating   upcloud.Boolean `json:"floating,omitempty"`
	MAC        string          `json:"mac,omitempty"`
	Zone       string          `json:"zone,omitempty"`
}

type AttachNetworkRouterRequest struct {
	NetworkUUID string `json:"-"`
	RouterUUID  string `json:"router"`
}

type AttachStorageRequest struct {
	ServerUUID string `json:"-"`

	Type        string `json:"type,omitempty"`
	Address     string `json:"address,omitempty"`
	StorageUUID string `json:"storage,omitempty"`
	BootDisk    int    `json:"boot_disk,omitempty,string"`
}

type CancelManagedDatabaseConnection struct {
	// UUID selects a managed database instance to manage queries of
	UUID string
	// Pid selects a connection pid to cancel or terminate
	Pid int
	// Terminate selects whether the connection will be forcefully terminated
	Terminate bool
}

type CloneManagedDatabaseRequest struct {
	// UUID selects an existing managed database instance to clone
	UUID string `json:"-"`
	// CloneTime selects a point-in-time from where to clone the data. Zero value selects the most recent available.
	CloneTime time.Time `json:"clone_time"`

	HostNamePrefix string                                `json:"hostname_prefix"`
	Maintenance    ManagedDatabaseMaintenanceTimeRequest `json:"maintenance,omitempty"`
	Plan           string                                `json:"plan"`
	Properties     ManagedDatabasePropertiesRequest      `json:"properties,omitempty"`
	Title          string                                `json:"title,omitempty"`
	Type           upcloud.ManagedDatabaseServiceType    `json:"type"`
	Zone           string                                `json:"zone"`
}

type CloneStorageRequest struct {
	UUID string `json:"-"`

	Zone  string `json:"zone"`
	Tier  string `json:"tier,omitempty"`
	Title string `json:"title"`
}

type CreateBackupRequest struct {
	UUID string `json:"-"`

	Title string `json:"title"`
}

type CreateFirewallRuleRequest struct {
	upcloud.FirewallRule

	ServerUUID string `json:"-"`
}

type CreateFirewallRulesRequest struct {
	ServerUUID string `json:"-"`

	FirewallRules FirewallRuleSlice `json:"firewall_rules"`
}

type CreateManagedDatabaseLogicalDatabaseRequest struct {
	// ServiceUUID selects a managed database service to modify
	ServiceUUID string `json:"-"`
	Name        string `json:"name"`
	// LCCollate represents a default string sort order of a logical database
	LCCollate string `json:"lc_collate"`
	// LCCType represents a default character classification of a logical database
	LCCType string `json:"lc_ctype"`
}

type CreateManagedDatabaseRequest struct {
	HostNamePrefix string                                `json:"hostname_prefix"`
	Maintenance    ManagedDatabaseMaintenanceTimeRequest `json:"maintenance,omitempty"`
	Plan           string                                `json:"plan"`
	Properties     ManagedDatabasePropertiesRequest      `json:"properties,omitempty"`
	Title          string                                `json:"title,omitempty"`
	Type           upcloud.ManagedDatabaseServiceType    `json:"type"`
	Zone           string                                `json:"zone"`
}

type CreateManagedDatabaseUserRequest struct {
	// ServiceUUID selects a managed database service to modify
	ServiceUUID string `json:"-"`
	Username    string `json:"username"`
	Password    string `json:"password,omitempty"`
	// Authentication selects authentication type for the user. See following constants for more information:
	// 	upcloud.ManagedDatabaseUserAuthenticationCachingSHA2Password
	// 	upcloud.ManagedDatabaseUserAuthenticationMySQLNativePassword
	Authentication upcloud.ManagedDatabaseUserAuthenticationType `json:"authentication,omitempty"`
}

type CreateNetworkInterfaceIPAddress struct {
	Family  string `json:"family"`
	Address string `json:"address,omitempty"`
}

type CreateNetworkInterfaceIPAddressSlice []CreateNetworkInterfaceIPAddress

type CreateNetworkInterfaceRequest struct {
	ServerUUID string `json:"-"`

	Type              string                               `json:"type"`
	NetworkUUID       string                               `json:"network,omitempty"`
	Index             int                                  `json:"index,omitempty"`
	IPAddresses       CreateNetworkInterfaceIPAddressSlice `json:"ip_addresses"`
	SourceIPFiltering upcloud.Boolean                      `json:"source_ip_filtering,omitempty"`
	Bootable          upcloud.Boolean                      `json:"bootable,omitempty"`
}

type CreateNetworkRequest struct {
	Name       string                 `json:"name,omitempty"`
	Zone       string                 `json:"zone,omitempty"`
	Router     string                 `json:"router,omitempty"`
	IPNetworks upcloud.IPNetworkSlice `json:"ip_networks,omitempty"`
}

type CreateObjectStorageRequest struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	Zone        string `json:"zone"`
	AccessKey   string `json:"access_key"`
	SecretKey   string `json:"secret_key"`
	Size        int    `json:"size"`
}

type CreateRouterRequest struct {
	Name string `json:"name"`
}

type CreateServerIPAddress struct {
	Family  string `json:"family"`
	Address string `json:"address,omitempty"`
}

type CreateServerIPAddressSlice []CreateServerIPAddress

type CreateServerInterface struct {
	IPAddresses       CreateServerIPAddressSlice `json:"ip_addresses"`
	Type              string                     `json:"type"`
	Network           string                     `json:"network,omitempty"`
	SourceIPFiltering upcloud.Boolean            `json:"source_ip_filtering,omitempty"`
	Bootable          upcloud.Boolean            `json:"bootable,omitempty"`
}

type CreateServerInterfaceSlice []CreateServerInterface

type CreateServerNetworking struct {
	Interfaces CreateServerInterfaceSlice `json:"interfaces"`
}

type CreateServerRequest struct {
	AvoidHost  int    `json:"avoid_host,omitempty"`
	Host       int    `json:"host,omitempty"`
	BootOrder  string `json:"boot_order,omitempty"`
	CoreNumber int    `json:"core_number,omitempty"`
	// TODO: Convert to boolean
	Firewall             string                         `json:"firewall,omitempty"`
	Hostname             string                         `json:"hostname"`
	LoginUser            *LoginUser                     `json:"login_user,omitempty"`
	MemoryAmount         int                            `json:"memory_amount,omitempty"`
	Metadata             upcloud.Boolean                `json:"metadata"`
	Networking           *CreateServerNetworking        `json:"networking"`
	PasswordDelivery     string                         `json:"password_delivery,omitempty"`
	Plan                 string                         `json:"plan,omitempty"`
	SimpleBackup         string                         `json:"simple_backup,omitempty"`
	StorageDevices       CreateServerStorageDeviceSlice `json:"storage_devices"`
	TimeZone             string                         `json:"timezone,omitempty"`
	Title                string                         `json:"title"`
	UserData             string                         `json:"user_data,omitempty"`
	VideoModel           string                         `json:"video_model,omitempty"`
	RemoteAccessEnabled  upcloud.Boolean                `json:"remote_access_enabled"`
	RemoteAccessType     string                         `json:"remote_access_type,omitempty"`
	RemoteAccessPassword string                         `json:"remote_access_password,omitempty"`
	Zone                 string                         `json:"zone"`
}

type CreateServerStorageDevice struct {
	Action  string `json:"action"`
	Address string `json:"address,omitempty"`
	Storage string `json:"storage"`
	Title   string `json:"title,omitempty"`
	// Storage size in gigabytes
	Size       int                 `json:"size,omitempty"`
	Tier       string              `json:"tier,omitempty"`
	Type       string              `json:"type,omitempty"`
	BackupRule *upcloud.BackupRule `json:"backup_rule,omitempty"`
}

type CreateServerStorageDeviceSlice []CreateServerStorageDevice

type CreateStorageImportRequest struct {
	StorageUUID string `json:"-"`
	// ContentType can be given when using the StorageImportSourceDirectUpload mode
	ContentType string `json:"-"`

	Source         string               `json:"source"`
	SourceLocation ImportSourceLocation `json:"source_location,omitempty"`
}

type CreateStorageRequest struct {
	Size       int                 `json:"size,string"`
	Tier       string              `json:"tier,omitempty"`
	Title      string              `json:"title,omitempty"`
	Zone       string              `json:"zone"`
	BackupRule *upcloud.BackupRule `json:"backup_rule,omitempty"`
}

type CreateTagRequest struct {
	upcloud.Tag
}

type DeleteFirewallRuleRequest struct {
	ServerUUID string
	Position   int
}

type DeleteManagedDatabaseLogicalDatabaseRequest struct {
	// ServiceUUID selects a managed database service to modify
	ServiceUUID string `json:"-"`
	Name        string `json:"-"`
}

type DeleteManagedDatabaseRequest struct {
	UUID string
}

type DeleteManagedDatabaseUserRequest struct {
	// ServiceUUID selects a managed database service to modify
	ServiceUUID string `json:"-"`
	// Username selects the username to delete
	Username string `json:"-"`
}

type DeleteNetworkInterfaceRequest struct {
	ServerUUID string
	Index      int
}

type DeleteNetworkRequest struct {
	UUID string
}

type DeleteObjectStorageRequest struct {
	UUID string
}

type DeleteRouterRequest struct {
	UUID string
}

type DeleteServerAndStoragesRequest struct {
	UUID string
}

type DeleteServerRequest struct {
	UUID string
}

type DeleteStorageRequest struct {
	UUID string
}

type DeleteTagRequest struct {
	Name string
}

type DetachNetworkRouterRequest struct {
	NetworkUUID string `json:"-"`
}

type DetachStorageRequest struct {
	ServerUUID string `json:"-"`

	Address string `json:"address"`
}

type EjectCDROMRequest struct {
	ServerUUID string
}

type FirewallRuleSlice []upcloud.FirewallRule

type GetFirewallRuleDetailsRequest struct {
	ServerUUID string
	Position   int
}

type GetFirewallRulesRequest struct {
	ServerUUID string
}

type GetHostDetailsRequest struct {
	ID int
}

type GetIPAddressDetailsRequest struct {
	Address string
}

type GetManagedDatabaseConnectionsRequest struct {
	// UUID selects a managed database instance to query connections from
	UUID string
	// Limit sets the upper bound how many connections to fetch
	Limit int
	// Offset skips n connections before returning them. It can be used to iteratively fetch connections.
	Offset int
}

type GetManagedDatabaseLogicalDatabasesRequest struct {
	// ServiceUUID selects a managed database service to query
	ServiceUUID string `json:"-"`
}

type GetManagedDatabaseLogsRequest struct {
	// UUID selects a managed database instance to query logs from
	UUID string
	// Limit sets the maximum number of logs to query in one go
	Limit int
	// Offset sets the offset from which to query logs onwards
	Offset string
	// Order sets the log sort order. See:
	// 	upcloud.ManagedDatabaseLogOrderAscending
	// 	upcloud.ManagedDatabaseLogOrderDescending
	Order upcloud.ManagedDatabaseLogOrder
}

type GetManagedDatabaseMetricsRequest struct {
	// UUID selects a managed database instance to query metrics from
	UUID string
	// Period selects the observation window. See:
	// 	upcloud.ManagedDatabaseMetricPeriodHour
	// 	upcloud.ManagedDatabaseMetricPeriodDay
	// 	upcloud.ManagedDatabaseMetricPeriodWeek
	// 	upcloud.ManagedDatabaseMetricPeriodMonth
	// 	upcloud.ManagedDatabaseMetricPeriodYear
	Period upcloud.ManagedDatabaseMetricPeriod
}

type GetManagedDatabaseQueryStatisticsRequest struct {
	// UUID selects a managed database instance to query statistics from
	UUID string
	// Limit sets the upper bound how many query stats to fetch
	Limit int
	// Offset skips n query stat rows before returning them. It can be used to iteratively fetch all.
	Offset int
}

type GetManagedDatabaseRequest struct {
	UUID string
}

type GetManagedDatabaseUserRequest struct {
	// ServiceUUID selects a managed database service to query
	ServiceUUID string `json:"-"`
	// Username selects the username to get
	Username string `json:"-"`
}

type GetManagedDatabaseUsersRequest struct {
	// ServiceUUID selects a managed database service to query
	ServiceUUID string `json:"-"`
}

type GetManagedDatabasesRequest struct{}

type GetNetworkDetailsRequest struct {
	UUID string
}

type GetNetworksInZoneRequest struct {
	Zone string
}

type GetObjectStorageDetailsRequest struct {
	UUID string
}

type GetRouterDetailsRequest struct {
	UUID string
}

type GetServerDetailsRequest struct {
	UUID string
}

type GetServerNetworksRequest struct {
	ServerUUID string
}

type GetStorageDetailsRequest struct {
	UUID string
}

type GetStorageImportDetailsRequest struct {
	UUID string
}

type GetStoragesRequest struct {
	// If specified, only storages with this access type will be retrieved
	Access string
	// If specified, only storages with this type will be retrieved
	Type string
	// If specified, only storages marked as favorite will be retrieved
	Favorite bool
}

type ImportSourceLocation interface{}

type LoadCDROMRequest struct {
	ServerUUID string `json:"-"`

	StorageUUID string `json:"storage"`
}

type LoginUser struct {
	CreatePassword string      `json:"create_password,omitempty"`
	Username       string      `json:"username,omitempty"`
	SSHKeys        SSHKeySlice `json:"ssh_keys,omitempty"`
}

type ManagedDatabaseMaintenanceTimeRequest struct {
	DayOfWeek string `json:"dow,omitempty"`
	Time      string `json:"time,omitempty"`
}

type ManagedDatabasePropertiesRequest map[upcloud.ManagedDatabasePropertyKey]interface{}

type ModifyHostRequest struct {
	ID          int    `json:"-"`
	Description string `json:"description"`
}

type ModifyIPAddressRequest struct {
	IPAddress string `json:"-"`

	PTRRecord string `json:"ptr_record,omitempty"`
	MAC       string `json:"mac,omitempty"`
}

type ModifyManagedDatabaseRequest struct {
	Maintenance ManagedDatabaseMaintenanceTimeRequest `json:"maintenance"`
	Plan        string                                `json:"plan,omitempty"`
	Properties  ManagedDatabasePropertiesRequest      `json:"properties,omitempty"`
	Title       string                                `json:"title,omitempty"`
	Type        upcloud.ManagedDatabaseServiceType    `json:"type,omitempty"`
	UUID        string                                `json:"-"`
	Zone        string                                `json:"zone,omitempty"`
}

type ModifyManagedDatabaseUserRequest struct {
	// ServiceUUID selects a managed database service to modify
	ServiceUUID string `json:"-"`
	// Username selects the username to modify. The username itself is immutable. To change it, recreate the user.
	Username string `json:"-"`
	Password string `json:"password,omitempty"`
	// Authentication selects authentication type for the user. See following constants for more information:
	// 	upcloud.ManagedDatabaseUserAuthenticationCachingSHA2Password
	// 	upcloud.ManagedDatabaseUserAuthenticationMySQLNativePassword
	Authentication upcloud.ManagedDatabaseUserAuthenticationType `json:"authentication,omitempty"`
}

type ModifyNetworkInterfaceRequest struct {
	ServerUUID   string `json:"-"`
	CurrentIndex int    `json:"-"`

	Type              string                               `json:"type,omitempty"`
	NetworkUUID       string                               `json:"network,omitempty"`
	NewIndex          int                                  `json:"index,omitempty"`
	IPAddresses       CreateNetworkInterfaceIPAddressSlice `json:"ip_addresses,omitempty"`
	SourceIPFiltering upcloud.Boolean                      `json:"source_ip_filtering,omitempty"`
	Bootable          upcloud.Boolean                      `json:"bootable,omitempty"`
}

type ModifyNetworkRequest struct {
	UUID string `json:"-"`

	Name       string                 `json:"name,omitempty"`
	Zone       string                 `json:"zone,omitempty"`
	IPNetworks upcloud.IPNetworkSlice `json:"ip_networks,omitempty"`
}

type ModifyObjectStorageRequest struct {
	UUID        string `json:"-"`
	Description string `json:"description,omitempty"`
	AccessKey   string `json:"access_key,omitempty"`
	SecretKey   string `json:"secret_key,omitempty"`
	Size        int    `json:"size,omitempty"`
}

type ModifyRouterRequest struct {
	UUID string `json:"-"`

	Name string `json:"name"`
}

type ModifyServerRequest struct {
	UUID string `json:"-"`

	BootOrder  string `json:"boot_order,omitempty"`
	CoreNumber int    `json:"core_number,omitempty,string"`
	// TODO: Convert to boolean
	Firewall             string          `json:"firewall,omitempty"`
	Hostname             string          `json:"hostname,omitempty"`
	MemoryAmount         int             `json:"memory_amount,omitempty,string"`
	Metadata             upcloud.Boolean `json:"metadata"`
	Plan                 string          `json:"plan,omitempty"`
	SimpleBackup         string          `json:"simple_backup,omitempty"`
	TimeZone             string          `json:"timezone,omitempty"`
	Title                string          `json:"title,omitempty"`
	VideoModel           string          `json:"video_model,omitempty"`
	RemoteAccessEnabled  upcloud.Boolean `json:"remote_access_enabled"`
	RemoteAccessType     string          `json:"remote_access_type,omitempty"`
	RemoteAccessPassword string          `json:"remote_access_password,omitempty"`
	Zone                 string          `json:"zone,omitempty"`
}

type ModifyStorageRequest struct {
	UUID string `json:"-"`

	Title      string              `json:"title,omitempty"`
	Size       int                 `json:"size,omitempty,string"`
	BackupRule *upcloud.BackupRule `json:"backup_rule,omitempty"`
}

type ModifyTagRequest struct {
	upcloud.Tag

	Name string `json:"-"`
}

type ReleaseIPAddressRequest struct {
	IPAddress string
}

type Request interface {
	// RequestURL returns the relative API URL for the request, excluding the API version.
	RequestURL() string
}

type RestartServerRequest struct {
	UUID string `json:"-"`

	StopType      string        `json:"stop_type,omitempty"`
	Timeout       time.Duration `json:"timeout,omitempty,string"`
	TimeoutAction string        `json:"timeout_action,omitempty"`
	Host          int           `json:"host,omitempty"`
}

type RestoreBackupRequest struct {
	UUID string
}

type SSHKeySlice []string

type ShutdownManagedDatabaseRequest struct {
	UUID string
}

type StartManagedDatabaseRequest struct {
	UUID string
}

type StartServerRequest struct {
	UUID string `json:"-"`

	// TODO: Start server requests have no timeout in the API
	Timeout time.Duration `json:"-"`

	AvoidHost int `json:"avoid_host,omitempty"`
	Host      int `json:"host,omitempty"`
}

type StopServerRequest struct {
	UUID string `json:"-"`

	StopType string        `json:"stop_type,omitempty"`
	Timeout  time.Duration `json:"timeout,omitempty,string"`
}

type TagServerRequest struct {
	UUID string
	Tags []string
}

type TemplatizeStorageRequest struct {
	UUID string `json:"-"`

	Title string `json:"title"`
}

type UntagServerRequest struct {
	UUID string
	Tags []string
}

type WaitForManagedDatabaseStateRequest struct {
	UUID         string
	DesiredState upcloud.ManagedDatabaseState
	Timeout      time.Duration
}

type WaitForServerStateRequest struct {
	UUID           string
	DesiredState   string
	UndesiredState string
	Timeout        time.Duration
}

type WaitForStorageImportCompletionRequest struct {
	StorageUUID string
	Timeout     time.Duration
}

type WaitForStorageStateRequest struct {
	UUID         string
	DesiredState string
	Timeout      time.Duration
}