Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

images

package

Go to main page

Versions in this module

v5

v5.1.0-rc1

May 15, 2024

v5.0.3

May 10, 2024

v5.0.2

Apr 17, 2024

v5.0.1

Apr 1, 2024

v5.0.0

Mar 19, 2024

Changes in this version

+ func Build(ctx context.Context, containerFiles []string, options types.BuildOptions) (*types.BuildReport, error)

+ func Diff(ctx context.Context, nameOrID string, options *DiffOptions) ([]archive.Change, error)

+ func Exists(ctx context.Context, nameOrID string, options *ExistsOptions) (bool, error)

+ func Export(ctx context.Context, nameOrIDs []string, w io.Writer, options *ExportOptions) error

+ func GetImage(ctx context.Context, nameOrID string, options *GetOptions) (*types.ImageInspectReport, error)

+ func History(ctx context.Context, nameOrID string, options *HistoryOptions) ([]*handlersTypes.HistoryResponse, error)

+ func Import(ctx context.Context, r io.Reader, options *ImportOptions) (*types.ImageImportReport, error)

+ func List(ctx context.Context, options *ListOptions) ([]*types.ImageSummary, error)

+ func Load(ctx context.Context, r io.Reader) (*types.ImageLoadReport, error)

+ func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error)

+ func Pull(ctx context.Context, rawImage string, options *PullOptions) ([]string, error)

+ func Push(ctx context.Context, source string, destination string, options *PushOptions) error

+ func Remove(ctx context.Context, images []string, options *RemoveOptions) (*types.ImageRemoveReport, []error)

+ func Scp(ctx context.Context, source, destination *string, options ScpOptions) (reports.ScpReport, error)

+ func Search(ctx context.Context, term string, options *SearchOptions) ([]types.ImageSearchReport, error)

+ func Tag(ctx context.Context, nameOrID, tag, repo string, options *TagOptions) error

+ func Tree(ctx context.Context, nameOrID string, options *TreeOptions) (*types.ImageTreeReport, error)

+ func Untag(ctx context.Context, nameOrID, tag, repo string, options *UntagOptions) error

+ type BuildOptions = types.BuildOptions

+ type BuildResponse struct

+ Aux json.RawMessage

+ Error *jsonmessage.JSONError

+ ErrorMessage string

+ Stream string

+ type DiffOptions struct

+ DiffType *string

+ Parent *string

+ func (o *DiffOptions) Changed(fieldName string) bool

+ func (o *DiffOptions) GetDiffType() string

+ func (o *DiffOptions) GetParent() string

+ func (o *DiffOptions) ToParams() (url.Values, error)

+ func (o *DiffOptions) WithDiffType(value string) *DiffOptions

+ func (o *DiffOptions) WithParent(value string) *DiffOptions

+ type ExistsOptions struct

+ func (o *ExistsOptions) Changed(fieldName string) bool

+ func (o *ExistsOptions) ToParams() (url.Values, error)

+ type ExportOptions struct

+ Compress *bool

+ Format *string

+ OciAcceptUncompressedLayers *bool

+ func (o *ExportOptions) Changed(fieldName string) bool

+ func (o *ExportOptions) GetCompress() bool

+ func (o *ExportOptions) GetFormat() string

+ func (o *ExportOptions) GetOciAcceptUncompressedLayers() bool

+ func (o *ExportOptions) ToParams() (url.Values, error)

+ func (o *ExportOptions) WithCompress(value bool) *ExportOptions

+ func (o *ExportOptions) WithFormat(value string) *ExportOptions

+ func (o *ExportOptions) WithOciAcceptUncompressedLayers(value bool) *ExportOptions

+ type GetOptions struct

+ Size *bool

+ func (o *GetOptions) Changed(fieldName string) bool

+ func (o *GetOptions) GetSize() bool

+ func (o *GetOptions) ToParams() (url.Values, error)

+ func (o *GetOptions) WithSize(value bool) *GetOptions

+ type HistoryOptions struct

+ func (o *HistoryOptions) Changed(fieldName string) bool

+ func (o *HistoryOptions) ToParams() (url.Values, error)

+ type ImportOptions struct

+ Architecture *string

+ Changes *[]string

+ Message *string

+ OS *string

+ Reference *string

+ URL *string

+ Variant *string

+ func (o *ImportOptions) Changed(fieldName string) bool

+ func (o *ImportOptions) GetArchitecture() string

+ func (o *ImportOptions) GetChanges() []string

+ func (o *ImportOptions) GetMessage() string

+ func (o *ImportOptions) GetOS() string

+ func (o *ImportOptions) GetReference() string

+ func (o *ImportOptions) GetURL() string

+ func (o *ImportOptions) GetVariant() string

+ func (o *ImportOptions) ToParams() (url.Values, error)

+ func (o *ImportOptions) WithArchitecture(value string) *ImportOptions

+ func (o *ImportOptions) WithChanges(value []string) *ImportOptions

+ func (o *ImportOptions) WithMessage(value string) *ImportOptions

+ func (o *ImportOptions) WithOS(value string) *ImportOptions

+ func (o *ImportOptions) WithReference(value string) *ImportOptions

+ func (o *ImportOptions) WithURL(value string) *ImportOptions

+ func (o *ImportOptions) WithVariant(value string) *ImportOptions

+ type ListOptions struct

+ All *bool

+ Filters map[string][]string

+ func (o *ListOptions) Changed(fieldName string) bool

+ func (o *ListOptions) GetAll() bool

+ func (o *ListOptions) GetFilters() map[string][]string

+ func (o *ListOptions) ToParams() (url.Values, error)

+ func (o *ListOptions) WithAll(value bool) *ListOptions

+ func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions

+ type LoadOptions struct

+ Reference *string

+ func (o *LoadOptions) Changed(fieldName string) bool

+ func (o *LoadOptions) GetReference() string

+ func (o *LoadOptions) ToParams() (url.Values, error)

+ func (o *LoadOptions) WithReference(value string) *LoadOptions

+ type PruneOptions struct

+ All *bool

+ External *bool

+ Filters map[string][]string

+ 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) 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

+ type PullOptions struct

+ AllTags *bool

+ Arch *string

+ Authfile *string

+ OS *string

+ Password *string

+ Policy *string

+ ProgressWriter *io.Writer

+ Quiet *bool

+ Retry *uint

+ RetryDelay *string

+ SkipTLSVerify *bool

+ Username *string

+ Variant *string

+ func (o *PullOptions) Changed(fieldName string) bool

+ func (o *PullOptions) GetAllTags() bool

+ func (o *PullOptions) GetArch() string

+ func (o *PullOptions) GetAuthfile() string

+ func (o *PullOptions) GetOS() string

+ func (o *PullOptions) GetPassword() string

+ func (o *PullOptions) GetPolicy() string

+ func (o *PullOptions) GetProgressWriter() io.Writer

+ func (o *PullOptions) GetQuiet() bool

+ func (o *PullOptions) GetRetry() uint

+ func (o *PullOptions) GetRetryDelay() string

+ func (o *PullOptions) GetSkipTLSVerify() bool

+ func (o *PullOptions) GetUsername() string

+ func (o *PullOptions) GetVariant() string

+ func (o *PullOptions) ToParams() (url.Values, error)

+ func (o *PullOptions) WithAllTags(value bool) *PullOptions

+ func (o *PullOptions) WithArch(value string) *PullOptions

+ func (o *PullOptions) WithAuthfile(value string) *PullOptions

+ func (o *PullOptions) WithOS(value string) *PullOptions

+ func (o *PullOptions) WithPassword(value string) *PullOptions

+ func (o *PullOptions) WithPolicy(value string) *PullOptions

+ func (o *PullOptions) WithProgressWriter(value io.Writer) *PullOptions

+ func (o *PullOptions) WithQuiet(value bool) *PullOptions

+ func (o *PullOptions) WithRetry(value uint) *PullOptions

+ func (o *PullOptions) WithRetryDelay(value string) *PullOptions

+ func (o *PullOptions) WithSkipTLSVerify(value bool) *PullOptions

+ func (o *PullOptions) WithUsername(value string) *PullOptions

+ func (o *PullOptions) WithVariant(value string) *PullOptions

+ type PushOptions struct

+ AddCompression []string

+ All *bool

+ Authfile *string

+ Compress *bool

+ CompressionFormat *string

+ CompressionLevel *int

+ ForceCompressionFormat *bool

+ Format *string

+ ManifestDigest *string

+ Password *string

+ ProgressWriter *io.Writer

+ Quiet *bool

+ RemoveSignatures *bool

+ Retry *uint

+ RetryDelay *string

+ SkipTLSVerify *bool

+ Username *string

+ func (o *PushOptions) Changed(fieldName string) bool

+ func (o *PushOptions) GetAddCompression() []string

+ func (o *PushOptions) GetAll() bool

+ func (o *PushOptions) GetAuthfile() string

+ func (o *PushOptions) GetCompress() bool

+ func (o *PushOptions) GetCompressionFormat() string

+ func (o *PushOptions) GetCompressionLevel() int

+ func (o *PushOptions) GetForceCompressionFormat() bool

+ func (o *PushOptions) GetFormat() string

+ func (o *PushOptions) GetManifestDigest() string

+ func (o *PushOptions) GetPassword() string

+ func (o *PushOptions) GetProgressWriter() io.Writer

+ func (o *PushOptions) GetQuiet() bool

+ func (o *PushOptions) GetRemoveSignatures() bool

+ func (o *PushOptions) GetRetry() uint

+ func (o *PushOptions) GetRetryDelay() string

+ func (o *PushOptions) GetSkipTLSVerify() bool

+ func (o *PushOptions) GetUsername() string

+ func (o *PushOptions) ToParams() (url.Values, error)

+ func (o *PushOptions) WithAddCompression(value []string) *PushOptions

+ func (o *PushOptions) WithAll(value bool) *PushOptions

+ func (o *PushOptions) WithAuthfile(value string) *PushOptions

+ func (o *PushOptions) WithCompress(value bool) *PushOptions

+ func (o *PushOptions) WithCompressionFormat(value string) *PushOptions

+ func (o *PushOptions) WithCompressionLevel(value int) *PushOptions

+ func (o *PushOptions) WithForceCompressionFormat(value bool) *PushOptions

+ func (o *PushOptions) WithFormat(value string) *PushOptions

+ func (o *PushOptions) WithManifestDigest(value string) *PushOptions

+ func (o *PushOptions) WithPassword(value string) *PushOptions

+ func (o *PushOptions) WithProgressWriter(value io.Writer) *PushOptions

+ func (o *PushOptions) WithQuiet(value bool) *PushOptions

+ func (o *PushOptions) WithRemoveSignatures(value bool) *PushOptions

+ func (o *PushOptions) WithRetry(value uint) *PushOptions

+ func (o *PushOptions) WithRetryDelay(value string) *PushOptions

+ func (o *PushOptions) WithSkipTLSVerify(value bool) *PushOptions

+ func (o *PushOptions) WithUsername(value string) *PushOptions

+ type RemoveOptions struct

+ All *bool

+ Force *bool

+ Ignore *bool

+ LookupManifest *bool

+ NoPrune *bool

+ func (o *RemoveOptions) Changed(fieldName string) bool

+ func (o *RemoveOptions) GetAll() bool

+ func (o *RemoveOptions) GetForce() bool

+ func (o *RemoveOptions) GetIgnore() bool

+ func (o *RemoveOptions) GetLookupManifest() bool

+ func (o *RemoveOptions) GetNoPrune() bool

+ func (o *RemoveOptions) ToParams() (url.Values, error)

+ func (o *RemoveOptions) WithAll(value bool) *RemoveOptions

+ func (o *RemoveOptions) WithForce(value bool) *RemoveOptions

+ func (o *RemoveOptions) WithIgnore(value bool) *RemoveOptions

+ func (o *RemoveOptions) WithLookupManifest(value bool) *RemoveOptions

+ func (o *RemoveOptions) WithNoPrune(value bool) *RemoveOptions

+ type ScpOptions struct

+ Destination *string

+ Quiet *bool

+ func (o *ScpOptions) ToParams() (url.Values, error)

+ type SearchOptions struct

+ Authfile *string

+ Filters map[string][]string

+ Limit *int

+ ListTags *bool

+ Password *string

+ SkipTLSVerify *bool

+ Username *string

+ func (o *SearchOptions) Changed(fieldName string) bool

+ func (o *SearchOptions) GetAuthfile() string

+ func (o *SearchOptions) GetFilters() map[string][]string

+ func (o *SearchOptions) GetLimit() int

+ func (o *SearchOptions) GetListTags() bool

+ func (o *SearchOptions) GetPassword() string

+ func (o *SearchOptions) GetSkipTLSVerify() bool

+ func (o *SearchOptions) GetUsername() string

+ func (o *SearchOptions) ToParams() (url.Values, error)

+ func (o *SearchOptions) WithAuthfile(value string) *SearchOptions

+ func (o *SearchOptions) WithFilters(value map[string][]string) *SearchOptions

+ func (o *SearchOptions) WithLimit(value int) *SearchOptions

+ func (o *SearchOptions) WithListTags(value bool) *SearchOptions

+ func (o *SearchOptions) WithPassword(value string) *SearchOptions

+ func (o *SearchOptions) WithSkipTLSVerify(value bool) *SearchOptions

+ func (o *SearchOptions) WithUsername(value string) *SearchOptions

+ type TagOptions struct

+ func (o *TagOptions) Changed(fieldName string) bool

+ func (o *TagOptions) ToParams() (url.Values, error)

+ type TreeOptions struct

+ WhatRequires *bool

+ func (o *TreeOptions) Changed(fieldName string) bool

+ func (o *TreeOptions) GetWhatRequires() bool

+ func (o *TreeOptions) ToParams() (url.Values, error)

+ func (o *TreeOptions) WithWhatRequires(value bool) *TreeOptions

+ type UntagOptions struct

+ func (o *UntagOptions) Changed(fieldName string) bool

+ func (o *UntagOptions) ToParams() (url.Values, error)

v5.0.0-rc7

Mar 14, 2024

v5.0.0-rc6

Mar 11, 2024

v5.0.0-rc5

Mar 7, 2024

v5.0.0-rc4

Mar 1, 2024

v5.0.0-rc3

Feb 22, 2024

v5.0.0-rc2

Feb 16, 2024

v5.0.0-rc1

Feb 8, 2024

Other modules containing this package

github.com/containers/podman/v2

github.com/containers/podman/v3

github.com/containers/podman/v4