rdb

type ACLRule struct {
	IP scw.IPNet `json:"ip"`
	// Deprecated
	Port *uint32 `json:"port,omitempty"`
	// Protocol:
	// Default value: tcp
	Protocol ACLRuleProtocol `json:"protocol"`
	// Direction:
	// Default value: inbound
	Direction ACLRuleDirection `json:"direction"`
	// Action:
	// Default value: allow
	Action ACLRuleAction `json:"action"`

	Description string `json:"description"`
}

type ACLRuleAction string

type ACLRuleDirection string

type ACLRuleProtocol string

type ACLRuleRequest struct {
	IP scw.IPNet `json:"ip"`

	Description string `json:"description"`
}

type API struct {
	// contains filtered or unexported fields
}

type AddInstanceACLRulesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want to add acl rules to.
	InstanceID string `json:"-"`
	// Rules: aCLs rules to add to the instance.
	Rules []*ACLRuleRequest `json:"rules"`
}

type AddInstanceACLRulesResponse struct {
	// Rules: rules enabled on the instance.
	Rules []*ACLRule `json:"rules"`
}

type AddInstanceSettingsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want to add settings to.
	InstanceID string `json:"-"`
	// Settings: settings to add on the instance.
	Settings []*InstanceSetting `json:"settings"`
}

type AddInstanceSettingsResponse struct {
	// Settings: settings available on the instance.
	Settings []*InstanceSetting `json:"settings"`
}

type BackupSchedule struct {
	Frequency uint32 `json:"frequency"`

	Retention uint32 `json:"retention"`

	Disabled bool `json:"disabled"`
}

type CloneInstanceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want to clone.
	InstanceID string `json:"-"`
	// Name: name of the clone instance.
	Name string `json:"name"`
	// NodeType: node type of the clone.
	NodeType *string `json:"node_type"`
}

type CreateDatabaseBackupRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"instance_id"`
	// DatabaseName: name of the database you want to make a backup of.
	DatabaseName string `json:"database_name"`
	// Name: name of the backup.
	Name string `json:"name"`
	// ExpiresAt: expiration date (Format ISO 8601).
	ExpiresAt *time.Time `json:"expires_at"`
}

type CreateDatabaseRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance where to create the database.
	InstanceID string `json:"-"`
	// Name: name of the database.
	Name string `json:"name"`
}

type CreateEndpointRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want to add endpoint to.
	InstanceID string `json:"-"`
	// EndpointSpec: specification of the endpoint you want to create.
	EndpointSpec *EndpointSpec `json:"endpoint_spec"`
}

type CreateInstanceFromSnapshotRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// SnapshotID: block snapshot of the instance.
	SnapshotID string `json:"-"`
	// InstanceName: name of the instance created with the snapshot.
	InstanceName string `json:"instance_name"`
	// IsHaCluster: whether or not High-Availability is enabled on the new instance.
	IsHaCluster *bool `json:"is_ha_cluster"`
	// NodeType: the node type used to restore the snapshot.
	NodeType *string `json:"node_type"`
}

type CreateInstanceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Deprecated: OrganizationID: please use `project_id` instead.
	// Precisely one of OrganizationID, ProjectID must be set.
	OrganizationID *string `json:"organization_id,omitempty"`
	// ProjectID: the project ID on which to create the instance.
	// Precisely one of OrganizationID, ProjectID must be set.
	ProjectID *string `json:"project_id,omitempty"`
	// Name: name of the instance.
	Name string `json:"name"`
	// Engine: database engine of the database (PostgreSQL, MySQL, ...).
	Engine string `json:"engine"`
	// UserName: name of the user created when the instance is created.
	UserName string `json:"user_name"`
	// Password: password of the user.
	Password string `json:"password"`
	// NodeType: type of node to use for the instance.
	NodeType string `json:"node_type"`
	// IsHaCluster: whether or not High-Availability is enabled.
	IsHaCluster bool `json:"is_ha_cluster"`
	// DisableBackup: whether or not backups are disabled.
	DisableBackup bool `json:"disable_backup"`
	// Tags: tags to apply to the instance.
	Tags []string `json:"tags"`
	// InitSettings: list of engine settings to be set at database initialisation.
	InitSettings []*InstanceSetting `json:"init_settings"`
	// VolumeType: type of volume where data are stored (lssd, bssd, ...).
	// Default value: lssd
	VolumeType VolumeType `json:"volume_type"`
	// VolumeSize: volume size when volume_type is not lssd.
	VolumeSize scw.Size `json:"volume_size"`
	// InitEndpoints: one or multiple EndpointSpec used to expose your database instance. A load_balancer public endpoint is systematically created.
	InitEndpoints []*EndpointSpec `json:"init_endpoints"`
	// BackupSameRegion: store logical backups in the same region as the database instance.
	BackupSameRegion bool `json:"backup_same_region"`
}

type CreateReadReplicaEndpointRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ReadReplicaID: UUID of the read replica.
	ReadReplicaID string `json:"-"`
	// EndpointSpec: specification of the endpoint you want to create.
	EndpointSpec []*ReadReplicaEndpointSpec `json:"endpoint_spec"`
}

type CreateReadReplicaRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want a read replica of.
	InstanceID string `json:"instance_id"`
	// EndpointSpec: specification of the endpoint you want to create.
	EndpointSpec []*ReadReplicaEndpointSpec `json:"endpoint_spec"`
}

type CreateSnapshotRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"-"`
	// Name: name of the snapshot.
	Name string `json:"name"`
	// ExpiresAt: expiration date (Format ISO 8601).
	ExpiresAt *time.Time `json:"expires_at"`
}

type CreateUserRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want to create a user in.
	InstanceID string `json:"-"`
	// Name: name of the user you want to create.
	Name string `json:"name"`
	// Password: password of the user you want to create.
	Password string `json:"password"`
	// IsAdmin: whether the user you want to create will have administrative privileges.
	IsAdmin bool `json:"is_admin"`
}

type Database struct {
	// Name: name of the database.
	Name string `json:"name"`
	// Owner: name of the owner of the database.
	Owner string `json:"owner"`
	// Managed: whether or not the database is managed or not.
	Managed bool `json:"managed"`
	// Size: size of the database.
	Size scw.Size `json:"size"`
}

type DatabaseBackup struct {
	// ID: UUID of the database backup.
	ID string `json:"id"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"instance_id"`
	// DatabaseName: name of the database of this backup.
	DatabaseName string `json:"database_name"`
	// Name: name of the backup.
	Name string `json:"name"`
	// Status: status of the backup.
	// Default value: unknown
	Status DatabaseBackupStatus `json:"status"`
	// Size: size of the database backup.
	Size *scw.Size `json:"size"`
	// ExpiresAt: expiration date (Format ISO 8601).
	ExpiresAt *time.Time `json:"expires_at"`
	// CreatedAt: creation date (Format ISO 8601).
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: updated date (Format ISO 8601).
	UpdatedAt *time.Time `json:"updated_at"`
	// InstanceName: name of the instance of the backup.
	InstanceName string `json:"instance_name"`
	// DownloadURL: URL you can download the backup from.
	DownloadURL *string `json:"download_url"`
	// DownloadURLExpiresAt: expiration date of the download link.
	DownloadURLExpiresAt *time.Time `json:"download_url_expires_at"`
	// Region: region of this database backup.
	Region scw.Region `json:"region"`
	// SameRegion: store logical backups in the same region as the source database instance.
	SameRegion bool `json:"same_region"`
}

type DatabaseBackupStatus string

type DatabaseEngine struct {
	// Name: engine name.
	Name string `json:"name"`
	// LogoURL: engine logo URL.
	LogoURL string `json:"logo_url"`
	// Versions: available versions.
	Versions []*EngineVersion `json:"versions"`
	// Region: region of this database engine.
	Region scw.Region `json:"region"`
}

type DeleteDatabaseBackupRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// DatabaseBackupID: UUID of the database backup to delete.
	DatabaseBackupID string `json:"-"`
}

type DeleteDatabaseRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance where to delete the database.
	InstanceID string `json:"-"`
	// Name: name of the database to delete.
	Name string `json:"-"`
}

type DeleteEndpointRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// EndpointID: this endpoint can also be used to delete a read replica endpoint.
	EndpointID string `json:"-"`
}

type DeleteInstanceACLRulesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want to delete an ACL rules from.
	InstanceID string `json:"-"`
	// ACLRuleIPs: ACL rules IP present on the instance.
	ACLRuleIPs []string `json:"acl_rule_ips"`
}

type DeleteInstanceACLRulesResponse struct {
	// Rules: ACL rules present on the instance.
	Rules []*ACLRule `json:"rules"`
}

type DeleteInstanceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance to delete.
	InstanceID string `json:"-"`
}

type DeleteInstanceSettingsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance to delete settings from.
	InstanceID string `json:"-"`
	// SettingNames: settings names to delete.
	SettingNames []string `json:"setting_names"`
}

type DeleteInstanceSettingsResponse struct {
	// Settings: settings names to delete from the instance.
	Settings []*InstanceSetting `json:"settings"`
}

type DeleteReadReplicaRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ReadReplicaID: UUID of the read replica.
	ReadReplicaID string `json:"-"`
}

type DeleteSnapshotRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// SnapshotID: UUID of the snapshot to delete.
	SnapshotID string `json:"-"`
}

type DeleteUserRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance to delete a user from.
	InstanceID string `json:"-"`
	// Name: name of the user.
	Name string `json:"-"`
}

type Endpoint struct {
	// ID: UUID of the endpoint.
	ID string `json:"id"`
	// IP: iPv4 address of the endpoint.
	// Precisely one of Hostname, IP must be set.
	IP *net.IP `json:"ip,omitempty"`
	// Port: TCP port of the endpoint.
	Port uint32 `json:"port"`
	// Name: name of the endpoint.
	Name *string `json:"name"`
	// PrivateNetwork: private network details. One at the most per RDB instance or read replica (an RDB instance and its read replica can have different private networks). Cannot be updated (has to be deleted and recreated).
	// Precisely one of DirectAccess, LoadBalancer, PrivateNetwork must be set.
	PrivateNetwork *EndpointPrivateNetworkDetails `json:"private_network,omitempty"`
	// LoadBalancer: load balancer details. Public endpoint for RDB instances which is systematically present. One per RDB instance.
	// Precisely one of DirectAccess, LoadBalancer, PrivateNetwork must be set.
	LoadBalancer *EndpointLoadBalancerDetails `json:"load_balancer,omitempty"`
	// DirectAccess: direct access details. Public endpoint reserved for read replicas. One per read replica.
	// Precisely one of DirectAccess, LoadBalancer, PrivateNetwork must be set.
	DirectAccess *EndpointDirectAccessDetails `json:"direct_access,omitempty"`
	// Hostname: hostname of the endpoint.
	// Precisely one of Hostname, IP must be set.
	Hostname *string `json:"hostname,omitempty"`
}

type EndpointDirectAccessDetails struct {
}

type EndpointLoadBalancerDetails struct {
}

type EndpointPrivateNetworkDetails struct {
	// PrivateNetworkID: UUID of the private network.
	PrivateNetworkID string `json:"private_network_id"`
	// ServiceIP: cIDR notation of the endpoint IPv4 address.
	ServiceIP scw.IPNet `json:"service_ip"`
	// Zone: private network zone.
	Zone scw.Zone `json:"zone"`
}

type EndpointSpec struct {
	// LoadBalancer: load balancer endpoint specifications. Public endpoint for RDB instances which is systematically present. One per RDB instance.
	// Precisely one of LoadBalancer, PrivateNetwork must be set.
	LoadBalancer *EndpointSpecLoadBalancer `json:"load_balancer,omitempty"`
	// PrivateNetwork: private network endpoint specifications. One at the most per RDB instance or read replica (an RDB instance and its read replica can have different private networks). Cannot be updated (has to be deleted and recreated).
	// Precisely one of LoadBalancer, PrivateNetwork must be set.
	PrivateNetwork *EndpointSpecPrivateNetwork `json:"private_network,omitempty"`
}

type EndpointSpecLoadBalancer struct {
}

type EndpointSpecPrivateNetwork struct {
	// PrivateNetworkID: UUID of the private network to be connected to the database instance.
	PrivateNetworkID string `json:"private_network_id"`
	// ServiceIP: endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitation.
	// Precisely one of IpamConfig, ServiceIP must be set.
	ServiceIP *scw.IPNet `json:"service_ip,omitempty"`
	// IpamConfig: automated configuration of your private network endpoint with Scaleway IPAM service. One at the most per RDB instance or read replica (an RDB instance and its read replica can have different private networks). Cannot be updated (has to be deleted and recreated).
	// Precisely one of IpamConfig, ServiceIP must be set.
	IpamConfig *EndpointSpecPrivateNetworkIpamConfig `json:"ipam_config,omitempty"`
}

type EndpointSpecPrivateNetworkIpamConfig struct {
}

type EngineSetting struct {
	// Name: setting name from database engine.
	Name string `json:"name"`
	// DefaultValue: value set when not specified.
	DefaultValue string `json:"default_value"`
	// HotConfigurable: setting can be applied without restarting.
	HotConfigurable bool `json:"hot_configurable"`
	// Description: setting description.
	Description string `json:"description"`
	// PropertyType: setting type.
	// Default value: BOOLEAN
	PropertyType EngineSettingPropertyType `json:"property_type"`
	// Unit: setting base unit.
	Unit *string `json:"unit"`
	// StringConstraint: validation regex for string type settings.
	StringConstraint *string `json:"string_constraint"`
	// IntMin: minimum value for int types.
	IntMin *int32 `json:"int_min"`
	// IntMax: maximum value for int types.
	IntMax *int32 `json:"int_max"`
	// FloatMin: minimum value for float types.
	FloatMin *float32 `json:"float_min"`
	// FloatMax: maximum value for float types.
	FloatMax *float32 `json:"float_max"`
}

type EngineSettingPropertyType string

type EngineVersion struct {
	// Version: database engine version.
	Version string `json:"version"`
	// Name: database engine name.
	Name string `json:"name"`
	// EndOfLife: end of life date.
	EndOfLife *time.Time `json:"end_of_life"`
	// AvailableSettings: engine settings available to be set.
	AvailableSettings []*EngineSetting `json:"available_settings"`
	// Disabled: disabled versions cannot be created.
	Disabled bool `json:"disabled"`
	// Beta: beta status of engine version.
	Beta bool `json:"beta"`
	// AvailableInitSettings: engine settings available to be set at database initialisation.
	AvailableInitSettings []*EngineSetting `json:"available_init_settings"`
}

type ExportDatabaseBackupRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// DatabaseBackupID: UUID of the database backup you want to export.
	DatabaseBackupID string `json:"-"`
}

type GetDatabaseBackupRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// DatabaseBackupID: UUID of the database backup.
	DatabaseBackupID string `json:"-"`
}

type GetEndpointRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// EndpointID: UUID of the endpoint you want to get.
	EndpointID string `json:"-"`
}

type GetInstanceCertificateRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"-"`
}

type GetInstanceLogRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceLogID: UUID of the instance_log you want.
	InstanceLogID string `json:"-"`
}

type GetInstanceMetricsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"-"`
	// StartDate: start date to gather metrics from.
	StartDate *time.Time `json:"-"`
	// EndDate: end date to gather metrics from.
	EndDate *time.Time `json:"-"`
	// MetricName: name of the metric to gather.
	MetricName *string `json:"-"`
}

type GetInstanceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"-"`
}

type GetReadReplicaRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ReadReplicaID: UUID of the read replica.
	ReadReplicaID string `json:"-"`
}

type GetSnapshotRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// SnapshotID: UUID of the snapshot.
	SnapshotID string `json:"-"`
}

type Instance struct {
	// CreatedAt: creation date (Format ISO 8601).
	CreatedAt *time.Time `json:"created_at"`
	// Volume: volumes of the instance.
	Volume *Volume `json:"volume"`
	// Region: region the instance is in.
	Region scw.Region `json:"region"`
	// ID: UUID of the instance.
	ID string `json:"id"`
	// Name: name of the instance.
	Name string `json:"name"`
	// OrganizationID: organization ID the instance belongs to.
	OrganizationID string `json:"organization_id"`
	// ProjectID: project ID the instance belongs to.
	ProjectID string `json:"project_id"`
	// Status: status of the instance.
	// Default value: unknown
	Status InstanceStatus `json:"status"`
	// Engine: database engine of the database (PostgreSQL, MySQL, ...).
	Engine string `json:"engine"`
	// UpgradableVersion: available database engine versions for upgrade.
	UpgradableVersion []*UpgradableVersion `json:"upgradable_version"`
	// Deprecated: Endpoint: endpoint of the instance.
	Endpoint *Endpoint `json:"endpoint,omitempty"`
	// Tags: list of tags applied to the instance.
	Tags []string `json:"tags"`
	// Settings: advanced settings of the instance.
	Settings []*InstanceSetting `json:"settings"`
	// BackupSchedule: backup schedule of the instance.
	BackupSchedule *BackupSchedule `json:"backup_schedule"`
	// IsHaCluster: whether or not High-Availability is enabled.
	IsHaCluster bool `json:"is_ha_cluster"`
	// ReadReplicas: read replicas of the instance.
	ReadReplicas []*ReadReplica `json:"read_replicas"`
	// NodeType: node type of the instance.
	NodeType string `json:"node_type"`
	// InitSettings: list of engine settings to be set at database initialisation.
	InitSettings []*InstanceSetting `json:"init_settings"`
	// Endpoints: list of instance endpoints.
	Endpoints []*Endpoint `json:"endpoints"`
	// LogsPolicy: logs policy of the instance.
	LogsPolicy *LogsPolicy `json:"logs_policy"`
	// BackupSameRegion: store logical backups in the same region as the database instance.
	BackupSameRegion bool `json:"backup_same_region"`
	// Maintenances: list of instance maintenances.
	Maintenances []*Maintenance `json:"maintenances"`
}

type InstanceLog struct {
	// DownloadURL: presigned S3 URL to download your log file.
	DownloadURL *string `json:"download_url"`
	// ID: UUID of the instance log.
	ID string `json:"id"`
	// Status: status of the logs in a given instance.
	// Default value: unknown
	Status InstanceLogStatus `json:"status"`
	// NodeName: name of the undelying node.
	NodeName string `json:"node_name"`
	// ExpiresAt: expiration date (Format ISO 8601).
	ExpiresAt *time.Time `json:"expires_at"`
	// CreatedAt: creation date (Format ISO 8601).
	CreatedAt *time.Time `json:"created_at"`
	// Region: region the instance is in.
	Region scw.Region `json:"region"`
}

type InstanceLogStatus string

type InstanceMetrics struct {
	// Timeseries: time series of metrics of a given instance.
	Timeseries []*scw.TimeSeries `json:"timeseries"`
}

type InstanceSetting struct {
	Name string `json:"name"`

	Value string `json:"value"`
}

type InstanceStatus string

type ListDatabaseBackupsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Name: name of the database backups.
	Name *string `json:"-"`
	// OrderBy: criteria to use when ordering database backups listing.
	// Default value: created_at_asc
	OrderBy ListDatabaseBackupsRequestOrderBy `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID *string `json:"-"`
	// OrganizationID: organization ID the database backups belongs to.
	OrganizationID *string `json:"-"`
	// ProjectID: project ID the database backups belongs to.
	ProjectID *string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListDatabaseBackupsRequestOrderBy string

type ListDatabaseBackupsResponse struct {
	// DatabaseBackups: list of database backups.
	DatabaseBackups []*DatabaseBackup `json:"database_backups"`
	// TotalCount: total count of database backups available.
	TotalCount uint32 `json:"total_count"`
}

type ListDatabaseEnginesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Name: name of the Database Engine.
	Name *string `json:"-"`
	// Version: version of the Database Engine.
	Version *string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListDatabaseEnginesResponse struct {
	// Engines: list of the available database engines.
	Engines []*DatabaseEngine `json:"engines"`
	// TotalCount: total count of database engines available.
	TotalCount uint32 `json:"total_count"`
}

type ListDatabasesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance to list database of.
	InstanceID string `json:"-"`
	// Name: name of the database.
	Name *string `json:"-"`
	// Managed: whether or not the database is managed.
	Managed *bool `json:"-"`
	// Owner: user that owns this database.
	Owner *string `json:"-"`
	// OrderBy: criteria to use when ordering database listing.
	// Default value: name_asc
	OrderBy ListDatabasesRequestOrderBy `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListDatabasesRequestOrderBy string

type ListDatabasesResponse struct {
	// Databases: list of the databases.
	Databases []*Database `json:"databases"`
	// TotalCount: total count of databases present on a given instance.
	TotalCount uint32 `json:"total_count"`
}

type ListInstanceACLRulesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListInstanceACLRulesResponse struct {
	// Rules: list of the ACL rules present on a given instance.
	Rules []*ACLRule `json:"rules"`
	// TotalCount: total count of ACL rules present on a given instance.
	TotalCount uint32 `json:"total_count"`
}

type ListInstanceLogsDetailsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want logs of.
	InstanceID string `json:"-"`
}

type ListInstanceLogsDetailsResponse struct {
	// Details: remote instance logs details.
	Details []*ListInstanceLogsDetailsResponseInstanceLogDetail `json:"details"`
}

type ListInstanceLogsDetailsResponseInstanceLogDetail struct {
	LogName string `json:"log_name"`

	Size uint64 `json:"size"`
}

type ListInstanceLogsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want logs of.
	InstanceID string `json:"-"`
	// OrderBy: criteria to use when ordering instance logs listing.
	// Default value: created_at_asc
	OrderBy ListInstanceLogsRequestOrderBy `json:"-"`
}

type ListInstanceLogsRequestOrderBy string

type ListInstanceLogsResponse struct {
	// InstanceLogs: available logs in a given instance.
	InstanceLogs []*InstanceLog `json:"instance_logs"`
}

type ListInstancesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Tags: list instance that have a given tags.
	Tags []string `json:"-"`
	// Name: list instance that match a given name pattern.
	Name *string `json:"-"`
	// OrderBy: criteria to use when ordering instance listing.
	// Default value: created_at_asc
	OrderBy ListInstancesRequestOrderBy `json:"-"`
	// OrganizationID: please use `project_id` instead.
	OrganizationID *string `json:"-"`
	// ProjectID: project ID to list the instance of.
	ProjectID *string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListInstancesRequestOrderBy string

type ListInstancesResponse struct {
	// Instances: list all instances available in a given organization/project.
	Instances []*Instance `json:"instances"`
	// TotalCount: total count of instances available in a given organization/project.
	TotalCount uint32 `json:"total_count"`
}

type ListNodeTypesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// IncludeDisabledTypes: whether or not to include disabled types.
	IncludeDisabledTypes bool `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListNodeTypesResponse struct {
	// NodeTypes: types of the node.
	NodeTypes []*NodeType `json:"node_types"`
	// TotalCount: total count of node-types available.
	TotalCount uint32 `json:"total_count"`
}

type ListPrivilegesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"-"`
	// OrderBy: criteria to use when ordering privileges listing.
	// Default value: user_name_asc
	OrderBy ListPrivilegesRequestOrderBy `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
	// DatabaseName: name of the database.
	DatabaseName *string `json:"-"`
	// UserName: name of the user.
	UserName *string `json:"-"`
}

type ListPrivilegesRequestOrderBy string

type ListPrivilegesResponse struct {
	// Privileges: privileges of a given user in a given database in a given instance.
	Privileges []*Privilege `json:"privileges"`
	// TotalCount: total count of privileges present on a given database.
	TotalCount uint32 `json:"total_count"`
}

type ListSnapshotsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Name: name of the snapshot.
	Name *string `json:"-"`
	// OrderBy: criteria to use when ordering snapshot listing.
	// Default value: created_at_asc
	OrderBy ListSnapshotsRequestOrderBy `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID *string `json:"-"`
	// OrganizationID: organization ID the snapshots belongs to.
	OrganizationID *string `json:"-"`
	// ProjectID: project ID the snapshots belongs to.
	ProjectID *string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListSnapshotsRequestOrderBy string

type ListSnapshotsResponse struct {
	// Snapshots: list of snapshots.
	Snapshots []*Snapshot `json:"snapshots"`
	// TotalCount: total count of snapshots available.
	TotalCount uint32 `json:"total_count"`
}

type ListUsersRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"-"`
	// Name: name of the user.
	Name *string `json:"-"`
	// OrderBy: criteria to use when ordering users listing.
	// Default value: name_asc
	OrderBy ListUsersRequestOrderBy `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListUsersRequestOrderBy string

type ListUsersResponse struct {
	// Users: list of users in a given instance.
	Users []*User `json:"users"`
	// TotalCount: total count of users present on a given instance.
	TotalCount uint32 `json:"total_count"`
}

type LogsPolicy struct {
	// MaxAgeRetention: max age (in day) of remote logs to keep on the database instance.
	MaxAgeRetention *uint32 `json:"max_age_retention"`
	// TotalDiskRetention: max disk size of remote logs to keep on the database instance.
	TotalDiskRetention *scw.Size `json:"total_disk_retention"`
}

type Maintenance struct {
	// StartsAt: start date of the maintenance window.
	StartsAt *time.Time `json:"starts_at"`
	// StopsAt: end date of the maintenance window.
	StopsAt *time.Time `json:"stops_at"`
	// ClosedAt: closed maintenance date.
	ClosedAt *time.Time `json:"closed_at"`
	// Reason: maintenance information message.
	Reason string `json:"reason"`
	// Status: status of the maintenance.
	// Default value: unknown
	Status MaintenanceStatus `json:"status"`
}

type MaintenanceStatus string

type MigrateEndpointRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// EndpointID: UUID of the endpoint you want to migrate.
	EndpointID string `json:"-"`
	// InstanceID: UUID of the instance you want to attach the endpoint to.
	InstanceID string `json:"instance_id"`
}

type NodeType struct {
	// Name: node Type name identifier.
	Name string `json:"name"`
	// StockStatus: current stock status for the Node Type.
	// Default value: unknown
	StockStatus NodeTypeStock `json:"stock_status"`
	// Description: current specs of the offer.
	Description string `json:"description"`
	// Vcpus: number of virtual CPUs.
	Vcpus uint32 `json:"vcpus"`
	// Memory: quantity of RAM.
	Memory scw.Size `json:"memory"`
	// Deprecated: VolumeConstraint: [deprecated] Node Type volume constraints.
	VolumeConstraint *NodeTypeVolumeConstraintSizes `json:"volume_constraint,omitempty"`
	// Deprecated: IsBssdCompatible: the Node Type is compliant with Block Storage.
	IsBssdCompatible *bool `json:"is_bssd_compatible,omitempty"`
	// Disabled: the Node Type is currently disabled.
	Disabled bool `json:"disabled"`
	// Beta: the Node Type is currently in beta.
	Beta bool `json:"beta"`
	// AvailableVolumeTypes: available storage options for the Node Type.
	AvailableVolumeTypes []*NodeTypeVolumeType `json:"available_volume_types"`
	// IsHaRequired: the Node Type can be used only with high availability option.
	IsHaRequired bool `json:"is_ha_required"`
	// Generation: generation associated the NodeType offer.
	// Default value: unknown_generation
	Generation NodeTypeGeneration `json:"generation"`
	// Region: region the Node Type is in.
	Region scw.Region `json:"region"`
}

type NodeTypeGeneration string

type NodeTypeStock string

type NodeTypeVolumeConstraintSizes struct {
	// MinSize: [deprecated] Mimimum size required for the Volume.
	MinSize scw.Size `json:"min_size"`
	// MaxSize: [deprecated] Maximum size required for the Volume.
	MaxSize scw.Size `json:"max_size"`
}

type NodeTypeVolumeType struct {
	// Type: volume Type.
	// Default value: lssd
	Type VolumeType `json:"type"`
	// Description: the description of the Volume.
	Description string `json:"description"`
	// MinSize: mimimum size required for the Volume.
	MinSize scw.Size `json:"min_size"`
	// MaxSize: maximum size required for the Volume.
	MaxSize scw.Size `json:"max_size"`
	// ChunkSize: minimum increment level for a Block Storage volume size.
	ChunkSize scw.Size `json:"chunk_size"`
}

type Permission string

type PrepareInstanceLogsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want logs of.
	InstanceID string `json:"-"`
	// StartDate: start datetime of your log. Format: `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z`.
	StartDate *time.Time `json:"start_date"`
	// EndDate: end datetime of your log. Format: `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z`.
	EndDate *time.Time `json:"end_date"`
}

type PrepareInstanceLogsResponse struct {
	// InstanceLogs: instance logs for a given instance between a start and an end date.
	InstanceLogs []*InstanceLog `json:"instance_logs"`
}

type Privilege struct {
	// Permission: permission (Read, Read/Write, All, Custom).
	// Default value: readonly
	Permission Permission `json:"permission"`
	// DatabaseName: name of the database.
	DatabaseName string `json:"database_name"`
	// UserName: name of the user.
	UserName string `json:"user_name"`
}

type PurgeInstanceLogsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want logs of.
	InstanceID string `json:"-"`
	// LogName: specific log name to purge.
	LogName *string `json:"log_name"`
}

type ReadReplica struct {
	// ID: UUID of the read replica.
	ID string `json:"id"`
	// Endpoints: display read replica connection information.
	Endpoints []*Endpoint `json:"endpoints"`
	// Status: read replica status.
	// Default value: unknown
	Status ReadReplicaStatus `json:"status"`
	// Region: region the read replica is in.
	Region scw.Region `json:"region"`
}

type ReadReplicaEndpointSpec struct {
	// DirectAccess: direct access endpoint specifications. Public endpoint reserved for read replicas. One per read replica.
	// Precisely one of DirectAccess, PrivateNetwork must be set.
	DirectAccess *ReadReplicaEndpointSpecDirectAccess `json:"direct_access,omitempty"`
	// PrivateNetwork: private network endpoint specifications. One at the most per read replica. Cannot be updated (has to be deleted and recreated).
	// Precisely one of DirectAccess, PrivateNetwork must be set.
	PrivateNetwork *ReadReplicaEndpointSpecPrivateNetwork `json:"private_network,omitempty"`
}

type ReadReplicaEndpointSpecDirectAccess struct {
}

type ReadReplicaEndpointSpecPrivateNetwork struct {
	// PrivateNetworkID: UUID of the private network to be connected to the read replica.
	PrivateNetworkID string `json:"private_network_id"`
	// ServiceIP: endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitations.
	// Precisely one of IpamConfig, ServiceIP must be set.
	ServiceIP *scw.IPNet `json:"service_ip,omitempty"`
	// IpamConfig: automated configuration of your private network endpoint with Scaleway IPAM service. One at the most per RDB instance or read replica (an RDB instance and its read replica can have different private networks). Cannot be updated (has to be deleted and recreated).
	// Precisely one of IpamConfig, ServiceIP must be set.
	IpamConfig *ReadReplicaEndpointSpecPrivateNetworkIpamConfig `json:"ipam_config,omitempty"`
}

type ReadReplicaEndpointSpecPrivateNetworkIpamConfig struct {
}

type ReadReplicaStatus string

type RenewInstanceCertificateRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want logs of.
	InstanceID string `json:"-"`
}

type ResetReadReplicaRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ReadReplicaID: UUID of the read replica.
	ReadReplicaID string `json:"-"`
}

type RestartInstanceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want to restart.
	InstanceID string `json:"-"`
}

type RestoreDatabaseBackupRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// DatabaseBackupID: backup of a logical database.
	DatabaseBackupID string `json:"-"`
	// DatabaseName: defines the destination database in order to restore into a specified database, the default destination is set to the origin database of the backup.
	DatabaseName *string `json:"database_name"`
	// InstanceID: defines the rdb instance where the backup has to be restored.
	InstanceID string `json:"instance_id"`
}

type SetInstanceACLRulesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance where the ACL rules has to be set.
	InstanceID string `json:"-"`
	// Rules: ACL rules to define for the instance.
	Rules []*ACLRuleRequest `json:"rules"`
}

type SetInstanceACLRulesResponse struct {
	// Rules: aCLs rules configured for an instance.
	Rules []*ACLRule `json:"rules"`
}

type SetInstanceSettingsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance where the settings has to be set.
	InstanceID string `json:"-"`
	// Settings: settings to define for the instance.
	Settings []*InstanceSetting `json:"settings"`
}

type SetInstanceSettingsResponse struct {
	// Settings: settings configured for a given instance.
	Settings []*InstanceSetting `json:"settings"`
}

type SetPrivilegeRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"-"`
	// DatabaseName: name of the database.
	DatabaseName string `json:"database_name"`
	// UserName: name of the user.
	UserName string `json:"user_name"`
	// Permission: permission to set (Read, Read/Write, All, Custom).
	// Default value: readonly
	Permission Permission `json:"permission"`
}

type Snapshot struct {
	// ID: UUID of the snapshot.
	ID string `json:"id"`
	// InstanceID: UUID of the instance.
	InstanceID string `json:"instance_id"`
	// Name: name of the snapshot.
	Name string `json:"name"`
	// Status: status of the snapshot.
	// Default value: unknown
	Status SnapshotStatus `json:"status"`
	// Size: size of the snapshot.
	Size *scw.Size `json:"size"`
	// ExpiresAt: expiration date (Format ISO 8601).
	ExpiresAt *time.Time `json:"expires_at"`
	// CreatedAt: creation date (Format ISO 8601).
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: updated date (Format ISO 8601).
	UpdatedAt *time.Time `json:"updated_at"`
	// InstanceName: name of the instance of the snapshot.
	InstanceName string `json:"instance_name"`
	// NodeType: source node type.
	NodeType string `json:"node_type"`
	// Region: region of this snapshot.
	Region scw.Region `json:"region"`
}

type SnapshotStatus string

type UpdateDatabaseBackupRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// DatabaseBackupID: UUID of the database backup to update.
	DatabaseBackupID string `json:"-"`
	// Name: name of the Database Backup.
	Name *string `json:"name"`
	// ExpiresAt: expiration date (Format ISO 8601).
	ExpiresAt *time.Time `json:"expires_at"`
}

type UpdateInstanceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance to update.
	InstanceID string `json:"-"`
	// BackupScheduleFrequency: in hours.
	BackupScheduleFrequency *uint32 `json:"backup_schedule_frequency"`
	// BackupScheduleRetention: in days.
	BackupScheduleRetention *uint32 `json:"backup_schedule_retention"`
	// IsBackupScheduleDisabled: whether or not the backup schedule is disabled.
	IsBackupScheduleDisabled *bool `json:"is_backup_schedule_disabled"`
	// Name: name of the instance.
	Name *string `json:"name"`
	// Tags: tags of a given instance.
	Tags *[]string `json:"tags"`
	// LogsPolicy: logs policy of the instance.
	LogsPolicy *LogsPolicy `json:"logs_policy"`
	// BackupSameRegion: store logical backups in the same region as the database instance.
	BackupSameRegion *bool `json:"backup_same_region"`
}

type UpdateSnapshotRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// SnapshotID: UUID of the snapshot to update.
	SnapshotID string `json:"-"`
	// Name: name of the snapshot.
	Name *string `json:"name"`
	// ExpiresAt: expiration date (Format ISO 8601).
	ExpiresAt *time.Time `json:"expires_at"`
}

type UpdateUserRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance the user belongs to.
	InstanceID string `json:"-"`
	// Name: name of the database user.
	Name string `json:"-"`
	// Password: password of the database user.
	Password *string `json:"password"`
	// IsAdmin: whether or not this user got administrative privileges.
	IsAdmin *bool `json:"is_admin"`
}

type UpgradableVersion struct {
	ID string `json:"id"`

	Name string `json:"name"`

	Version string `json:"version"`

	MinorVersion string `json:"minor_version"`
}

type UpgradeInstanceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// InstanceID: UUID of the instance you want to upgrade.
	InstanceID string `json:"-"`
	// NodeType: node type of the instance you want to upgrade to.
	// Precisely one of EnableHa, NodeType, UpgradableVersionID, VolumeSize, VolumeType must be set.
	NodeType *string `json:"node_type,omitempty"`
	// EnableHa: set to true to enable high availability on your instance.
	// Precisely one of EnableHa, NodeType, UpgradableVersionID, VolumeSize, VolumeType must be set.
	EnableHa *bool `json:"enable_ha,omitempty"`
	// VolumeSize: increase your block storage volume size.
	// Precisely one of EnableHa, NodeType, UpgradableVersionID, VolumeSize, VolumeType must be set.
	VolumeSize *uint64 `json:"volume_size,omitempty"`
	// VolumeType: change your instance storage type.
	// Default value: lssd
	// Precisely one of EnableHa, NodeType, UpgradableVersionID, VolumeSize, VolumeType must be set.
	VolumeType *VolumeType `json:"volume_type,omitempty"`
	// UpgradableVersionID: this will create a new Database Instance with same instance specification as the current one and perform a Database Engine upgrade.
	// Precisely one of EnableHa, NodeType, UpgradableVersionID, VolumeSize, VolumeType must be set.
	UpgradableVersionID *string `json:"upgradable_version_id,omitempty"`
}

type User struct {
	// Name: name of the user (Length must be between 1 and 63 characters, The max Length is 32 for MySQL engines, First character must be an alphabet character (a-zA-Z), Your Username cannot start with '_rdb', Only a-zA-Z0-9_$- characters are accepted).
	Name string `json:"name"`
	// IsAdmin: whether or not a user got administrative privileges on the database instance.
	IsAdmin bool `json:"is_admin"`
}

type Volume struct {
	// Type:
	// Default value: lssd
	Type VolumeType `json:"type"`

	Size scw.Size `json:"size"`
}

type VolumeType string

type WaitForDatabaseBackupRequest struct {
	DatabaseBackupID string
	Region           scw.Region
	Timeout          *time.Duration
	RetryInterval    *time.Duration
}

type WaitForInstanceLogRequest struct {
	InstanceLogID string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

type WaitForInstanceRequest struct {
	InstanceID    string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

type WaitForReadReplicaRequest struct {
	ReadReplicaID string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}