admin

Documentation

Index

• Variables
• type Client
  • func New(endpoint string, client *http.Client) (*Client, error)
  • func (c *Client) ServerStats(ctx context.Context) (Stats, error)
  • func (c *Client) StartVacuum(ctx context.Context) (string, error)
  • func (c *Client) VacuumStatus(ctx context.Context, id string) (Vacuum, error)
• type Stats
• type Vacuum

Variables

var ErrVacuumInProgress = errors.New("vacuum in progress")

ErrVacuumInProgress is returned when a vacuum is already in progress on the server.

Types

type Client

type Client struct {
	pb.JotFS
}

Client performs admin tasks on a JotFS server.

func New

func New(endpoint string, client *http.Client) (*Client, error)

New returns a new admin client.

func (*Client) ServerStats

func (c *Client) ServerStats(ctx context.Context) (Stats, error)

ServerStats returns summary statistics for the server.

func (*Client) StartVacuum

func (c *Client) StartVacuum(ctx context.Context) (string, error)

StartVacuum manually initiates a vacuum on the server. It returns immediately. Returns ErrVacuumInProgress if a vacuum is currently running on the server.

func (*Client) VacuumStatus

func (c *Client) VacuumStatus(ctx context.Context, id string) (Vacuum, error)

VacuumStatus returns the status of a given vacuum.

type Stats

type Stats struct {
	NumFiles        uint64
	NumFileVersions uint64
	TotalFilesSize  uint64
	TotalDataSize   uint64
}

Stats stores the summary statistics of the server.

type Vacuum

type Vacuum struct {
	Status      string
	StartedAt   time.Time
	CompletedAt time.Time
}

Vacuum is returned by VacuumStatus.