system

package
v3.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 16, 2021 License: Apache-2.0 Imports: 13 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DiskUsage

func DiskUsage(ctx context.Context, options *DiskOptions) (*entities.SystemDfReport, error)

DiskUsage returns information about image, container, and volume disk consumption

func Events

func Events(ctx context.Context, eventChan chan entities.Event, cancelChan chan bool, options *EventsOptions) error

Events allows you to monitor libdpod related events like container creation and removal. The events are then passed to the eventChan provided. The optional cancelChan can be used to cancel the read of events and close down the HTTP connection.

func Info

func Info(ctx context.Context, options *InfoOptions) (*define.Info, error)

Info returns information about the libpod environment and its stores

func Prune

Prune removes all unused system data.

func Version

Types

type DiskOptions

type DiskOptions struct {
}

DiskOptions are optional options for getting storage consumption

func (*DiskOptions) Changed

func (o *DiskOptions) Changed(fieldName string) bool

Changed

func (*DiskOptions) ToParams

func (o *DiskOptions) ToParams() (url.Values, error)

ToParams

type EventsOptions

type EventsOptions struct {
	Filters map[string][]string
	Since   *string
	Stream  *bool
	Until   *string
}

EventsOptions are optional options for monitoring events

func (*EventsOptions) Changed

func (o *EventsOptions) Changed(fieldName string) bool

Changed

func (*EventsOptions) GetFilters

func (o *EventsOptions) GetFilters() map[string][]string

GetFilters

func (*EventsOptions) GetSince

func (o *EventsOptions) GetSince() string

GetSince

func (*EventsOptions) GetStream

func (o *EventsOptions) GetStream() bool

GetStream

func (*EventsOptions) GetUntil

func (o *EventsOptions) GetUntil() string

GetUntil

func (*EventsOptions) ToParams

func (o *EventsOptions) ToParams() (url.Values, error)

ToParams

func (*EventsOptions) WithFilters

func (o *EventsOptions) WithFilters(value map[string][]string) *EventsOptions

WithFilters

func (*EventsOptions) WithSince

func (o *EventsOptions) WithSince(value string) *EventsOptions

WithSince

func (*EventsOptions) WithStream

func (o *EventsOptions) WithStream(value bool) *EventsOptions

WithStream

func (*EventsOptions) WithUntil

func (o *EventsOptions) WithUntil(value string) *EventsOptions

WithUntil

type InfoOptions

type InfoOptions struct {
}

InfoOptions are optional options for getting info about libpod

func (*InfoOptions) Changed

func (o *InfoOptions) Changed(fieldName string) bool

Changed

func (*InfoOptions) ToParams

func (o *InfoOptions) ToParams() (url.Values, error)

ToParams

type PruneOptions

type PruneOptions struct {
	All     *bool
	Filters map[string][]string
	Volumes *bool
}

PruneOptions are optional options for pruning

func (*PruneOptions) Changed

func (o *PruneOptions) Changed(fieldName string) bool

Changed

func (*PruneOptions) GetAll

func (o *PruneOptions) GetAll() bool

GetAll

func (*PruneOptions) GetFilters

func (o *PruneOptions) GetFilters() map[string][]string

GetFilters

func (*PruneOptions) GetVolumes

func (o *PruneOptions) GetVolumes() bool

GetVolumes

func (*PruneOptions) ToParams

func (o *PruneOptions) ToParams() (url.Values, error)

ToParams

func (*PruneOptions) WithAll

func (o *PruneOptions) WithAll(value bool) *PruneOptions

WithAll

func (*PruneOptions) WithFilters

func (o *PruneOptions) WithFilters(value map[string][]string) *PruneOptions

WithFilters

func (*PruneOptions) WithVolumes

func (o *PruneOptions) WithVolumes(value bool) *PruneOptions

WithVolumes

type VersionOptions

type VersionOptions struct {
}

VersionOptions are optional options for getting version info

func (*VersionOptions) Changed

func (o *VersionOptions) Changed(fieldName string) bool

Changed

func (*VersionOptions) ToParams

func (o *VersionOptions) ToParams() (url.Values, error)

ToParams

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL