models

type App struct {
	Help bool

	Verbose bool
	// LogLevel Set log level for verbose output.
	LogLevel string
	// LogJSON Format logs as JSON, for parsing by external tools.
	LogJSON bool
	// LogFile Path to the log file, if logging to a file.
	LogFile string

	// ConfigFilePath is the path to the file used for tool configuration.
	ConfigFilePath string
}

type AwsS3 struct {
	BucketName      string
	Region          string
	Profile         string
	Endpoint        string
	AccessKeyID     string
	SecretAccessKey string

	StorageClass        string
	AccessTier          string
	RestorePollDuration int64

	RetryMaxAttempts int
	RetryMaxBackoff  int

	ChunkSize         int
	UploadConcurrency int

	StorageCommon
}

type AzureBlob struct {
	// Account name + key auth
	AccountName string
	AccountKey  string
	// Azure Active directory
	TenantID     string
	ClientID     string
	ClientSecret string // #nosec G117

	Endpoint      string
	ContainerName string

	AccessTier          string
	RestorePollDuration int64

	RetryMaxAttempts int
	RetryDelay       int
	RetryMaxDelay    int

	BlockSize         int
	UploadConcurrency int

	StorageCommon
}

type Backup struct {
	Common
	MaxRetries          int
	OutputFile          string
	RemoveFiles         bool
	ModifiedBefore      string
	ModifiedAfter       string
	FileLimit           uint64
	AfterDigest         string
	MaxRecords          int64
	NoBins              bool
	SleepBetweenRetries int
	FilterExpression    string
	RemoveArtifacts     bool
	Compact             bool
	NodeList            string
	NoTTLOnly           bool
	PreferRacks         string
	PartitionList       string
	Estimate            bool
	EstimateSamples     int64
	StateFileDst        string
	Continue            string
	ScanPageSize        int64
	OutputFilePrefix    string
	RackList            string
}

type BackupListFilter struct {
	// Name is an optional backup routine name. If empty, backups for all routines are returned.
	Name string

	// From is an optional lower-bound timestamp filter (Unix milliseconds).
	From int64

	// To is an optional upper-bound timestamp filter (Unix milliseconds).
	To int64
}

type BackupRoutine struct {
	Name string
}

type BackupTrigger struct {
	// Name is the backup routine name to trigger.
	Name string

	// Delay is the optional delay before the backup starts, in milliseconds.
	Delay int
}

type BackupXDR struct {
	Directory                    string
	FileLimit                    uint64
	RemoveFiles                  bool
	ParallelWrite                int
	DC                           string
	LocalAddress                 string
	LocalPort                    int
	Namespace                    string
	Rewind                       string
	MaxThroughput                int
	ReadTimeoutMilliseconds      int64
	WriteTimeoutMilliseconds     int64
	ResultQueueSize              int
	AckQueueSize                 int
	MaxConnections               int
	InfoPolingPeriodMilliseconds int64
	StartTimeoutMilliseconds     int64
	InfoTimeout                  int64

	StopXDR    bool
	UnblockMRT bool

	InfoMaxRetries                uint
	InfoRetriesMultiplier         float64
	InfoRetryIntervalMilliseconds int64

	Forward bool
}

type ClientPolicy struct {
	Timeout      int64
	IdleTimeout  int64
	LoginTimeout int64
}

type Common struct {
	Directory        string
	Namespace        string
	SetList          string
	BinList          string
	Parallel         int
	NoRecords        bool
	NoIndexes        bool
	NoUDFs           bool
	RecordsPerSecond int
	TotalTimeout     int64
	SocketTimeout    int64
	InfoTimeout      int64

	InfoMaxRetries                uint
	InfoRetriesMultiplier         float64
	InfoRetryIntervalMilliseconds int64

	// Bandwidth is mapped to config.Bandwidth
	// Is set in MiB then converted to bytes.
	Bandwidth int64
	// Buffer size for stdin/stdout operations.
	StdBufferSize int
}

type Compression struct {
	Mode  string
	Level int
}

type ConfigClusterFields struct {
	// Name is the cluster name (URL path parameter).
	Name string

	// SeedNodes is a list of seed-node entries in the form host:port[/tls-name].
	// Repeatable flag (--seed-node host:port).
	SeedNodes []string

	// PreferRacks is the list of acceptable racks in order of preference.
	PreferRacks []int

	ConnTimeout          int
	Label                string
	MaxParallelScans     int
	UseServicesAlternate bool

	// Credentials.* override fields under the credential object.
	CredentialsUser            string
	CredentialsPassword        string
	CredentialsPasswordPath    string
	CredentialsAuthMode        string
	CredentialsSecretAgentName string

	// TLS.* override fields under the tls object.
	TLSCaFile          string
	TLSCaPath          string
	TLSCertFile        string
	TLSCipherSuite     string
	TLSKeyFile         string
	TLSKeyFilePassword string
	TLSName            string
	TLSProtocols       string
}

type ConfigPolicyFields struct {
	// Name is the policy name (URL path parameter).
	Name string

	Bandwidth                int
	FileLimit                int
	MaxConcurrentNodes       int
	Parallel                 int
	ParallelWrite            int
	RecordsPerSecond         int
	SocketTimeout            int
	TotalTimeout             int
	ConcurrentIncremental    bool
	NoIndexes                bool
	NoRecords                bool
	NoUdfs                   bool
	Sealed                   bool
	UseScanCompression       bool
	WithClusterConfiguration bool

	// Compression.* override fields under the compression object.
	CompressionMode  string
	CompressionLevel int

	// Encryption.* override fields under the encryption object.
	EncryptionMode      string
	EncryptionKeyEnv    string
	EncryptionKeyFile   string
	EncryptionKeySecret string

	// Retention.* override fields under the retention object.
	RetentionFull        int
	RetentionIncremental int

	// Retry.* override fields under the retry-policy object.
	RetryBaseTimeout int
	RetryMaxRetries  int
	RetryMultiplier  float32
}

type ConfigResourceName struct {
	Name string
}

type ConfigRoutineFields struct {
	// Name is the routine name (URL path parameter).
	Name string

	BackupPolicy     string
	SourceCluster    string
	Storage          string
	SecretAgent      string
	IntervalCron     string
	IncrIntervalCron string
	PartitionList    string
	Disabled         bool

	Namespaces []string
	BinList    []string
	SetList    []string
	NodeList   []string
	RackList   []int
}

type ConfigStorageFields struct {
	// Name is the storage name (URL path parameter).
	Name string

	// LocalStorage.*
	LocalPath        string
	LocalMinPartSize int

	// S3Storage.*
	S3Bucket              string
	S3Region              string
	S3AccessKeyID         string
	S3SecretAccessKey     string
	S3Path                string
	S3EndpointOverride    string
	S3Profile             string
	S3LogLevel            string
	S3MinPartSize         int
	S3MaxAsyncConnections int
	S3SecretAgentName     string

	// GcpStorage.*
	GcpBucketName       string
	GcpKey              string
	GcpKeyFilePath      string
	GcpEndpoint         string
	GcpPath             string
	GcpMinPartSize      int
	GcpSecretAgentName  string
	GcpStorageClassData string

	// AzureStorage.*
	AzureAccountName      string
	AzureAccountKey       string
	AzureClientID         string
	AzureClientSecret     string
	AzureContainerName    string
	AzureEndpoint         string
	AzureTenantID         string
	AzurePath             string
	AzureMinPartSize      int
	AzureSecretAgentName  string
	AzureStorageClassData string
	AzureStorageClassMeta string
}

type ConfigUpdate struct {
	// File is a path to a YAML file with the full DtoConfig body.
	File string
}

type Encryption struct {
	Mode      string
	KeyFile   string
	KeyEnv    string
	KeySecret string
}

type GcpStorage struct {
	// Path to file containing Service Account JSON Key.
	KeyFile string
	// For GPC storage bucket is not part of the path as in S3.
	// So we should set it separately.
	BucketName string
	// Alternative url.
	// It is not recommended to use an alternate URL in a production environment.
	Endpoint string

	RetryMaxAttempts       int
	RetryBackoffMax        int
	RetryBackoffInit       int
	RetryBackoffMultiplier float64

	ChunkSize int

	StorageCommon
}

type Local struct {
	BufferSize int
}

type Metadata struct {
	BackupID      string `json:"backup_id"`
	Namespace     string `json:"namespace"`
	FormatVersion int    `json:"format_version"`
	Nodes         []Node `json:"nodes"`
}

type Node struct {
	NodeID         string    `json:"node_id"`
	Created        time.Time `json:"created"`
	Finished       time.Time `json:"finished"`
	RecordCount    int64     `json:"record_count"`
	ByteCount      int64     `json:"byte_count"`
	PartitionCount int       `json:"partition_count"`
	SegmentCount   int       `json:"segment_count"`
}

type Restore struct {
	Common

	InputFile          string
	DirectoryList      string
	ParentDirectory    string
	DisableBatchWrites bool
	BatchSize          int
	MaxAsyncBatches    int
	// For optimal performance, should be at least MaxAsyncBatches.
	// This is applicable only to batch writes.
	WarmUp            int
	ExtraTTL          int64
	IgnoreRecordError bool
	Uniq              bool
	Replace           bool
	NoGeneration      bool

	RetryBaseInterval int64
	RetryMultiplier   float64
	RetryMaxAttempts  uint

	Mode string

	ValidateOnly      bool
	ApplyMetadataLast bool
}

type RestoreJobID struct {
	JobID int64
}

type RestoreJobsFilter struct {
	From   int64
	To     int64
	Status string
}

type RestoreRequest struct {
	// BackupDataPath is the path to the backup data inside the storage root.
	BackupDataPath string

	// DestinationName references a preconfigured destination cluster by name.
	DestinationName string

	// SourceName references a preconfigured storage source by name.
	SourceName string

	// SecretAgentName references a preconfigured secret agent by name.
	SecretAgentName string
}

type RestoreTimestampRequest struct {
	// Routine is the backup routine name to restore from.
	Routine string

	// Time is the epoch time in milliseconds for point-in-time recovery.
	Time int64

	// DestinationName references a preconfigured destination cluster by name.
	DestinationName string

	// SecretAgentName references a preconfigured secret agent by name.
	SecretAgentName string

	// DisableReordering disables the reverse order of incremental backups optimization.
	DisableReordering bool
}

type Root struct {
	Help    bool
	Version bool
}

type SecretAgent struct {
	ConnectionType     string
	Address            string
	Port               int
	TimeoutMillisecond int

	CaFile   string
	TLSName  string
	CertFile string
	KeyFile  string

	IsBase64 bool
}

type ServerBackup struct {
	ListPath    string
	Namespace   string
	JobID       string
	StorageType string
}

type ServiceConnection struct {
	Host string
	Port int
}

type StorageCommon struct {
	MaxConnsPerHost int
	RequestTimeout  int

	CalculateChecksum bool

	RetryReadBackoff     int
	RetryReadMultiplier  float64
	RetryReadMaxAttempts uint
}