glusterd2/pkg/api/volume_resp.go

package api

import "github.com/pborman/uuid"

const (
	// ProvisionerTypeLoop represents loop device based provisioner
	ProvisionerTypeLoop = "loop"
	// ProvisionerTypeLvm represents LVM based provisioner
	ProvisionerTypeLvm = "lvm"
)

// BrickInfo contains the static information about the brick.
// Clients should NOT use this struct directly.
type BrickInfo struct {
	ID         uuid.UUID `json:"id"`
	Path       string    `json:"path"`
	VolumeID   uuid.UUID `json:"volume-id"`
	VolumeName string    `json:"volume-name"`
	PeerID     uuid.UUID `json:"peer-id"`
	Hostname   string    `json:"host"`
	Type       BrickType `json:"type"`
}

// Subvol contains static information about sub volume
type Subvol struct {
	Name                    string      `json:"name"`
	Type                    SubvolType  `json:"type"`
	Bricks                  []BrickInfo `json:"bricks"`
	Subvols                 []Subvol    `json:"subvols,omitempty"`
	ReplicaCount            int         `json:"replica-count"`
	ArbiterCount            int         `json:"arbiter-count"`
	DisperseCount           int         `json:"disperse-count"`
	DisperseDataCount       int         `json:"disperse-data-count,omitempty"`
	DisperseRedundancyCount int         `json:"disperse-redundancy-count,omitempty"`
}

// SizeInfo represents sizing information.
// Clients should NOT use this struct directly.
type SizeInfo struct {
	Capacity uint64 `json:"capacity"`
	Used     uint64 `json:"used"`
	Free     uint64 `json:"free"`
}

// BrickStatus contains the runtime information about the brick.
// Clients should NOT use this struct directly.
type BrickStatus struct {
	Info      BrickInfo `json:"info"`
	Online    bool      `json:"online"`
	Pid       int       `json:"pid"`
	Port      int       `json:"port"`
	FS        string    `json:"fs-type"`
	MountOpts string    `json:"mount-opts"`
	Device    string    `json:"device"`
	Size      SizeInfo  `json:"size"`
}

// BricksStatusResp contains statuses of bricks belonging to one
// volume.
type BricksStatusResp []BrickStatus

// VolumeInfo contains static information about the volume.
// Clients should NOT use this struct directly.
type VolumeInfo struct {
	ID                      uuid.UUID         `json:"id"`
	Name                    string            `json:"name"`
	Type                    VolType           `json:"type"`
	Transport               string            `json:"transport"`
	DistCount               int               `json:"distribute-count"`
	ReplicaCount            int               `json:"replica-count"`
	ArbiterCount            int               `json:"arbiter-count,omitempty"`
	DisperseCount           int               `json:"disperse-count,omitempty"`
	DisperseDataCount       int               `json:"disperse-data-count,omitempty"`
	DisperseRedundancyCount int               `json:"disperse-redundancy-count,omitempty"`
	Options                 map[string]string `json:"options"`
	State                   VolState          `json:"state"`
	Subvols                 []Subvol          `json:"subvols"`
	Metadata                map[string]string `json:"metadata"`
	SnapList                []string          `json:"snap-list"`
	Capacity                uint64            `json:"capacity,omitempty"`
}

// VolumeStatusResp response contains the statuses of all bricks of the volume.
type VolumeStatusResp struct {
	Info   VolumeInfo `json:"info"`
	Online bool       `json:"online"`
	Size   SizeInfo   `json:"size"`
}

// VolumeOptionGetResp is the response sent for a volume option get request
type VolumeOptionGetResp struct {
	OptName      string `json:"name"`
	Value        string `json:"value"`
	Modified     bool   `json:"modified"`
	DefaultValue string `json:"default-value"`
	OptionLevel  string `json:"option-level"`
}

// VolumeCreateResp is the response sent for a volume create request.
type VolumeCreateResp VolumeInfo

// VolumeGetResp is the response sent for a volume get request.
/*
VolumeGetResp can also be filtered based on query parameters
sent along with volume list/info api.
Query Parameters can be either metadata key/value/both key and value.
Example of API request
        - GET http://localhost:24007/v1/volumes?key={keyname}&value={value}
        - GET http://localhost:24007/v1/volumes?key={keyname}
        - GET http://localhost:24007/v1/volumes?value={value}
Note - Cannot use query parameters if volname is also supplied.
*/
type VolumeGetResp VolumeInfo

// ReplaceBrickResp represents replace brick response
type ReplaceBrickResp VolumeInfo

// VolumeExpandResp is the response sent for a volume expand request.
type VolumeExpandResp VolumeInfo

// VolumeStartResp is the response sent for a volume start request.
type VolumeStartResp VolumeInfo

// VolumeStopResp is the response sent for a volume stop request.
type VolumeStopResp VolumeInfo

// VolumeOptionResp is the response sent for a volume option request.
type VolumeOptionResp VolumeInfo

// VolumeListResp is the response sent for a volume list request.
/*VolumeListResp can also be filtered based on query parameters
sent along with volume list/info api.
Query Parameters can be either metadata key/value/both key and value.
Example of API request
        - GET http://localhost:24007/v1/volumes?key={keyname}&value={value}
        - GET http://localhost:24007/v1/volumes?key={keyname}
        - GET http://localhost:24007/v1/volumes?value={value}
Note - Cannot use query parameters if volname is also supplied.
*/
type VolumeListResp []VolumeGetResp

// OptionGroupListResp is the response sent for a group list request.
type OptionGroupListResp []OptionGroup

// VolumeEditResp is the response sent for a edit volume request
type VolumeEditResp VolumeInfo

// VolumeOptionsGetResp is the response sent for a volume get request for all options
type VolumeOptionsGetResp []VolumeOptionGetResp