options

type Opt func(*Options)

type Options struct {
	// PathList contains a list of files or directories.
	PathList []string
	// IsDir flag determines whether the path is a directory.
	IsDir bool
	// IsRemovingFiles flag specifies whether to clear the backup folder.
	IsRemovingFiles bool
	// Validator contains files Validator that is applied to files if IsDir is true.
	Validator validator
	// WithNestedDir determines whether the read/write operations should treat objects
	// identified as directories like regular files.
	// When we stream files or delete files in folder, we skip directories. Setting
	// WithNestedDir to true disables this directory skipping behavior.
	// Default: false
	WithNestedDir bool
	// StartAfter is an artificial parameter. Used to skip objects in the storage.
	// The Result will not include an object specified in startAfter.
	// If it is set, then we compare the names received from the storage lexicographically,
	// and if the name is less than the specified parameter, we skip this object.
	StartAfter string
	// SkipDirCheck, if true, the backup directory won't be checked.
	SkipDirCheck bool
	// SortFiles determines whether we need to sort files before reading.
	SortFiles bool

	// UploadConcurrency defines the max number of concurrent uploads to be performed to
	// upload the file. Each concurrent upload will create a buffer of size BlockSize.
	UploadConcurrency int

	// StorageClass specifies the type of storage class.
	// Supported values depend on the cloud provider being used.
	StorageClass string

	// The access tier that will be applied to back up files.
	AccessTier string

	// Logger contains logger.
	Logger *slog.Logger

	// How often restore status will be polled from cloud provider.
	PollWarmDuration time.Duration

	// Size of chunk to upload.
	ChunkSize int

	// RetryPolicy is used to control the number of retries for failed requests.
	// At the moment supported only for S3 Reader.
	RetryPolicy *models.RetryPolicy

	// CalculateTotalSize determines whether we need to calculate the total size of all files in a path on Reader creation.
	CalculateTotalSize bool
}