system

Documentation

Overview

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Index

• func DiskUsage(ctx context.Context, options *DiskOptions) (*entities.SystemDfReport, error)
• func Events(ctx context.Context, eventChan chan entities.Event, cancelChan chan bool, ...) error
• func Info(ctx context.Context, _ *InfoOptions) (*define.Info, error)
• func Prune(ctx context.Context, options *PruneOptions) (*entities.SystemPruneReport, error)
• func Version(ctx context.Context, options *VersionOptions) (*entities.SystemVersionReport, error)
• type DiskOptions
  • func (o *DiskOptions) Changed(fieldName string) bool
  • func (o *DiskOptions) ToParams() (url.Values, error)
• type EventsOptions
  • func (o *EventsOptions) Changed(fieldName string) bool
  • func (o *EventsOptions) GetFilters() map[string][]string
  • func (o *EventsOptions) GetSince() string
  • func (o *EventsOptions) GetStream() bool
  • func (o *EventsOptions) GetUntil() string
  • func (o *EventsOptions) ToParams() (url.Values, error)
  • func (o *EventsOptions) WithFilters(value map[string][]string) *EventsOptions
  • func (o *EventsOptions) WithSince(value string) *EventsOptions
  • func (o *EventsOptions) WithStream(value bool) *EventsOptions
  • func (o *EventsOptions) WithUntil(value string) *EventsOptions
• type InfoOptions
  • func (o *InfoOptions) Changed(fieldName string) bool
  • func (o *InfoOptions) ToParams() (url.Values, error)
• type PruneOptions
  • func (o *PruneOptions) Changed(fieldName string) bool
  • func (o *PruneOptions) GetAll() bool
  • func (o *PruneOptions) GetExternal() bool
  • func (o *PruneOptions) GetFilters() map[string][]string
  • func (o *PruneOptions) GetVolumes() bool
  • func (o *PruneOptions) ToParams() (url.Values, error)
  • func (o *PruneOptions) WithAll(value bool) *PruneOptions
  • func (o *PruneOptions) WithExternal(value bool) *PruneOptions
  • func (o *PruneOptions) WithFilters(value map[string][]string) *PruneOptions
  • func (o *PruneOptions) WithVolumes(value bool) *PruneOptions
• type VersionOptions
  • func (o *VersionOptions) Changed(fieldName string) bool
  • func (o *VersionOptions) ToParams() (url.Values, error)

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, _ *InfoOptions) (*define.Info, error)

Info returns information about the libpod environment and its stores

func Prune

func Prune(ctx context.Context, options *PruneOptions) (*entities.SystemPruneReport, error)

Prune removes all unused system data.

func Version

func Version(ctx context.Context, options *VersionOptions) (*entities.SystemVersionReport, error)

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 returns true if named field has been set

func (*DiskOptions) ToParams

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

ToParams formats struct fields to be passed to API service

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 returns true if named field has been set

func (*EventsOptions) GetFilters

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

GetFilters returns value of field Filters

func (*EventsOptions) GetSince

func (o *EventsOptions) GetSince() string

GetSince returns value of field Since

func (*EventsOptions) GetStream

func (o *EventsOptions) GetStream() bool

GetStream returns value of field Stream

func (*EventsOptions) GetUntil

func (o *EventsOptions) GetUntil() string

GetUntil returns value of field Until

func (*EventsOptions) ToParams

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

ToParams formats struct fields to be passed to API service

func (*EventsOptions) WithFilters

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

WithFilters set field Filters to given value

func (*EventsOptions) WithSince

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

WithSince set field Since to given value

func (*EventsOptions) WithStream

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

WithStream set field Stream to given value

func (*EventsOptions) WithUntil

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

WithUntil set field Until to given value

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 returns true if named field has been set

func (*InfoOptions) ToParams

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

ToParams formats struct fields to be passed to API service

type PruneOptions

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

PruneOptions are optional options for pruning

func (*PruneOptions) Changed

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

Changed returns true if named field has been set

func (*PruneOptions) GetAll

func (o *PruneOptions) GetAll() bool

GetAll returns value of field All

func (*PruneOptions) GetExternal

func (o *PruneOptions) GetExternal() bool

GetExternal returns value of field External

func (*PruneOptions) GetFilters

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

GetFilters returns value of field Filters

func (*PruneOptions) GetVolumes

func (o *PruneOptions) GetVolumes() bool

GetVolumes returns value of field Volumes

func (*PruneOptions) ToParams

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

ToParams formats struct fields to be passed to API service

func (*PruneOptions) WithAll

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

WithAll set field All to given value

func (*PruneOptions) WithExternal

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

WithExternal set field External to given value

func (*PruneOptions) WithFilters

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

WithFilters set field Filters to given value

func (*PruneOptions) WithVolumes

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

WithVolumes set field Volumes to given value

type VersionOptions

type VersionOptions struct {
}

VersionOptions are optional options for getting version info

func (*VersionOptions) Changed

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

Changed returns true if named field has been set

func (*VersionOptions) ToParams

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

ToParams formats struct fields to be passed to API service