snapshot

type ID string

type Query struct {
	// Query by ID
	ID  ID   `json:"id"`
	IDs []ID `json:"ids"`

	// Pagination ..
	Offset int `json:"offset"`
	Limit  int `json:"limit"`

	Name        string `json:"name"`
	Creator     string `json:"creator"`
	CreatorName string `json:"creator_username"`
	Owner       string `json:"owner"`
	OwnerName   string `json:"owner_username"`

	// Flag to signal orders
	SortBy    string `json:"sortby"`
	OrderType string `json:"order"`

	// For now, the query will try to match entries that matches
	// all attributes present in here.
	Attr attrs.Attrs `json:"attr"`

	// Query snapshot within a particular snapshot.
	VolSetID volumeset.ID `json:"volset_id"`

	Search string `json:"search"`
}

type Snapshot struct {
	ID               ID           `json:"id"`
	ParentID         *ID          `json:"parent_id"`
	VolSetID         volumeset.ID `json:"volsetid"`
	CreationTime     time.Time    `json:"creation_time"`
	Size             uint64       `json:"size"`
	Creator          string       `json:"creator"`
	CreatorName      string       `json:"creator_name"`
	Owner            string       `json:"owner"`
	OwnerName        string       `json:"owner_name"`
	Attrs            attrs.Attrs  `json:"attrs"`
	Name             string       `json:"name"`
	LastModifiedTime time.Time    `json:"last_modified_time"` // last time the meta data is modified
	Description      string       `json:"description"`

	// Local fields that should nt be synced to another MDS
	// TODO: This json skip only works for a remote MDS which passes objects marshalled by JSON.
	// It doesn't work for a local MDS.
	// BlobID is the current blob id
	BlobID blob.ID `json:"-"`

	// PrevBlobID is the blob id at the time this object is created
	PrevBlobID blob.ID `json:"-"`

	// Note: Following fields are used by different logic including sync, adding new snapshots, etc.
	//       They are exposed and can be used for other purposes, for example, show to UI.
	//       These fields are immutable. Also, they are only valid after a read from the MDS.
	//       (For example, after calling ImportSnapshot(), the snapshots passed for import may not have
	//       the right depth)
	Depth       int    `json:"depth"`
	NumChildren int    `json:"number_children"`
	IsTip       bool   `json:"is_tip"`      // True if the snapshot is the end of a branch(may not be a leaf)
	BranchName  string `json:"branch_name"` // valid only if 'IsTip' is true
}