types

type BackupUsage struct {
	// The ID of the backup
	ID string `json:"id"`

	// The completion time of the backup
	CompletionTime string `json:"completion_time"`

	// The size of the backup in GiB
	SizeInGib float64 `json:"size_in_gib"`

	// The type of backup
	Type string `json:"type"`

	// The list of collections included in the backup
	Collections []string `json:"collections"`
}

type CollectionUsage struct {
	// The name of the collection
	Name string `json:"name"`

	// The replication factor of the collection
	ReplicationFactor int `json:"replication_factor"`

	// The number of unique shards in the collection
	UniqueShardCount int `json:"unique_shard_count"`

	// List of shards and their metrics
	Shards []*ShardUsage `json:"shards"`
}

type Dimensionality struct {
	// The dimensionality of the vectors
	Dimensions int `json:"dimensionality"`

	// The number of objects with this dimensionality
	Count int `json:"count"`
}

type ObjectUsage struct {
	Count        int64
	StorageBytes int64
}

type Report struct {
	// The version of usage policy, date based versioning
	// e.g. 2025-06-01
	Version string `json:"version"`

	// The name of the node
	Node string `json:"node"`

	// List of collections and their metrics
	Collections []*CollectionUsage `json:"collections"`

	// List of backups and their metrics
	Backups []*BackupUsage `json:"backups"`
}

type ShardUsage struct {
	// The name of the shard
	Name string `json:"name"`

	// The number of objects in the shard
	ObjectsCount int64 `json:"objects_count"`

	// The storage size in bytes
	ObjectsStorageBytes uint64 `json:"objects_storage_bytes"`

	// The actual memory storage bytes used by vectors
	VectorStorageBytes uint64 `json:"vector_storage_bytes"`

	// List of named vectors and their metrics
	NamedVectors []*VectorUsage `json:"named_vectors"`
}

type VectorUsage struct {
	// The name of the vector
	Name string `json:"name"`

	// The type of vector index
	VectorIndexType string `json:"vectorIndexType"`

	// The compression type used
	Compression string `json:"compression"`

	// The compression ratio achieved
	VectorCompressionRatio float64 `json:"vector_compression_ratio"`

	// The actual memory storage bytes used by vectors
	VectorStorageBytes int64 `json:"vector_storage_bytes"`

	// List of dimensionalities and their metrics
	Dimensionalities []*Dimensionality `json:"dimensionalities"`
}