models

type ActionResult struct {
	ID         string    `reform:"id,pk"`
	PMMAgentID string    `reform:"pmm_agent_id"`
	Done       bool      `reform:"done"`
	Error      string    `reform:"error"`
	Output     string    `reform:"output"`
	CreatedAt  time.Time `reform:"created_at"`
	UpdatedAt  time.Time `reform:"updated_at"`
}

type AddDBMSServiceParams struct {
	ServiceName    string
	NodeID         string
	Environment    string
	Cluster        string
	ReplicationSet string
	CustomLabels   map[string]string
	ExternalGroup  string
	Address        *string
	Port           *uint16
	Socket         *string
}

type Agent struct {
	AgentID      string    `reform:"agent_id,pk"`
	AgentType    AgentType `reform:"agent_type"`
	RunsOnNodeID *string   `reform:"runs_on_node_id"`
	ServiceID    *string   `reform:"service_id"`
	NodeID       *string   `reform:"node_id"`
	PMMAgentID   *string   `reform:"pmm_agent_id"`
	CustomLabels []byte    `reform:"custom_labels"`
	CreatedAt    time.Time `reform:"created_at"`
	UpdatedAt    time.Time `reform:"updated_at"`

	Disabled   bool    `reform:"disabled"`
	Status     string  `reform:"status"`
	ListenPort *uint16 `reform:"listen_port"`
	Version    *string `reform:"version"`

	Username      *string `reform:"username"`
	Password      *string `reform:"password"`
	TLS           bool    `reform:"tls"`
	TLSSkipVerify bool    `reform:"tls_skip_verify"`

	AWSAccessKey *string `reform:"aws_access_key"`
	AWSSecretKey *string `reform:"aws_secret_key"`

	AzureOptions *AzureOptions `reform:"azure_options"`

	// TableCount stores last known table count. NULL if unknown.
	TableCount *int32 `reform:"table_count"`

	// Tablestats group collectors are disabled if there are more than that number of tables.
	// 0 means tablestats group collectors are always enabled (no limit).
	// Negative value means tablestats group collectors are always disabled.
	// See IsMySQLTablestatsGroupEnabled method.
	TableCountTablestatsGroupLimit int32 `reform:"table_count_tablestats_group_limit"`

	QueryExamplesDisabled bool    `reform:"query_examples_disabled"`
	MaxQueryLogSize       int64   `reform:"max_query_log_size"`
	MetricsPath           *string `reform:"metrics_path"`
	MetricsScheme         *string `reform:"metrics_scheme"`

	RDSBasicMetricsDisabled    bool           `reform:"rds_basic_metrics_disabled"`
	RDSEnhancedMetricsDisabled bool           `reform:"rds_enhanced_metrics_disabled"`
	PushMetrics                bool           `reform:"push_metrics"`
	DisabledCollectors         pq.StringArray `reform:"disabled_collectors"`

	MySQLOptions   *MySQLOptions   `reform:"mysql_options"`
	MongoDBOptions *MongoDBOptions `reform:"mongo_db_tls_options"`
}

type AgentFilters struct {
	// Return only Agents started by this pmm-agent.
	PMMAgentID string
	// Return only Agents that provide insights for that Node.
	NodeID string
	// Return only Agents that provide insights for that Service.
	ServiceID string
	// Return Agents with provided type.
	AgentType *AgentType
}

type AgentType string

type Artifact struct {
	ID         string       `reform:"id,pk"`
	Name       string       `reform:"name"`
	Vendor     string       `reform:"vendor"`
	LocationID string       `reform:"location_id"`
	ServiceID  string       `reform:"service_id"`
	DataModel  DataModel    `reform:"data_model"`
	Status     BackupStatus `reform:"status"`
	CreatedAt  time.Time    `reform:"created_at"`
}

type AzureOptions struct {
	SubscriptionID string `json:"subscription_id"`
	ClientID       string `json:"client_id"`
	ClientSecret   string `json:"client_secret"`
	TenantID       string `json:"tenant_id"`
	ResourceGroup  string `json:"resource_group"`
}

type AzureOptionsParams interface {
	GetAzureSubscriptionId() string
	GetAzureClientId() string
	GetAzureClientSecret() string
	GetAzureTenantId() string
	GetAzureResourceGroup() string
}

type BackupLocation struct {
	ID              string                   `reform:"id,pk"`
	Name            string                   `reform:"name"`
	Description     string                   `reform:"description"`
	Type            BackupLocationType       `reform:"type"`
	S3Config        *S3LocationConfig        `reform:"s3_config"`
	PMMServerConfig *PMMServerLocationConfig `reform:"pmm_server_config"`
	PMMClientConfig *PMMClientLocationConfig `reform:"pmm_client_config"`

	CreatedAt time.Time `reform:"created_at"`
	UpdatedAt time.Time `reform:"updated_at"`
}

type BackupLocationConfig struct {
	PMMClientConfig *PMMClientLocationConfig
	PMMServerConfig *PMMServerLocationConfig
	S3Config        *S3LocationConfig
}

type BackupLocationType string

type BackupLocationValidationParams struct {
	RequireConfig    bool
	WithBucketRegion bool
}

type BackupStatus string

type BoolParam struct {
	Default *bool `json:"default,omitempty"`
}

type ChangeArtifactParams struct {
	Status BackupStatus
}

type ChangeBackupLocationParams struct {
	Name        string
	Description string

	BackupLocationConfig
}

type ChangeChannelParams struct {
	Summary string

	EmailConfig     *EmailConfig
	PagerDutyConfig *PagerDutyConfig
	SlackConfig     *SlackConfig
	WebHookConfig   *WebHookConfig

	Disabled bool
}

type ChangeCommonAgentParams struct {
	Disabled           *bool // true - disable, false - enable, nil - do not change
	CustomLabels       map[string]string
	RemoveCustomLabels bool
	DisablePushMetrics *bool
}

type ChangeRestoreHistoryItemParams struct {
	Status RestoreStatus
}

type ChangeRuleParams struct {
	Summary      string
	Disabled     bool
	RuleParams   RuleParams
	For          time.Duration
	Severity     Severity
	CustomLabels map[string]string
	Filters      Filters
	ChannelIDs   []string
}

type ChangeSettingsParams struct {
	// We don't save it to db
	DisableUpdates bool

	DisableTelemetry bool
	EnableTelemetry  bool

	MetricsResolutions MetricsResolutions

	DataRetention time.Duration

	AWSPartitions []string

	SSHKey string

	// not url.URL to keep username and password
	AlertManagerURL       string
	RemoveAlertManagerURL bool

	// Enable Security Threat Tool
	EnableSTT bool
	// Disable Security Threat Tool
	DisableSTT bool
	// List of STT checks to disable
	DisableSTTChecks []string
	// List of STT checks to enable
	EnableSTTChecks []string
	// STT check intevals
	STTCheckIntervals STTCheckIntervals

	// Enable DBaaS features.
	EnableDBaaS bool
	// Disable DBaaS features.
	DisableDBaaS bool

	// Enable Azure Discover features.
	EnableAzurediscover bool
	// Disable Azure Discover features.
	DisableAzurediscover bool

	// Enable Integrated Alerting features.
	EnableAlerting bool
	// Disable Integrated Alerting features.
	DisableAlerting bool

	// Email config for Integrated Alerting.
	EmailAlertingSettings *EmailAlertingSettings
	// If true removes email alerting settings.
	RemoveEmailAlertingSettings bool

	// Slack config for Integrated Alerting.
	SlackAlertingSettings *SlackAlertingSettings
	// If true removes Slack alerting settings.
	RemoveSlackAlertingSettings bool

	// Percona Platform user email
	Email string
	// Percona Platform session Id
	SessionID string
	// LogOut user from Percona Platform, i.e. remove user email and session id
	LogOut bool

	// EnableVMCache enables caching for vmdb search queries
	EnableVMCache bool
	// DisableVMCache disables caching for vmdb search queries
	DisableVMCache bool

	// PMM Server public address.
	PMMPublicAddress       string
	RemovePMMPublicAddress bool

	// Enable Backup Management features.
	EnableBackupManagement bool
	// Disable Backup Management features.
	DisableBackupManagement bool
}

type ChangeTemplateParams struct {
	Template *alert.Template
	Name     string
	Yaml     string
}

type Channel struct {
	ID      string      `reform:"id,pk"`
	Summary string      `reform:"summary"`
	Type    ChannelType `reform:"type"`

	EmailConfig     *EmailConfig     `reform:"email_config"`
	PagerDutyConfig *PagerDutyConfig `reform:"pagerduty_config"`
	SlackConfig     *SlackConfig     `reform:"slack_config"`
	WebHookConfig   *WebHookConfig   `reform:"webhook_config"`

	Disabled bool `reform:"disabled"`

	CreatedAt time.Time `reform:"created_at"`
	UpdatedAt time.Time `reform:"updated_at"`
}

type ChannelIDs []string

type ChannelType string

type CheckSettings struct {
	Name     string   `reform:"name,pk"`
	Interval Interval `reform:"interval"`
}

type Component struct {
	DisabledVersions []string
	DefaultVersion   string
}

type CreateAgentParams struct {
	PMMAgentID                     string
	NodeID                         string
	ServiceID                      string
	Username                       string
	Password                       string
	CustomLabels                   map[string]string
	TLS                            bool
	TLSSkipVerify                  bool
	MySQLOptions                   *MySQLOptions
	MongoDBOptions                 *MongoDBOptions
	TableCountTablestatsGroupLimit int32
	QueryExamplesDisabled          bool
	MaxQueryLogSize                int64
	AWSAccessKey                   string
	AWSSecretKey                   string
	RDSBasicMetricsDisabled        bool
	RDSEnhancedMetricsDisabled     bool
	AzureOptions                   *AzureOptions
	PushMetrics                    bool
	DisableCollectors              []string
}

type CreateArtifactParams struct {
	Name       string
	Vendor     string
	LocationID string
	ServiceID  string
	DataModel  DataModel
	Status     BackupStatus
}

type CreateBackupLocationParams struct {
	Name        string
	Description string

	BackupLocationConfig
}

type CreateChannelParams struct {
	Summary string

	EmailConfig     *EmailConfig
	PagerDutyConfig *PagerDutyConfig
	SlackConfig     *SlackConfig
	WebHookConfig   *WebHookConfig

	Disabled bool
}

type CreateExternalExporterParams struct {
	RunsOnNodeID string
	ServiceID    string
	Username     string
	Password     string
	Scheme       string
	MetricsPath  string
	ListenPort   uint32
	CustomLabels map[string]string
	PushMetrics  bool
}

type CreateKubernetesClusterParams struct {
	KubernetesClusterName string
	KubeConfig            string
}

type CreateNodeParams struct {
	NodeName      string
	MachineID     *string
	Distro        string
	NodeModel     string
	AZ            string
	ContainerID   *string
	ContainerName *string
	CustomLabels  map[string]string
	Address       string
	Region        *string
}

type CreateRestoreHistoryItemParams struct {
	ArtifactID string
	ServiceID  string
	Status     RestoreStatus
}

type CreateRuleParams struct {
	TemplateName string
	Summary      string
	Disabled     bool
	RuleParams   RuleParams
	For          time.Duration
	Severity     Severity
	CustomLabels map[string]string
	Filters      Filters
	ChannelIDs   []string
}

type CreateTemplateParams struct {
	Template *alert.Template
	Yaml     string
	Source   Source
}

type DBConfig struct {
	User     string
	Password string
	Address  string
	Port     int
	Socket   string
}

type DataModel string

type DelimiterPair struct {
	Left  string
	Right string
}

type EchoJobResult struct {
	Message string `json:"message"`
}

type EmailAlertingSettings struct {
	From      string `json:"from"`
	Smarthost string `json:"smarthost"`
	Hello     string `json:"hello"`
	Username  string `json:"username"`
	Password  string `json:"password"`
	Identity  string `json:"identity"`
	Secret    string `json:"secret"`
}

type EmailConfig struct {
	SendResolved bool     `json:"send_resolved"`
	To           []string `json:"to"`
}

type Filter struct {
	Type FilterType `json:"type"`
	Key  string     `json:"key"`
	Val  string     `json:"value"`
}

type FilterType string

type Filters []Filter

type FloatParam struct {
	Default *float64 `json:"default,omitempty"`
	Min     *float64 `json:"min,omitempty"`
	Max     *float64 `json:"max,omitempty"`
}

type HTTPBasicAuth struct {
	Username     string `json:"username,omitempty"`
	Password     string `json:"password,omitempty"`
	PasswordFile string `json:"password_file,omitempty"`
}

type HTTPConfig struct {
	BasicAuth       *HTTPBasicAuth `json:"basic_auth,omitempty"`
	BearerToken     string         `json:"bearer_token,omitempty"`
	BearerTokenFile string         `json:"bearer_token_file,omitempty"`
	TLSConfig       *TLSConfig     `json:"tls_config,omitempty"`
	ProxyURL        string         `json:"proxy_url,omitempty"`
}

type IntegratedAlerting struct {
	Enabled               bool                   `json:"enabled"`
	EmailAlertingSettings *EmailAlertingSettings `json:"email_settings"`
	SlackAlertingSettings *SlackAlertingSettings `json:"slack_settings"`
}

type Interval string

type JobResult struct {
	ID         string         `reform:"id,pk"`
	PMMAgentID string         `reform:"pmm_agent_id"`
	Type       JobType        `reform:"type"`
	Done       bool           `reform:"done"`
	Error      string         `reform:"error"`
	Result     *JobResultData `reform:"result"`
	CreatedAt  time.Time      `reform:"created_at"`
	UpdatedAt  time.Time      `reform:"updated_at"`
}

type JobResultData struct {
	Echo               *EchoJobResult               `json:"echo,omitempty"`
	MySQLBackup        *MySQLBackupJobResult        `json:"mysql_backup,omitempty"`
	MySQLRestoreBackup *MySQLRestoreBackupJobResult `json:"mysql_restore_backup,omitempty"`
}

type JobType string

type KubernetesCluster struct {
	ID                    string     `reform:"id,pk"`
	KubernetesClusterName string     `reform:"kubernetes_cluster_name"`
	KubeConfig            string     `reform:"kube_config"`
	PXC                   *Component `reform:"pxc"`
	ProxySQL              *Component `reform:"proxysql"`
	HAProxy               *Component `reform:"haproxy"`
	Mongod                *Component `reform:"mongod"`
	CreatedAt             time.Time  `reform:"created_at"`
	UpdatedAt             time.Time  `reform:"updated_at"`
}

type MetricsResolutions struct {
	HR time.Duration `json:"hr"`
	MR time.Duration `json:"mr"`
	LR time.Duration `json:"lr"`
}

type MongoDBOptions struct {
	TLSCertificateKey             string `json:"tls_certificate_key"`
	TLSCertificateKeyFilePassword string `json:"tls_certificate_key_file_password"`
	TLSCa                         string `json:"tls_ca"`
}

type MongoDBOptionsParams interface {
	GetTlsCertificateKey() string
	GetTlsCertificateKeyFilePassword() string
	GetTlsCa() string
}

type MySQLBackupJobResult struct {
	ArtifactID string `json:"artifact_id"`
}

type MySQLOptions struct {
	TLSCa   string `json:"tls_ca"`
	TLSCert string `json:"tls_cert"`
	TLSKey  string `json:"tls_key"`
}

type MySQLOptionsParams interface {
	GetTlsCa() string
	GetTlsCert() string
	GetTlsKey() string
}

type MySQLRestoreBackupJobResult struct {
	RestoreID string `json:"restore_id,omitempty"`
}

type Node struct {
	NodeID       string   `reform:"node_id,pk"`
	NodeType     NodeType `reform:"node_type"`
	NodeName     string   `reform:"node_name"`
	MachineID    *string  `reform:"machine_id"`
	Distro       string   `reform:"distro"`
	NodeModel    string   `reform:"node_model"`
	AZ           string   `reform:"az"`
	CustomLabels []byte   `reform:"custom_labels"`

	// Node address. Used to construct endpoint for node_exporter.
	// For RemoteRDS Nodes contains DBInstanceIdentifier (not DbiResourceId; not endpoint - that's Service address).
	Address string `reform:"address"`

	CreatedAt time.Time `reform:"created_at"`
	UpdatedAt time.Time `reform:"updated_at"`

	ContainerID   *string `reform:"container_id"` // nil means "unknown"; non-nil value must be unique
	ContainerName *string `reform:"container_name"`

	Region *string `reform:"region"` // non-nil value must be unique in combination with instance/address
}

type NodeFilters struct {
	// Return Nodes with provided type.
	NodeType *NodeType
}

type NodeType string

type PMMClientLocationConfig struct {
	Path string `json:"path"`
}

type PMMServerLocationConfig struct {
	Path string `json:"path"`
}

type PagerDutyConfig struct {
	SendResolved bool   `json:"send_resolved"`
	RoutingKey   string `json:"routing_key,omitempty"`
	ServiceKey   string `json:"service_key,omitempty"`
}

type ParamType string

type RemoveMode int

type RestoreHistoryItem struct {
	ID         string        `reform:"id,pk"`
	ArtifactID string        `reform:"artifact_id"`
	ServiceID  string        `reform:"service_id"`
	Status     RestoreStatus `reform:"status"`
	StartedAt  time.Time     `reform:"started_at"`
	FinishedAt *time.Time    `reform:"finished_at"`
}

type RestoreStatus string

type Rule struct {
	TemplateName string        `reform:"template_name"`
	ID           string        `reform:"id,pk"`
	Summary      string        `reform:"summary"`
	Disabled     bool          `reform:"disabled"`
	Params       RuleParams    `reform:"params"`
	For          time.Duration `reform:"for"`
	Severity     Severity      `reform:"severity"`
	CustomLabels []byte        `reform:"custom_labels"`
	Filters      Filters       `reform:"filters"`
	ChannelIDs   ChannelIDs    `reform:"channel_ids"`
	CreatedAt    time.Time     `reform:"created_at"`
	UpdatedAt    time.Time     `reform:"updated_at"`
}

type RuleParam struct {
	Name        string    `json:"name"`
	Type        ParamType `json:"type"`
	BoolValue   bool      `json:"bool"`
	FloatValue  float32   `json:"float"`
	StringValue string    `json:"string"`
}

type RuleParams []RuleParam

type S3LocationConfig struct {
	Endpoint     string `json:"endpoint"`
	AccessKey    string `json:"access_key"`
	SecretKey    string `json:"secret_key"`
	BucketName   string `json:"bucket_name"`
	BucketRegion string `json:"bucket_region"`
}

type STTCheckIntervals struct {
	StandardInterval time.Duration `json:"standard_interval"`
	RareInterval     time.Duration `json:"rare_interval"`
	FrequentInterval time.Duration `json:"frequent_interval"`
}

type SaaS struct {
	// Percona Platform user email
	Email string `json:"email"`
	// Percona Platform session Id
	SessionID string `json:"session_id"`
	// Security Threat Tool enabled
	STTEnabled bool `json:"stt_enabled"`
	// List of disabled STT checks
	DisabledSTTChecks []string `json:"disabled_stt_checks"`
	// STT check intervals
	STTCheckIntervals STTCheckIntervals `json:"stt_check_intervals"`
}

type Service struct {
	ServiceID      string      `reform:"service_id,pk"`
	ServiceType    ServiceType `reform:"service_type"`
	ServiceName    string      `reform:"service_name"`
	NodeID         string      `reform:"node_id"`
	Environment    string      `reform:"environment"`
	Cluster        string      `reform:"cluster"`
	ReplicationSet string      `reform:"replication_set"`
	CustomLabels   []byte      `reform:"custom_labels"`
	ExternalGroup  string      `reform:"external_group"`
	CreatedAt      time.Time   `reform:"created_at"`
	UpdatedAt      time.Time   `reform:"updated_at"`

	Address *string `reform:"address"`
	Port    *uint16 `reform:"port"`
	Socket  *string `reform:"socket"`
}

type ServiceFilters struct {
	// Return only Services runs on that Node.
	NodeID string
	// Return only Services with provided type.
	ServiceType *ServiceType
	// Return only Services with given external group.
	ExternalGroup string
}

type ServiceType string

type Settings struct {
	PMMPublicAddress string `json:"pmm_public_address"`

	Telemetry struct {
		Disabled bool   `json:"disabled"`
		UUID     string `json:"uuid"`
	} `json:"telemetry"`

	MetricsResolutions MetricsResolutions `json:"metrics_resolutions"`

	DataRetention time.Duration `json:"data_retention"`

	AWSPartitions []string `json:"aws_partitions"`

	AWSInstanceChecked bool `json:"aws_instance_checked"`

	SSHKey string `json:"ssh_key"`

	// not url.URL to keep username and password
	AlertManagerURL string `json:"alert_manager_url"`

	VictoriaMetrics struct {
		CacheEnabled bool `json:"cache_enabled"`
	} `json:"victoria_metrics"`

	SaaS SaaS `json:"sass"` // sic :(

	// DBaaS config options
	DBaaS struct {
		Enabled bool `json:"enabled"`
	} `json:"dbaas"`

	IntegratedAlerting IntegratedAlerting `json:"ia"`

	Azurediscover struct {
		Enabled bool `json:"enabled"`
	} `json:"azure"`

	BackupManagement struct {
		Enabled bool `json:"enabled"`
	} `json:"backup_management"`
}

type SetupDBParams struct {
	Logf             reform.Printf
	Username         string
	Password         string
	SetupFixtures    SetupFixturesMode
	MigrationVersion *int
}

type SetupFixturesMode int

type Severity common.Severity

type SlackAlertingSettings struct {
	URL string `json:"url"`
}

type SlackConfig struct {
	SendResolved bool   `json:"send_resolved"`
	Channel      string `json:"channel"`
}

type Source string

type StringParam struct {
	Default *string `json:"default,omitempty"`
}

type TLSConfig struct {
	CaFile             string `json:"ca_file,omitempty"`
	CertFile           string `json:"cert_file,omitempty"`
	KeyFile            string `json:"key_file,omitempty"`
	ServerName         string `json:"server_name,omitempty"`
	InsecureSkipVerify bool   `json:"insecure_skip_verify,omitempty"`
}

type Template struct {
	Name        string         `reform:"name,pk"`
	Version     uint32         `reform:"version"`
	Summary     string         `reform:"summary"`
	Tiers       Tiers          `reform:"tiers"`
	Expr        string         `reform:"expr"`
	Params      TemplateParams `reform:"params"`
	For         time.Duration  `reform:"for"`
	Severity    Severity       `reform:"severity"`
	Labels      []byte         `reform:"labels"`
	Annotations []byte         `reform:"annotations"`
	Source      Source         `reform:"source"`
	Yaml        string         `reform:"yaml"`

	CreatedAt time.Time `reform:"created_at"`
	UpdatedAt time.Time `reform:"updated_at"`
}

type TemplateParam struct {
	Name    string    `json:"name"`
	Summary string    `json:"summary"`
	Unit    string    `json:"unit"`
	Type    ParamType `json:"type"`

	FloatParam *FloatParam `json:"float_param"`
}

type TemplateParams []TemplateParam

type Tiers []common.Tier

type ToggleRuleParams struct {
	Disabled *bool // nil - do not change
}

type VictoriaMetricsParams struct {
	// VMAlertFlags additional flags for VMAlert.
	VMAlertFlags []string
	// BaseConfigPath defines path for basic prometheus config.
	BaseConfigPath string
}

type WebHookConfig struct {
	SendResolved bool        ` json:"send_resolved"`
	URL          string      ` json:"url"`
	HTTPConfig   *HTTPConfig ` json:"http_config,omitempty"`
	MaxAlerts    int32       ` json:"max_alerts"`
}