system

package
v5.2.1 Latest Latest
Warning

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

 Go to latest Published: Aug 14, 2024 License: Apache-2.0 Imports: 13 Imported by: 1

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.

Code generated by go generate; DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Check added in v5.2.0 

func Check(ctx context.Context, options *CheckOptions) (*types.SystemCheckReport, error)

func DiskUsage 

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

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

func Events 

func Events(ctx context.Context, eventChan chan types.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) (*types.SystemPruneReport, error)

Prune removes all unused system data.

func Version 

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

Types

type CheckOptions added in v5.2.0 

type CheckOptions struct {
	Quick                       *bool   `schema:"quick"`
	Repair                      *bool   `schema:"repair"`
	RepairLossy                 *bool   `schema:"repair_lossy"`
	UnreferencedLayerMaximumAge *string `schema:"unreferenced_layer_max_age"`
}

CheckOptions are optional options for storage consistency check/repair

func (*CheckOptions) Changed added in v5.2.0 

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

Changed returns true if named field has been set

func (*CheckOptions) GetQuick added in v5.2.0 

func (o *CheckOptions) GetQuick() bool

GetQuick returns value of field Quick

func (*CheckOptions) GetRepair added in v5.2.0 

func (o *CheckOptions) GetRepair() bool

GetRepair returns value of field Repair

func (*CheckOptions) GetRepairLossy added in v5.2.0 

func (o *CheckOptions) GetRepairLossy() bool

GetRepairLossy returns value of field RepairLossy

func (*CheckOptions) GetUnreferencedLayerMaximumAge added in v5.2.0 

func (o *CheckOptions) GetUnreferencedLayerMaximumAge() string

GetUnreferencedLayerMaximumAge returns value of field UnreferencedLayerMaximumAge

func (*CheckOptions) ToParams added in v5.2.0 

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

ToParams formats struct fields to be passed to API service

func (*CheckOptions) WithQuick added in v5.2.0 

func (o *CheckOptions) WithQuick(value bool) *CheckOptions

WithQuick set field Quick to given value

func (*CheckOptions) WithRepair added in v5.2.0 

func (o *CheckOptions) WithRepair(value bool) *CheckOptions

WithRepair set field Repair to given value

func (*CheckOptions) WithRepairLossy added in v5.2.0 

func (o *CheckOptions) WithRepairLossy(value bool) *CheckOptions

WithRepairLossy set field RepairLossy to given value

func (*CheckOptions) WithUnreferencedLayerMaximumAge added in v5.2.0 

func (o *CheckOptions) WithUnreferencedLayerMaximumAge(value string) *CheckOptions

WithUnreferencedLayerMaximumAge set field UnreferencedLayerMaximumAge to given value

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.