cmn

type AllBsummResults []*BsummResult

type ArchiveBckMsg struct {
	ToBck Bck `json:"tobck"`
	apc.ArchiveMsg
}

type AuthConf struct {
	Secret  string `json:"secret"`
	Enabled bool   `json:"enabled"`
}

type AuthConfToSet struct {
	Secret  *string `json:"secret,omitempty"`
	Enabled *bool   `json:"enabled,omitempty"`
}

type BackendBckToSet struct {
	Name     *string `json:"name"`
	Provider *string `json:"provider"`
}

type BackendConf struct {
	// provider implementation-dependent
	Conf map[string]any `json:"conf,omitempty"`
	// 3rd party Cloud(s) -- set during validation
	Providers map[string]Ns `json:"-"`
}

type BackendConfAIS map[string][]string // cluster alias -> [urls...]

type BackendConfHDFS struct {
	Addresses           []string `json:"addresses"`
	User                string   `json:"user"`
	UseDatanodeHostname bool     `json:"use_datanode_hostname"`
}

type Bck struct {
	Props    *Bprops `json:"-"`
	Name     string  `json:"name" yaml:"name"`
	Provider string  `json:"provider" yaml:"provider"` // NOTE: see api/apc/provider.go for supported enum
	Ns       Ns      `json:"namespace" yaml:"namespace" list:"omitempty"`
}

type Bcks []Bck

type Bprops struct {
	BackendBck  Bck             `json:"backend_bck,omitempty"` // makes remote bucket out of a given ais bucket
	Extra       ExtraProps      `json:"extra,omitempty" list:"omitempty"`
	WritePolicy WritePolicyConf `json:"write_policy"`
	Provider    string          `json:"provider" list:"readonly"`       // backend provider
	Renamed     string          `list:"omit"`                           // non-empty if the bucket has been renamed
	Cksum       CksumConf       `json:"checksum"`                       // the bucket's checksum
	EC          ECConf          `json:"ec"`                             // erasure coding
	LRU         LRUConf         `json:"lru"`                            // LRU (watermarks and enabled/disabled)
	Mirror      MirrorConf      `json:"mirror"`                         // mirroring
	Access      apc.AccessAttrs `json:"access,string"`                  // access permissions
	BID         uint64          `json:"bid,string" list:"omit"`         // unique ID
	Created     int64           `json:"created,string" list:"readonly"` // creation timestamp
	Versioning  VersionConf     `json:"versioning"`                     // versioning (see "inherit")
}

type BpropsToSet struct {
	BackendBck  *BackendBckToSet      `json:"backend_bck,omitempty"`
	Versioning  *VersionConfToSet     `json:"versioning,omitempty"`
	Cksum       *CksumConfToSet       `json:"checksum,omitempty"`
	LRU         *LRUConfToSet         `json:"lru,omitempty"`
	Mirror      *MirrorConfToSet      `json:"mirror,omitempty"`
	EC          *ECConfToSet          `json:"ec,omitempty"`
	Access      *apc.AccessAttrs      `json:"access,string,omitempty"`
	WritePolicy *WritePolicyConfToSet `json:"write_policy,omitempty"`
	Extra       *ExtraToSet           `json:"extra,omitempty"`
	Force       bool                  `json:"force,omitempty" copy:"skip" list:"omit"`
}

type BsummResult struct {
	Bck
	apc.BsummResult
}

type CksumConf struct {
	// (note that `ChecksumNone` ("none") disables checksumming)
	Type string `json:"type"`

	// validate the checksum of the object that we cold-GET
	// or download from remote location (e.g., cloud bucket)
	ValidateColdGet bool `json:"validate_cold_get"`

	// validate object's version (if exists and provided) and its checksum -
	// if either value fail to match, the object is removed from ais.
	//
	// NOTE: object versioning is backend-specific and is may _not_ be supported by a given
	// (supported) backends - see docs for details.
	ValidateWarmGet bool `json:"validate_warm_get"`

	// determines whether to validate checksums of objects
	// migrated or replicated within the cluster
	ValidateObjMove bool `json:"validate_obj_move"`

	// EnableReadRange: Return read range checksum otherwise return entire object checksum.
	EnableReadRange bool `json:"enable_read_range"`
}

type CksumConfToSet struct {
	Type            *string `json:"type,omitempty"`
	ValidateColdGet *bool   `json:"validate_cold_get,omitempty"`
	ValidateWarmGet *bool   `json:"validate_warm_get,omitempty"`
	ValidateObjMove *bool   `json:"validate_obj_move,omitempty"`
	EnableReadRange *bool   `json:"enable_read_range,omitempty"`
}

type ClientConf struct {
	Timeout        cos.Duration `json:"client_timeout"`
	TimeoutLong    cos.Duration `json:"client_long_timeout"`
	ListObjTimeout cos.Duration `json:"list_timeout"`
}

type ClientConfToSet struct {
	Timeout        *cos.Duration `json:"client_timeout,omitempty"` // readonly as far as intra-cluster
	TimeoutLong    *cos.Duration `json:"client_long_timeout,omitempty"`
	ListObjTimeout *cos.Duration `json:"list_timeout,omitempty"`
}

type ClusterConfig struct {
	Ext        any            `json:"ext,omitempty"` // within meta-version extensions
	Backend    BackendConf    `json:"backend" allow:"cluster"`
	Mirror     MirrorConf     `json:"mirror" allow:"cluster"`
	EC         ECConf         `json:"ec" allow:"cluster"`
	Log        LogConf        `json:"log"`
	Periodic   PeriodConf     `json:"periodic"`
	Timeout    TimeoutConf    `json:"timeout"`
	Client     ClientConf     `json:"client"`
	Proxy      ProxyConf      `json:"proxy" allow:"cluster"`
	Space      SpaceConf      `json:"space"`
	LRU        LRUConf        `json:"lru"`
	Disk       DiskConf       `json:"disk"`
	Rebalance  RebalanceConf  `json:"rebalance" allow:"cluster"`
	Resilver   ResilverConf   `json:"resilver"`
	Cksum      CksumConf      `json:"checksum"`
	Versioning VersionConf    `json:"versioning" allow:"cluster"`
	Net        NetConf        `json:"net"`
	FSHC       FSHCConf       `json:"fshc"`
	Auth       AuthConf       `json:"auth"`
	Keepalive  KeepaliveConf  `json:"keepalivetracker"`
	Downloader DownloaderConf `json:"downloader"`
	Dsort      DsortConf      `json:"distributed_sort"`
	Transport  TransportConf  `json:"transport"`
	Memsys     MemsysConf     `json:"memsys"`

	// Transform (offline) or Copy src Bucket => dst bucket
	TCB TCBConf `json:"tcb"`

	// metadata write policy: (immediate | delayed | never)
	WritePolicy WritePolicyConf `json:"write_policy"`

	// standalone enumerated features that can be configured
	// to flip assorted global defaults (see cmn/feat/feat.go)
	Features feat.Flags `json:"features,string" allow:"cluster"`

	// read-only
	LastUpdated string `json:"lastupdate_time"`       // timestamp
	UUID        string `json:"uuid"`                  // UUID
	Version     int64  `json:"config_version,string"` // version
}

type Config struct {
	ClusterConfig `json:",inline"`
	LocalConfig   `json:",inline"`
	// contains filtered or unexported fields
}

type ConfigToSet struct {
	// ClusterConfig
	Backend     *BackendConf          `json:"backend,omitempty"`
	Mirror      *MirrorConfToSet      `json:"mirror,omitempty"`
	EC          *ECConfToSet          `json:"ec,omitempty"`
	Log         *LogConfToSet         `json:"log,omitempty"`
	Periodic    *PeriodConfToSet      `json:"periodic,omitempty"`
	Timeout     *TimeoutConfToSet     `json:"timeout,omitempty"`
	Client      *ClientConfToSet      `json:"client,omitempty"`
	Space       *SpaceConfToSet       `json:"space,omitempty"`
	LRU         *LRUConfToSet         `json:"lru,omitempty"`
	Disk        *DiskConfToSet        `json:"disk,omitempty"`
	Rebalance   *RebalanceConfToSet   `json:"rebalance,omitempty"`
	Resilver    *ResilverConfToSet    `json:"resilver,omitempty"`
	Cksum       *CksumConfToSet       `json:"checksum,omitempty"`
	Versioning  *VersionConfToSet     `json:"versioning,omitempty"`
	Net         *NetConfToSet         `json:"net,omitempty"`
	FSHC        *FSHCConfToSet        `json:"fshc,omitempty"`
	Auth        *AuthConfToSet        `json:"auth,omitempty"`
	Keepalive   *KeepaliveConfToSet   `json:"keepalivetracker,omitempty"`
	Downloader  *DownloaderConfToSet  `json:"downloader,omitempty"`
	Dsort       *DsortConfToSet       `json:"distributed_sort,omitempty"`
	Transport   *TransportConfToSet   `json:"transport,omitempty"`
	Memsys      *MemsysConfToSet      `json:"memsys,omitempty"`
	TCB         *TCBConfToSet         `json:"tcb,omitempty"`
	WritePolicy *WritePolicyConfToSet `json:"write_policy,omitempty"`
	Proxy       *ProxyConfToSet       `json:"proxy,omitempty"`
	Features    *feat.Flags           `json:"features,string,omitempty"`

	// LocalConfig
	FSP *FSPConf `json:"fspaths,omitempty"`
}

type DiskConf struct {
	DiskUtilLowWM   int64        `json:"disk_util_low_wm"`  // no throttling below
	DiskUtilHighWM  int64        `json:"disk_util_high_wm"` // throttle longer when above
	DiskUtilMaxWM   int64        `json:"disk_util_max_wm"`
	IostatTimeLong  cos.Duration `json:"iostat_time_long"`
	IostatTimeShort cos.Duration `json:"iostat_time_short"`
}

type DiskConfToSet struct {
	DiskUtilLowWM   *int64        `json:"disk_util_low_wm,omitempty"`
	DiskUtilHighWM  *int64        `json:"disk_util_high_wm,omitempty"`
	DiskUtilMaxWM   *int64        `json:"disk_util_max_wm,omitempty"`
	IostatTimeLong  *cos.Duration `json:"iostat_time_long,omitempty"`
	IostatTimeShort *cos.Duration `json:"iostat_time_short,omitempty"`
}

type DownloaderConf struct {
	Timeout cos.Duration `json:"timeout"`
}

type DownloaderConfToSet struct {
	Timeout *cos.Duration `json:"timeout,omitempty"`
}

type DsortConf struct {
	DuplicatedRecords   string       `json:"duplicated_records"`
	MissingShards       string       `json:"missing_shards"` // cmn.SupportedReactions enum
	EKMMalformedLine    string       `json:"ekm_malformed_line"`
	EKMMissingKey       string       `json:"ekm_missing_key"`
	DefaultMaxMemUsage  string       `json:"default_max_mem_usage"`
	CallTimeout         cos.Duration `json:"call_timeout"`
	DsorterMemThreshold string       `json:"dsorter_mem_threshold"`
	Compression         string       `json:"compression"`       // {CompressAlways,...} in api/apc/compression.go
	SbundleMult         int          `json:"bundle_multiplier"` // stream-bundle multiplier: num to destination
}

type DsortConfToSet struct {
	DuplicatedRecords   *string       `json:"duplicated_records,omitempty"`
	MissingShards       *string       `json:"missing_shards,omitempty"`
	EKMMalformedLine    *string       `json:"ekm_malformed_line,omitempty"`
	EKMMissingKey       *string       `json:"ekm_missing_key,omitempty"`
	DefaultMaxMemUsage  *string       `json:"default_max_mem_usage,omitempty"`
	CallTimeout         *cos.Duration `json:"call_timeout,omitempty"`
	DsorterMemThreshold *string       `json:"dsorter_mem_threshold,omitempty"`
	Compression         *string       `json:"compression,omitempty"`
	SbundleMult         *int          `json:"bundle_multiplier,omitempty"`
}

type ECConf struct {
	Compression string `json:"compression"` // enum { CompressAlways, ... } in api/apc/compression.go

	// ObjSizeLimit is object size threshold _separating_ intra-cluster mirroring from
	// erasure coding.
	//
	// The value 0 (zero) indicates that objects of any size
	// are to be sliced, to produce (D) data slices and (P) erasure coded parity slices.
	// On the other hand, the value -1 specifies that absolutely all objects of any size
	// must be replicated as is. In effect, the (-1) option provides data protection via
	// intra-cluster (P+1)-way replication (a.k.a. mirroring).
	//
	// In all cases, a given (D, P) configuration provides node-level redundancy,
	// whereby P nodes can be lost without incurring loss of data.
	ObjSizeLimit int64 `json:"objsize_limit"`

	// Number of data (D) slices; the value 1 will have an effect of producing
	// (P) additional full-size replicas.
	DataSlices int `json:"data_slices"`

	// Depending on the object size and `ObjSizeLimit`, the value of `ParitySlices` (or P) indicates:
	// - a number of additional parity slices (generated or _computed_ from the (D) data slices),
	// or:
	// - a number of full object replicas (copies).
	// In all cases, the same rule applies: all slices and/or all full copies are stored on different
	// storage nodes (a.k.a. targets).
	ParitySlices int `json:"parity_slices"`

	SbundleMult int `json:"bundle_multiplier"` // stream-bundle multiplier: num streams to destination

	Enabled  bool `json:"enabled"`   // EC is enabled
	DiskOnly bool `json:"disk_only"` // if true, EC does not use SGL - data goes directly to drives
}

type ECConfToSet struct {
	ObjSizeLimit *int64  `json:"objsize_limit,omitempty"`
	Compression  *string `json:"compression,omitempty"`
	SbundleMult  *int    `json:"bundle_multiplier,omitempty"`
	DataSlices   *int    `json:"data_slices,omitempty"`
	ParitySlices *int    `json:"parity_slices,omitempty"`
	Enabled      *bool   `json:"enabled,omitempty"`
	DiskOnly     *bool   `json:"disk_only,omitempty"`
}

type ETLErrCtx struct {
	TID     string
	ETLName string
	PodName string
	SvcName string
}

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

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

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

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

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

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

type ErrETL struct {
	Reason string
	ETLErrCtx
}

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

type ErrHTTP struct {
	TypeCode   string `json:"tcode,omitempty"`
	Message    string `json:"message"`
	Method     string `json:"method"`
	URLPath    string `json:"url_path"`
	RemoteAddr string `json:"remote_addr"`
	Caller     string `json:"caller"`
	Node       string `json:"node"`

	Status int `json:"status"`
	// contains filtered or unexported fields
}

type ErrInitBackend struct {
	Provider string
}

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

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

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

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

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

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

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

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

type ErrMissingBackend struct {
	Provider string
	Msg      string
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type ExtraProps struct {
	AWS  ExtraPropsAWS  `json:"aws,omitempty" list:"omitempty"`
	HTTP ExtraPropsHTTP `json:"http,omitempty" list:"omitempty"`
	HDFS ExtraPropsHDFS `json:"hdfs,omitempty" list:"omitempty"`
}

type ExtraPropsAWS struct {
	CloudRegion string `json:"cloud_region,omitempty"`

	// from https://github.com/aws/aws-sdk-go/blob/main/aws/config.go:
	// - "An optional endpoint URL (hostname only or fully qualified URI)
	// that overrides the default generated endpoint."
	Endpoint string `json:"endpoint,omitempty"`

	// from https://github.com/aws/aws-sdk-go/blob/main/aws/session/session.go:
	// - "Overrides the config profile the Session should be created from. If not
	// set the value of the environment variable will be loaded (AWS_PROFILE,
	// or AWS_DEFAULT_PROFILE if the Shared Config is enabled)."
	Profile string `json:"profile,omitempty"`

	// Amazon S3: 1000
	// - https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-pagination.html#cli-usage-pagination-serverside
	// vs OpenStack Swift: 10,000
	// - https://docs.openstack.org/swift/latest/api/pagination.html
	MaxPageSize uint `json:"max_pagesize,omitempty"`
}

type ExtraPropsAWSToSet struct {
	CloudRegion *string `json:"cloud_region"`
	Endpoint    *string `json:"endpoint"`
	Profile     *string `json:"profile"`
	MaxPageSize *uint   `json:"max_pagesize"`
}

type ExtraPropsHDFS struct {
	// Reference directory.
	RefDirectory string `json:"ref_directory,omitempty"`
}

type ExtraPropsHDFSToSet struct {
	RefDirectory *string `json:"ref_directory"`
}

type ExtraPropsHTTP struct {
	// Original URL prior to hashing.
	OrigURLBck string `json:"original_url,omitempty" list:"readonly"`
}

type ExtraPropsHTTPToSet struct {
	OrigURLBck *string `json:"original_url"`
}

type ExtraToSet struct {
	AWS  *ExtraPropsAWSToSet  `json:"aws"`
	HTTP *ExtraPropsHTTPToSet `json:"http"`
	HDFS *ExtraPropsHDFSToSet `json:"hdfs"`
}

type FSHCConf struct {
	TestFileCount int  `json:"test_files"`  // number of files to read/write
	ErrorLimit    int  `json:"error_limit"` // exceeding err limit causes disabling mountpath
	Enabled       bool `json:"enabled"`
}

type FSHCConfToSet struct {
	TestFileCount *int  `json:"test_files,omitempty"`
	ErrorLimit    *int  `json:"error_limit,omitempty"`
	Enabled       *bool `json:"enabled,omitempty"`
}

type FSPConf struct {
	Paths cos.StrSet `json:"paths,omitempty" list:"readonly"`
}

type HTTPBckObj struct {
	Bck        Bck
	ObjName    string
	OrigURLBck string // HTTP URL of the bucket (object name excluded)
}

type HTTPConf struct {
	Proto           string `json:"-"`                 // http or https (set depending on `UseHTTPS`)
	Certificate     string `json:"server_crt"`        // HTTPS: X509 certificate
	CertKey         string `json:"server_key"`        // HTTPS: X509 key
	ServerNameTLS   string `json:"domain_tls"`        // #6410
	ClientCA        string `json:"client_ca_tls"`     // #6410
	ClientAuthTLS   int    `json:"client_auth_tls"`   // #6410 tls.ClientAuthType enum
	WriteBufferSize int    `json:"write_buffer_size"` // http.Transport.WriteBufferSize; zero defaults to 4KB
	ReadBufferSize  int    `json:"read_buffer_size"`  // http.Transport.ReadBufferSize; ditto
	UseHTTPS        bool   `json:"use_https"`         // use HTTPS
	SkipVerifyCrt   bool   `json:"skip_verify"`       // skip X509 cert verification (used with self-signed certs)
	Chunked         bool   `json:"chunked_transfer"`  // (https://tools.ietf.org/html/rfc7230#page-36; not used since 02/23)
}

type HTTPConfToSet struct {
	Certificate     *string `json:"server_crt,omitempty"`
	CertKey         *string `json:"server_key,omitempty"`
	ServerNameTLS   *string `json:"domain_tls,omitempty"`
	ClientCA        *string `json:"client_ca_tls,omitempty"`
	WriteBufferSize *int    `json:"write_buffer_size,omitempty" list:"readonly"`
	ReadBufferSize  *int    `json:"read_buffer_size,omitempty" list:"readonly"`
	ClientAuthTLS   *int    `json:"client_auth_tls,omitempty"`
	UseHTTPS        *bool   `json:"use_https,omitempty"`
	SkipVerifyCrt   *bool   `json:"skip_verify,omitempty"`
	Chunked         *bool   `json:"chunked_transfer,omitempty"`
}

type HreqArgs struct {
	BodyR    io.Reader
	Header   http.Header // request headers
	Query    url.Values  // query, e.g. ?a=x&b=y&c=z
	RawQuery string      // raw query
	Method   string
	Base     string // base URL, e.g. http://xyz.abc
	Path     string // path URL, e.g. /x/y/z
	Body     []byte
}

type IterField interface {
	Value() any                          // returns the value
	String() string                      // string representation of the value
	SetValue(v any, force ...bool) error // `force` ignores `tagReadonly` (to be used with caution!)
}

type IterOpts struct {
	// Skip fields based on allowed tag
	Allowed string
	// Visits all the fields, not only the leaves.
	VisitAll bool
	// Read-only walk is true by default (compare with `UpdateFieldValue`)
	// Note that `tagOmitempty` is limited to read-only - has no effect when `OnlyRead == false`.
	OnlyRead bool
}

type KeepaliveConf struct {
	Proxy       KeepaliveTrackerConf `json:"proxy"`  // how proxy tracks target keepalives
	Target      KeepaliveTrackerConf `json:"target"` // how target tracks primary proxies keepalives
	RetryFactor uint8                `json:"retry_factor"`
}

type KeepaliveConfToSet struct {
	Proxy       *KeepaliveTrackerConfToSet `json:"proxy,omitempty"`
	Target      *KeepaliveTrackerConfToSet `json:"target,omitempty"`
	RetryFactor *uint8                     `json:"retry_factor,omitempty"`
}

type KeepaliveTrackerConf struct {
	Name     string       `json:"name"`     // "heartbeat" (other enumerated values TBD)
	Interval cos.Duration `json:"interval"` // keepalive interval
	Factor   uint8        `json:"factor"`   // only average
}

type KeepaliveTrackerConfToSet struct {
	Interval *cos.Duration `json:"interval,omitempty"`
	Name     *string       `json:"name,omitempty" list:"readonly"`
	Factor   *uint8        `json:"factor,omitempty"`
}

type L4Conf struct {
	Proto         string `json:"proto"`           // tcp, udp
	SndRcvBufSize int    `json:"sndrcv_buf_size"` // SO_RCVBUF and SO_SNDBUF
}

type LRUConf struct {
	// DontEvictTimeStr denotes the period of time during which eviction of an object
	// is forbidden [atime, atime + DontEvictTime]
	DontEvictTime cos.Duration `json:"dont_evict_time"`

	// CapacityUpdTimeStr denotes the frequency at which AIStore updates local capacity utilization
	CapacityUpdTime cos.Duration `json:"capacity_upd_time"`

	// Enabled: LRU will only run when set to true
	Enabled bool `json:"enabled"`
}

type LRUConfToSet struct {
	DontEvictTime   *cos.Duration `json:"dont_evict_time,omitempty"`
	CapacityUpdTime *cos.Duration `json:"capacity_upd_time,omitempty"`
	Enabled         *bool         `json:"enabled,omitempty"`
}

type LocalConfig struct {
	ConfigDir string         `json:"confdir"`
	LogDir    string         `json:"log_dir"`
	HostNet   LocalNetConfig `json:"host_net"`
	FSP       FSPConf        `json:"fspaths"`
	TestFSP   TestFSPConf    `json:"test_fspaths"`
}

type LocalNetConfig struct {
	Hostname             string `json:"hostname"`
	HostnameIntraControl string `json:"hostname_intra_control"`
	HostnameIntraData    string `json:"hostname_intra_data"`
	Port                 int    `json:"port,string"`               // listening port
	PortIntraControl     int    `json:"port_intra_control,string"` // --/-- for intra-cluster control
	PortIntraData        int    `json:"port_intra_data,string"`    // --/-- for intra-cluster data
	// omit
	UseIntraControl bool `json:"-"`
	UseIntraData    bool `json:"-"`
}

type LogConf struct {
	Level     cos.LogLevel `json:"level"`      // log level (aka verbosity)
	MaxSize   cos.SizeIEC  `json:"max_size"`   // exceeding this size triggers log rotation
	MaxTotal  cos.SizeIEC  `json:"max_total"`  // (sum individual log sizes); exceeding this number triggers cleanup
	FlushTime cos.Duration `json:"flush_time"` // log flush interval
	StatsTime cos.Duration `json:"stats_time"` // (not used)
}

type LogConfToSet struct {
	Level     *cos.LogLevel `json:"level,omitempty"`
	MaxSize   *cos.SizeIEC  `json:"max_size,omitempty"`
	MaxTotal  *cos.SizeIEC  `json:"max_total,omitempty"`
	FlushTime *cos.Duration `json:"flush_time,omitempty"`
	StatsTime *cos.Duration `json:"stats_time,omitempty"`
}

type LsoEntries []*LsoEntry

type LsoEntry struct {
	Name     string `json:"name" msg:"n"`                            // object name
	Checksum string `json:"checksum,omitempty" msg:"cs,omitempty"`   // checksum
	Atime    string `json:"atime,omitempty" msg:"a,omitempty"`       // last access time; formatted as ListObjsMsg.TimeFormat
	Version  string `json:"version,omitempty" msg:"v,omitempty"`     // e.g., GCP int64 generation, AWS version (string), etc.
	Location string `json:"location,omitempty" msg:"t,omitempty"`    // [tnode:mountpath]
	Custom   string `json:"custom-md,omitempty" msg:"m,omitempty"`   // custom metadata: ETag, MD5, CRC, user-defined ...
	Size     int64  `json:"size,string,omitempty" msg:"s,omitempty"` // size in bytes
	Copies   int16  `json:"copies,omitempty" msg:"c,omitempty"`      // ## copies (NOTE: for non-replicated object copies == 1)
	Flags    uint16 `json:"flags,omitempty" msg:"f,omitempty"`       // enum { EntryIsCached, EntryIsDir, EntryInArch, ...}
}

type LsoResult struct {
	UUID              string     `json:"uuid"`
	ContinuationToken string     `json:"continuation_token"`
	Entries           LsoEntries `json:"entries"`
	Flags             uint32     `json:"flags"`
}

type MemsysConf struct {
	MinFree        cos.SizeIEC  `json:"min_free"`
	DefaultBufSize cos.SizeIEC  `json:"default_buf"`
	SizeToGC       cos.SizeIEC  `json:"to_gc"`
	HousekeepTime  cos.Duration `json:"hk_time"`
	MinPctTotal    int          `json:"min_pct_total"`
	MinPctFree     int          `json:"min_pct_free"`
}

type MemsysConfToSet struct {
	MinFree        *cos.SizeIEC  `json:"min_free,omitempty"`
	DefaultBufSize *cos.SizeIEC  `json:"default_buf,omitempty"`
	SizeToGC       *cos.SizeIEC  `json:"to_gc,omitempty"`
	HousekeepTime  *cos.Duration `json:"hk_time,omitempty"`
	MinPctTotal    *int          `json:"min_pct_total,omitempty"`
	MinPctFree     *int          `json:"min_pct_free,omitempty"`
}

type MirrorConf struct {
	Copies  int64 `json:"copies"`       // num copies
	Burst   int   `json:"burst_buffer"` // xaction channel (buffer) size
	Enabled bool  `json:"enabled"`      // enabled (to generate copies)
}

type MirrorConfToSet struct {
	Copies  *int64 `json:"copies,omitempty"`
	Burst   *int   `json:"burst_buffer,omitempty"`
	Enabled *bool  `json:"enabled,omitempty"`
}

type NetConf struct {
	L4   L4Conf   `json:"l4"`
	HTTP HTTPConf `json:"http"`
}

type NetConfToSet struct {
	HTTP *HTTPConfToSet `json:"http,omitempty"`
}

type Ns struct {
	// UUID of other remote AIS cluster (for now only used for AIS). Note
	// that we can have different namespaces which refer to same UUID (cluster).
	// This means that in a sense UUID is a parent of the actual namespace.
	UUID string `json:"uuid" yaml:"uuid"`
	// Name uniquely identifies a namespace under the same UUID (which may
	// be empty) and is used in building FQN for the objects.
	Name string `json:"name" yaml:"name"`
}

type OWT int

type ObjAttrs struct {
	Cksum    *cos.Cksum `json:"checksum,omitempty"`  // object checksum (cloned)
	CustomMD cos.StrKVs `json:"custom-md,omitempty"` // custom metadata: ETag, MD5, CRC, user-defined ...
	Ver      string     `json:"version,omitempty"`   // object version
	Atime    int64      `json:"atime,omitempty"`     // access time (nanoseconds since UNIX epoch)
	Size     int64      `json:"size,omitempty"`      // object size (bytes)
}

type ObjectProps struct {
	Bck Bck `json:"bucket"`
	ObjAttrs
	Name     string `json:"name"`
	Location string `json:"location"` // see also `GetPropsLocation`
	Mirror   struct {
		Paths  []string `json:"paths,omitempty"`
		Copies int      `json:"copies,omitempty"`
	} `json:"mirror"`
	EC struct {
		Generation   int64 `json:"generation"`
		DataSlices   int   `json:"data"`
		ParitySlices int   `json:"parity"`
		IsECCopy     bool  `json:"replicated"`
	} `json:"ec"`
	Present bool `json:"present"`
}

type ParseURIOpts struct {
	DefaultProvider string // If set the provider will be used as provider.
	IsQuery         bool   // Determines if the URI should be parsed as query.
}

type PeriodConf struct {
	StatsTime     cos.Duration `json:"stats_time"`      // collect and publish stats; other house-keeping
	RetrySyncTime cos.Duration `json:"retry_sync_time"` // metasync retry
	NotifTime     cos.Duration `json:"notif_time"`      // (IC notifications)
}

type PeriodConfToSet struct {
	StatsTime     *cos.Duration `json:"stats_time,omitempty"`
	RetrySyncTime *cos.Duration `json:"retry_sync_time,omitempty"`
	NotifTime     *cos.Duration `json:"notif_time,omitempty"`
}

type PropsValidator interface {
	ValidateAsProps(arg ...any) error
}

type ProxyConf struct {
	PrimaryURL   string `json:"primary_url"`
	OriginalURL  string `json:"original_url"`
	DiscoveryURL string `json:"discovery_url"`
	NonElectable bool   `json:"non_electable"`
}

type ProxyConfToSet struct {
	PrimaryURL   *string `json:"primary_url,omitempty"`
	OriginalURL  *string `json:"original_url,omitempty"`
	DiscoveryURL *string `json:"discovery_url,omitempty"`
	NonElectable *bool   `json:"non_electable,omitempty"`
}

type QueryBcks Bck

type RebalanceConf struct {
	Compression   string       `json:"compression"`       // enum { CompressAlways, ... } in api/apc/compression.go
	DestRetryTime cos.Duration `json:"dest_retry_time"`   // max wait for ACKs & neighbors to complete
	SbundleMult   int          `json:"bundle_multiplier"` // stream-bundle multiplier: num streams to destination
	Enabled       bool         `json:"enabled"`           // true=auto-rebalance | manual rebalancing
}

type RebalanceConfToSet struct {
	DestRetryTime *cos.Duration `json:"dest_retry_time,omitempty"`
	Compression   *string       `json:"compression,omitempty"`
	SbundleMult   *int          `json:"bundle_multiplier"`
	Enabled       *bool         `json:"enabled,omitempty"`
}

type ResilverConf struct {
	Enabled bool `json:"enabled"` // true=auto-resilver | manual resilvering
}

type ResilverConfToSet struct {
	Enabled *bool `json:"enabled,omitempty"`
}

type RetryArgs struct {
	Call    func() (int, error)
	IsFatal func(error) bool

	Action string
	Caller string

	SoftErr uint // How many retires on ConnectionRefused or ConnectionReset error.
	HardErr uint // How many retries on any other error.
	Sleep   time.Duration

	Verbosity int  // Determine the verbosity level.
	BackOff   bool // If requests should be retried less and less often.
	IsClient  bool // true: client (e.g. dev tools, etc.)
}

type SpaceConf struct {
	// Storage Cleanup watermark: used capacity (%) that triggers cleanup
	// (deleted objects and buckets, extra copies, etc.)
	CleanupWM int64 `json:"cleanupwm"`

	// LowWM: used capacity low-watermark (% of total local storage capacity)
	LowWM int64 `json:"lowwm"`

	// HighWM: used capacity high-watermark (% of total local storage capacity)
	// - LRU starts evicting objects when the currently used capacity (used-cap) gets above HighWM
	// - and keeps evicting objects until the used-cap gets below LowWM
	// - while self-throttling itself in accordance with target utilization
	HighWM int64 `json:"highwm"`

	// Out-of-Space: if exceeded, the target starts failing new PUTs and keeps
	// failing them until its local used-cap gets back below HighWM (see above)
	OOS int64 `json:"out_of_space"`
}

type SpaceConfToSet struct {
	CleanupWM *int64 `json:"cleanupwm,omitempty"`
	LowWM     *int64 `json:"lowwm,omitempty"`
	HighWM    *int64 `json:"highwm,omitempty"`
	OOS       *int64 `json:"out_of_space,omitempty"`
}

type TCBConf struct {
	Compression string `json:"compression"`       // enum { CompressAlways, ... } in api/apc/compression.go
	SbundleMult int    `json:"bundle_multiplier"` // stream-bundle multiplier: num streams to destination
}

type TCBConfToSet struct {
	Compression *string `json:"compression,omitempty"`
	SbundleMult *int    `json:"bundle_multiplier,omitempty"`
}

type TCObjsMsg struct {
	ToBck Bck `json:"tobck"`
	apc.TCObjsMsg
}

type TLSArgs struct {
	ClientCA    string
	Certificate string
	Key         string
	SkipVerify  bool
}

type TestFSPConf struct {
	Root     string `json:"root"`
	Count    int    `json:"count"`
	Instance int    `json:"instance"`
}

type TimeoutConf struct {
	CplaneOperation cos.Duration `json:"cplane_operation"` // read-mostly via global cmn.Rom.CplaneOperation
	MaxKeepalive    cos.Duration `json:"max_keepalive"`    // ditto, cmn.Rom.MaxKeepalive - see below
	MaxHostBusy     cos.Duration `json:"max_host_busy"`
	Startup         cos.Duration `json:"startup_time"`
	JoinAtStartup   cos.Duration `json:"join_startup_time"` // (join cluster at startup) timeout
	SendFile        cos.Duration `json:"send_file_time"`
}

type TimeoutConfToSet struct {
	CplaneOperation *cos.Duration `json:"cplane_operation,omitempty"`
	MaxKeepalive    *cos.Duration `json:"max_keepalive,omitempty"`
	MaxHostBusy     *cos.Duration `json:"max_host_busy,omitempty"`
	Startup         *cos.Duration `json:"startup_time,omitempty"`
	JoinAtStartup   *cos.Duration `json:"join_startup_time,omitempty"`
	SendFile        *cos.Duration `json:"send_file_time,omitempty"`
}

type TransportArgs struct {
	DialTimeout      time.Duration
	Timeout          time.Duration
	IdleConnTimeout  time.Duration
	IdleConnsPerHost int
	MaxIdleConns     int
	SndRcvBufSize    int
	WriteBufferSize  int
	ReadBufferSize   int
	UseHTTPProxyEnv  bool
}

type TransportConf struct {
	MaxHeaderSize int `json:"max_header"`   // max transport header buffer (default=4K)
	Burst         int `json:"burst_buffer"` // num sends with no back pressure; see also AIS_STREAM_BURST_NUM
	// two no-new-transmissions durations:
	// * IdleTeardown: sender terminates the connection (to reestablish it upon the very first/next PDU)
	// * QuiesceTime:  safe to terminate or transition to the next (in re: rebalance) stage
	IdleTeardown cos.Duration `json:"idle_teardown"`
	QuiesceTime  cos.Duration `json:"quiescent"`
	// lz4
	// max uncompressed block size, one of [64K, 256K(*), 1M, 4M]
	// fastcompression.blogspot.com/2013/04/lz4-streaming-format-final.html
	LZ4BlockMaxSize  cos.SizeIEC `json:"lz4_block"`
	LZ4FrameChecksum bool        `json:"lz4_frame_checksum"`
}

type TransportConfToSet struct {
	MaxHeaderSize    *int          `json:"max_header,omitempty" list:"readonly"`
	Burst            *int          `json:"burst_buffer,omitempty" list:"readonly"`
	IdleTeardown     *cos.Duration `json:"idle_teardown,omitempty"`
	QuiesceTime      *cos.Duration `json:"quiescent,omitempty"`
	LZ4BlockMaxSize  *cos.SizeIEC  `json:"lz4_block,omitempty"`
	LZ4FrameChecksum *bool         `json:"lz4_frame_checksum,omitempty"`
}

type Validator interface {
	Validate() error
}

type VersionConf struct {
	// Determines if versioning is enabled
	Enabled bool `json:"enabled"`

	// Validate remote version and, possibly, update in-cluster ("cached") copy.
	// Scenarios include (but are not limited to):
	// - warm GET
	// - prefetch bucket (*)
	// - prefetch multiple objects (see api/multiobj.go)
	// - copy bucket
	// Applies to Cloud and remote AIS buckets - generally, buckets that have remote backends
	// that in turn provide some form of object versioning.
	// (*) Xactions (ie., jobs) that read-access multiple objects (e.g., prefetch, copy-bucket)
	// may support operation-scope option to synchronize remote content (to aistore) - the option
	// not requiring changing bucket configuration.
	// See also:
	// - apc.QparamLatestVer, apc.PrefetchMsg, apc.CopyBckMsg
	ValidateWarmGet bool `json:"validate_warm_get"`

	// A stronger variant of the above that in addition entails:
	// - deleting in-cluster object if its remote ("cached") counterpart does not exist
	// See also: apc.QparamSync, apc.CopyBckMsg
	Sync bool `json:"synchronize"`
}

type VersionConfToSet struct {
	Enabled         *bool `json:"enabled,omitempty"`
	ValidateWarmGet *bool `json:"validate_warm_get,omitempty"`
	Sync            *bool `json:"synchronize,omitempty"`
}

type WritePolicyConf struct {
	Data apc.WritePolicy `json:"data"`
	MD   apc.WritePolicy `json:"md"`
}

type WritePolicyConfToSet struct {
	Data *apc.WritePolicy `json:"data,omitempty" list:"readonly"` // NOTE: NIY
	MD   *apc.WritePolicy `json:"md,omitempty"`
}